기계 번역으로 제공되는 번역입니다. 제공된 번역과 원본 영어의 내용이 상충하는 경우에는 영어 버전이 우선합니다.

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

이름, 서비스 엔드포인트 유형 및 상태와 같은 AWS DataSync 에이전트에 대한 정보를 반환합니다.

## 구문 요청
<a name="API_DescribeAgent_RequestSyntax"></a>

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

## 요청 파라미터
<a name="API_DescribeAgent_RequestParameters"></a>

모든 작업에 공통되는 파라미터에 대한 자세한 설명은 [공통 파라미터](CommonParameters.md)를 참조하세요.

요청은 JSON 형식으로 다음 데이터를 받습니다.

 ** [AgentArn](#API_DescribeAgent_RequestSyntax) **   <a name="DataSync-DescribeAgent-request-AgentArn"></a>
정보를 원하는 DataSync 에이전트의 Amazon 리소스 이름(ARN) 을 지정합니다.  
유형: 문자열  
길이 제약: 최대 길이는 128입니다.  
패턴: `^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}$`   
필수 여부: 예

## 응답 구문
<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"
}
```

## 응답 요소
<a name="API_DescribeAgent_ResponseElements"></a>

작업이 성공하면 서비스가 HTTP 200 응답을 반송합니다.

다음 데이터는 서비스에 의해 JSON 형식으로 반환됩니다.

 ** [AgentArn](#API_DescribeAgent_ResponseSyntax) **   <a name="DataSync-DescribeAgent-response-AgentArn"></a>
에이전트의 ARN입니다.  
유형: 문자열  
길이 제약: 최대 길이는 128입니다.  
패턴: `^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>
에이전트가 [활성화](https://docs.aws.amazon.com/datasync/latest/userguide/activate-agent.html)된 시간.  
유형: 타임스탬프

 ** [EndpointType](#API_DescribeAgent_ResponseSyntax) **   <a name="DataSync-DescribeAgent-response-EndpointType"></a>
사용자 에이전트가 연결된 [서비스 엔드포인트](https://docs.aws.amazon.com/datasync/latest/userguide/choose-service-endpoint.html)의 유형입니다.  
타입: 문자열  
유효 값: `PUBLIC | PRIVATE_LINK | FIPS | FIPS_PRIVATE_LINK` 

 ** [LastConnectionTime](#API_DescribeAgent_ResponseSyntax) **   <a name="DataSync-DescribeAgent-response-LastConnectionTime"></a>
에이전트가 DataSync 서비스와 마지막으로 통신한 시간입니다.  
유형: 타임스탬프

 ** [Name](#API_DescribeAgent_ResponseSyntax) **   <a name="DataSync-DescribeAgent-response-Name"></a>
에이전트의 이름입니다.  
유형: 문자열  
길이 제약: 최소 길이는 0. 최대 길이는 256입니다.  
패턴: `^[a-zA-Z0-9\s+=._:@/-]+$` 

 ** [Platform](#API_DescribeAgent_ResponseSyntax) **   <a name="DataSync-DescribeAgent-response-Platform"></a>
에이전트에 대한 플랫폼 관련 세부 정보(예: 버전 번호)  
유형: [Platform](API_Platform.md)객체

 ** [PrivateLinkConfig](#API_DescribeAgent_ResponseSyntax) **   <a name="DataSync-DescribeAgent-response-PrivateLinkConfig"></a>
에이전트가 [VPC 서비스 엔드포인트](https://docs.aws.amazon.com/datasync/latest/userguide/choose-service-endpoint.html#choose-service-endpoint-vpc)에 연결할 때 사용하는 네트워크 구성입니다.  
유형: [PrivateLinkConfig](API_PrivateLinkConfig.md)객체

 ** [Status](#API_DescribeAgent_ResponseSyntax) **   <a name="DataSync-DescribeAgent-response-Status"></a>
에이전트의 상태.  
+ 상태가 `ONLINE`이면 에이전트가 제대로 구성되어 사용할 준비가 된 것입니다.
+ 상태가 `OFFLINE`이면 에이전트가 5분 이상 동안 DataSync와 연락이 끊긴 것입니다. 몇 가지 원인이 있을 수 있습니다. 자세한 내용은 [에이전트가 오프라인 상태인 경우 어떻게 하나요?](https://docs.aws.amazon.com/datasync/latest/userguide/troubleshooting-datasync-agents.html#troubleshoot-agent-offline) 를 확인하세요.
타입: 문자열  
유효 값: `ONLINE | OFFLINE` 

## 오류
<a name="API_DescribeAgent_Errors"></a>

모든 작업에서 공통적으로 발생하는 오류에 대한 자세한 설명은 [일반적인 오류](CommonErrors.md)섹션을 참조하세요.

 ** InternalException **   
이 예외는 AWS DataSync 서비스에 오류가 발생할 때 던져집니다.  
HTTP 상태 코드: 500

 ** InvalidRequestException **   
이 예외는 클라이언트가 잘못된 형식의 요청을 제출할 때 던져집니다.  
HTTP 상태 코드: 400

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

### 예 요청
<a name="API_DescribeAgent_Example_1"></a>

다음 예는 요청에 지정된 에이전트에 대한 정보를 반환합니다.

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

### 샘플 응답
<a name="API_DescribeAgent_Example_2"></a>

다음 예제 응답은 공용 서비스 엔드포인트를 사용하는 에이전트를 설명합니다.

```
{
    "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"
    }
}
```

## 참고
<a name="API_DescribeAgent_SeeAlso"></a>

언어별 AWS SDKs
+  [AWS 명령줄 인터페이스 V2](https://docs.aws.amazon.com/goto/cli2/datasync-2018-11-09/DescribeAgent) 
+  [AWS .NET V4용 SDK](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 Go용 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datasync-2018-11-09/DescribeAgent) 
+  [AWS Java V2용 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/DescribeAgent) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datasync-2018-11-09/DescribeAgent) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/datasync-2018-11-09/DescribeAgent) 
+  [AWS PHP V3용 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/datasync-2018-11-09/DescribeAgent) 
+  [AWS Python용 SDK](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)