CreateAgent - AWS DataSync

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

CreateAgent

스토리지 환경에 배포한 AWS DataSync 에이전트를 활성화합니다. 활성화 프로세스는 에이전트를 사용자 AWS 계정 에이전트에 연결합니다.

아직 에이전트를 배포하지 않았다면 다음 주제를 참조하여 자세히 알아보세요.

참고

AWS스토리지 서비스 간에 전송하는 경우 DataSync 에이전트가 필요하지 않습니다.

요청 구문

{ "ActivationKey": "string", "AgentName": "string", "SecurityGroupArns": [ "string" ], "SubnetArns": [ "string" ], "Tags": [ { "Key": "string", "Value": "string" } ], "VpcEndpointId": "string" }

요청 파라미터

모든 작업에 공통되는 파라미터에 대한 자세한 내용은 일반 파라미터를 참조하십시오.

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

ActivationKey

DataSync상담원의 활성화 키를 지정합니다. 활성화 키가 없는 경우 상담원 활성화를 참조하세요.

유형: String

길이 제약: 최대 길이는 29입니다.

패턴: [A-Z0-9]{5}(-[A-Z0-9]{5}){4}

필수 항목 여부: 예

AgentName

에이전트의 이름을 지정합니다. DataSync콘솔에서 이 이름을 볼 수 있습니다.

유형: String

길이 제약: 최소 길이는 1입니다. 최대 길이 256.

Pattern: ^[a-zA-Z0-9\s+=._:@/-]+$

필수 항목 여부: 아니요

SecurityGroupArns

가상 사설 클라우드 (VPC) 엔드포인트를 사용할 때 작업의 네트워크 인터페이스를 보호하는 보안 그룹의 Amazon 리소스 이름 (ARN) 을 지정합니다.

유형: 문자열 배열

배열 멤버: 고정된 항목 수는 1개입니다.

길이 제약: 최대 길이는 128입니다.

패턴: ^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):ec2:[a-z\-0-9]*:[0-9]{12}:security-group/sg-[a-f0-9]+$

필수 항목 여부: 아니요

SubnetArns

VPC 엔드포인트를 사용할 때 DataSync 작업을 실행할 서브넷의 ARN을 지정합니다. 전송을 위한 네트워크 인터페이스를 DataSync 만들고 관리하는 서브넷입니다.

유형: 문자열 배열

배열 멤버: 고정된 항목 수는 1개입니다.

길이 제약: 최대 길이는 128입니다.

패턴: ^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):ec2:[a-z\-0-9]*:[0-9]{12}:subnet/.*$

필수 항목 여부: 아니요

Tags

AWS 리소스를 분류, 필터링 및 검색하는 데 도움이 되는 레이블을 지정합니다. 에이전트에 대한 태그를 하나 이상 생성하는 것이 좋습니다.

유형: TagListEntry 객체 배열

배열 멤버: 최소 항목 수는 0개입니다. 최대 항목 수 50개.

필수 항목 여부: 아니요

VpcEndpointId

에이전트를 연결할 VPC 엔드포인트의 ID를 지정합니다. VPC 엔드포인트 ID는 다음과 같습니다. vpce-01234d5aff67890e1

중요

사용하는 VPC 엔드포인트에는 DataSync 서비스 이름 (예:) 이 포함되어야 합니다. com.amazonaws.us-east-2.datasync

유형: String

패턴: ^vpce-[0-9a-f]{17}$

필수 항목 여부: 아니요

응답 구문

{ "AgentArn": "string" }

응답 요소

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

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

AgentArn

방금 활성화한 에이전트의 ARN입니다. ListAgents작업을 사용하면 밴드에 있는 상담원 목록을 반환할 수 AWS 계정 있습니다AWS 리전.

유형: String

길이 제약: 최대 길이는 128입니다.

패턴: ^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):datasync:[a-z\-0-9]+:[0-9]{12}:agent/agent-[0-9a-z]{17}$

오류

모든 작업에 공통적으로 나타나는 오류에 대한 자세한 내용은 을 참조하십시오일반적인 오류.

InternalException

이 예외는 AWS DataSync 서비스에 오류가 발생할 때 발생합니다.

HTTP 상태 코드: 500

InvalidRequestException

클라이언트가 잘못된 형식의 요청을 제출하면 이 예외가 발생합니다.

HTTP 상태 코드: 400

예시

예제 요청

다음 예에서는 에이전트를 활성화하고 해당 DataSync 에이전트를 귀하의 에이전트와 연결합니다. AWS 계정

{ "ActivationKey": "AAAAA-1AAAA-BB1CC-33333-EEEEE", "AgentName": "MyAgent", "Tags": [{ "Key": "Job", "Value": "TransferJob-1" }] }

샘플 응답

응답은 활성화된 에이전트의 ARN을 반환합니다.

{ "AgentArn": "arn:aws:datasync:us-east-2:111222333444:agent/agent-0b0addbeef44baca3" }

참고 항목

이 API를 언어별 AWS SDK 중 하나로 사용하는 방법에 대한 자세한 내용은 다음을 참조하세요.