Terjemahan disediakan oleh mesin penerjemah. Jika konten terjemahan yang diberikan bertentangan dengan versi bahasa Inggris aslinya, utamakan versi bahasa Inggris.

# DescribeAgent
<a name="API_DescribeAgent"></a>

Mengembalikan informasi tentang AWS DataSync agen, seperti namanya, jenis titik akhir layanan, dan status.

## Sintaksis Permintaan
<a name="API_DescribeAgent_RequestSyntax"></a>

```
{
   "AgentArn": "string"
}
```

## Parameter Permintaan
<a name="API_DescribeAgent_RequestParameters"></a>

Untuk informasi tentang parameter yang umum untuk semua tindakan, lihat [Parameter Umum](CommonParameters.md).

Permintaan menerima data berikut dalam format JSON.

 ** [AgentArn](#API_DescribeAgent_RequestSyntax) **   <a name="DataSync-DescribeAgent-request-AgentArn"></a>
Menentukan Nama Sumber Daya Amazon (ARN) dari agen DataSync yang Anda inginkan informasi tentang.  
Tipe: String  
Batasan Panjang: Panjang maksimum 128.  
Pola: `^arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):datasync:[a-z\-0-9]+:[0-9]{12}:agent/agent-[0-9a-z]{17}$`   
Diperlukan: Ya

## Sintaksis Respons
<a name="API_DescribeAgent_ResponseSyntax"></a>

```
{
   "AgentArn": "string",
   "CreationTime": number,
   "EndpointType": "string",
   "LastConnectionTime": number,
   "Name": "string",
   "Platform": { 
      "Version": "string"
   },
   "PrivateLinkConfig": { 
      "PrivateLinkEndpoint": "string",
      "SecurityGroupArns": [ "string" ],
      "SubnetArns": [ "string" ],
      "VpcEndpointId": "string"
   },
   "Status": "string"
}
```

## Elemen Respons
<a name="API_DescribeAgent_ResponseElements"></a>

Jika tindakan berhasil, layanan mengirimkan kembali respons HTTP 200.

Layanan mengembalikan data berikut dalam format JSON.

 ** [AgentArn](#API_DescribeAgent_ResponseSyntax) **   <a name="DataSync-DescribeAgent-response-AgentArn"></a>
ARN dari agen.  
Tipe: String  
Batasan Panjang: Panjang maksimum 128.  
Pola: `^arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):datasync:[a-z\-0-9]+:[0-9]{12}:agent/agent-[0-9a-z]{17}$` 

 ** [CreationTime](#API_DescribeAgent_ResponseSyntax) **   <a name="DataSync-DescribeAgent-response-CreationTime"></a>
Waktu agen [diaktifkan](https://docs.aws.amazon.com/datasync/latest/userguide/activate-agent.html).  
Tipe: Timestamp

 ** [EndpointType](#API_DescribeAgent_ResponseSyntax) **   <a name="DataSync-DescribeAgent-response-EndpointType"></a>
Jenis [titik akhir layanan](https://docs.aws.amazon.com/datasync/latest/userguide/choose-service-endpoint.html) yang terhubung dengan agen Anda.  
Tipe: String  
Nilai yang Valid: `PUBLIC | PRIVATE_LINK | FIPS | FIPS_PRIVATE_LINK` 

 ** [LastConnectionTime](#API_DescribeAgent_ResponseSyntax) **   <a name="DataSync-DescribeAgent-response-LastConnectionTime"></a>
Terakhir kali agen berkomunikasi dengan DataSync layanan.  
Tipe: Timestamp

 ** [Name](#API_DescribeAgent_ResponseSyntax) **   <a name="DataSync-DescribeAgent-response-Name"></a>
Nama Agen.  
Tipe: String  
Batasan Panjang: Panjang minimum 0. Panjang maksimum 256.  
Pola: `^[a-zA-Z0-9\s+=._:@/-]+$` 

 ** [Platform](#API_DescribeAgent_ResponseSyntax) **   <a name="DataSync-DescribeAgent-response-Platform"></a>
Detail terkait platform tentang agen, seperti nomor versi.  
Tipe: Objek [Platform](API_Platform.md)

 ** [PrivateLinkConfig](#API_DescribeAgent_ResponseSyntax) **   <a name="DataSync-DescribeAgent-response-PrivateLinkConfig"></a>
Konfigurasi jaringan yang digunakan agen saat menghubungkan ke titik akhir [layanan VPC](https://docs.aws.amazon.com/datasync/latest/userguide/choose-service-endpoint.html#choose-service-endpoint-vpc).  
Tipe: Objek [PrivateLinkConfig](API_PrivateLinkConfig.md)

 ** [Status](#API_DescribeAgent_ResponseSyntax) **   <a name="DataSync-DescribeAgent-response-Status"></a>
Status agen.  
+ Jika statusnya`ONLINE`, agen dikonfigurasi dengan benar dan siap digunakan.
+ Jika statusnya`OFFLINE`, agen telah keluar dari kontak DataSync selama lima menit atau lebih. Ini bisa terjadi karena beberapa alasan. Untuk informasi selengkapnya, lihat [Apa yang harus saya lakukan jika agen saya offline?](https://docs.aws.amazon.com/datasync/latest/userguide/troubleshooting-datasync-agents.html#troubleshoot-agent-offline) 
Tipe: String  
Nilai yang Valid: `ONLINE | OFFLINE` 

## Kesalahan
<a name="API_DescribeAgent_Errors"></a>

Untuk informasi tentang kesalahan yang umum untuk semua tindakan, lihat [Kesalahan Umum](CommonErrors.md).

 ** InternalException **   
Pengecualian ini dilontarkan ketika terjadi kesalahan dalam layanan AWS DataSync .  
Kode Status HTTP: 500

 ** InvalidRequestException **   
Pengecualian ini dilontarkan ketika klien mengirimkan permintaan yang salah format.  
Kode Status HTTP: 400

## Contoh
<a name="API_DescribeAgent_Examples"></a>

### Permintaan Sampel
<a name="API_DescribeAgent_Example_1"></a>

Contoh berikut mengembalikan informasi tentang agen yang ditentukan dalam permintaan.

```
{
  "AgentArn": "arn:aws:datasync:us-east-2:111122223333:agent/agent-1234567890abcdef0"
}
```

### Contoh Respons
<a name="API_DescribeAgent_Example_2"></a>

Contoh respon berikut menjelaskan agen yang menggunakan endpoint layanan publik.

```
{
    "AgentArn": "arn:aws:datasync:us-east-2:111122223333:agent/agent-1234567890abcdef0",
    "Name": "Data center migration agent",
    "Status": "ONLINE",
    "LastConnectionTime": "2022-10-17T17:21:35.540000+00:00",
    "CreationTime": "2022-10-05T20:52:29.499000+00:00",
    "EndpointType": "PUBLIC",
    "Platform": {
        "Version": "2"
    }
}
```

## Lihat Juga
<a name="API_DescribeAgent_SeeAlso"></a>

Untuk informasi selengkapnya tentang penggunaan API ini di salah satu bahasa khusus AWS SDKs, lihat berikut ini:
+  [AWS Antarmuka Baris Perintah V2](https://docs.aws.amazon.com/goto/cli2/datasync-2018-11-09/DescribeAgent) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/datasync-2018-11-09/DescribeAgent) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datasync-2018-11-09/DescribeAgent) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datasync-2018-11-09/DescribeAgent) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/DescribeAgent) 
+  [AWS SDK untuk V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datasync-2018-11-09/DescribeAgent) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/datasync-2018-11-09/DescribeAgent) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datasync-2018-11-09/DescribeAgent) 
+  [AWS SDK untuk Python](https://docs.aws.amazon.com/goto/boto3/datasync-2018-11-09/DescribeAgent) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datasync-2018-11-09/DescribeAgent)