Terjemahan disediakan oleh mesin penerjemah. Jika konten terjemahan yang diberikan bertentangan dengan versi bahasa Inggris aslinya, utamakan versi bahasa Inggris.
CreateAgent
Mengaktifkan AWS DataSync agen yang Anda gunakan di lingkungan penyimpanan Anda. Proses aktivasi mengaitkan agen dengan Anda Akun AWS.
Jika Anda belum menggunakan agen, lihat Apakah saya memerlukan DataSync agen?
Sintaksis Permintaan
{
"ActivationKey": "string",
"AgentName": "string",
"SecurityGroupArns": [ "string" ],
"SubnetArns": [ "string" ],
"Tags": [
{
"Key": "string",
"Value": "string"
}
],
"VpcEndpointId": "string"
}Parameter Permintaan
Untuk informasi tentang parameter yang umum untuk semua tindakan, lihat Parameter Umum.
Permintaan menerima data berikut dalam JSON format.
- ActivationKey
-
Menentukan kunci aktivasi DataSync agen Anda. Jika Anda tidak memiliki kunci aktivasi, lihat Mengaktifkan agen Anda.
Tipe: String
Batasan Panjang: Panjang maksimum 29.
Pola:
[A-Z0-9]{5}(-[A-Z0-9]{5}){4}Wajib: Ya
- AgentName
-
Menentukan nama untuk agen Anda. Kami merekomendasikan untuk menentukan nama yang dapat Anda ingat.
Tipe: String
Batasan Panjang: Panjang minimum 0. Panjang maksimum 256.
Pola:
^[a-zA-Z0-9\s+=._:@/-]+$Wajib: Tidak
- SecurityGroupArns
-
Menentukan Amazon Resource Name (ARN) dari grup keamanan yang memungkinkan lalu lintas antara agen dan titik akhir VPC layanan Anda. Anda hanya dapat menentukan satuARN.
Tipe: Array string
Anggota Array: Jumlah tetap 1 item.
Batasan Panjang: Panjang maksimum 128.
Pola:
^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]+$Wajib: Tidak
- SubnetArns
-
Menentukan ARN subnet tempat endpoint VPC layanan Anda berada. Anda hanya dapat menentukan satuARN.
Tipe: Array string
Anggota Array: Jumlah tetap 1 item.
Batasan Panjang: Panjang maksimum 128.
Pola:
^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):ec2:[a-z\-0-9]*:[0-9]{12}:subnet/.*$Wajib: Tidak
- Tags
-
Menentukan label yang membantu Anda mengkategorikan, memfilter, dan mencari sumber daya Anda. AWS Sebaiknya buat setidaknya satu tag untuk agen Anda.
Tipe: Array objek TagListEntry
Anggota Array: Jumlah minimum 0 item. Jumlah maksimum 50 item.
Wajib: Tidak
- VpcEndpointId
-
Menentukan ID dari endpoint VPC layanan yang Anda gunakan. Misalnya, ID VPC titik akhir terlihat seperti
vpce-01234d5aff67890e1.penting
Titik akhir VPC layanan yang Anda gunakan harus menyertakan nama DataSync layanan (misalnya,
com.amazonaws.us-east-2.datasync).Tipe: String
Pola:
^vpce-[0-9a-f]{17}$Diperlukan: Tidak
Sintaksis Respons
{
"AgentArn": "string"
}Elemen Respons
Jika tindakan berhasil, layanan mengirimkan kembali respons HTTP 200.
Data berikut dikembalikan dalam JSON format oleh layanan.
- AgentArn
-
Agen ARN yang baru saja kau aktifkan. Gunakan ListAgentsoperasi untuk mengembalikan daftar agen di Akun AWS dan Wilayah AWS.
Tipe: String
Batasan Panjang: Panjang maksimum 128.
Pola:
^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}$
Kesalahan
Untuk informasi tentang kesalahan yang umum untuk semua tindakan, lihat Kesalahan Umum.
- InternalException
-
Pengecualian ini dilontarkan ketika terjadi kesalahan dalam layanan AWS DataSync .
HTTPKode Status: 500
- InvalidRequestException
-
Pengecualian ini dilontarkan ketika klien mengirimkan permintaan yang salah format.
HTTPKode Status: 400
Contoh
Permintaan Sampel
Contoh berikut mengaktifkan DataSync agen.
{ "ActivationKey": "AAAAA-1AAAA-BB1CC-33333-EEEEE", "AgentName": "MyAgent", "Tags": [{ "Key": "Job", "Value": "TransferJob-1" }] }
Contoh Respons
Respons mengembalikan ARN agen yang diaktifkan.
{ "AgentArn": "arn:aws:datasync:us-east-2:111222333444:agent/agent-0b0addbeef44baca3" }
Lihat Juga
Untuk informasi selengkapnya tentang penggunaan ini API di salah satu bahasa khusus AWS SDKs, lihat berikut ini:
