DescribeAccess - AWS Transfer Family
Sintaksis PermintaanParameter PermintaanSintaksis ResponsElemen ResponsKesalahanLihat Juga

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

DescribeAccess

Menjelaskan akses yang ditetapkan ke server berkemampuan protokol transfer file tertentu, seperti yang diidentifikasi oleh ServerId propertinya dan miliknya. ExternalId

Respons dari panggilan ini mengembalikan properti akses yang terkait dengan ServerId nilai yang ditentukan.

Sintaksis Permintaan

{
   "ExternalId": "string",
   "ServerId": "string"
}

Parameter Permintaan

Untuk informasi tentang parameter yang umum untuk semua tindakan, lihat Parameter Umum.

Permintaan menerima data berikut dalam format JSON.

ExternalId

Pengidentifikasi unik yang diperlukan untuk mengidentifikasi grup tertentu dalam direktori Anda. Pengguna grup yang Anda asosiasikan memiliki akses ke sumber daya Amazon S3 atau Amazon EFS Anda melalui protokol yang diaktifkan. AWS Transfer Family Jika Anda tahu nama grup, Anda dapat melihat nilai SID dengan menjalankan perintah berikut menggunakan Windows PowerShell.

Get-ADGroup -Filter {samAccountName -like "YourGroupName*"} -Properties * | Select SamAccountName,ObjectSid

Dalam perintah itu, ganti YourGroupNamedengan nama grup Active Directory Anda.

Ekspresi reguler yang digunakan untuk memvalidasi parameter ini adalah string karakter yang terdiri dari huruf besar dan huruf kecil karakter alfanumerik tanpa spasi. Anda juga dapat menyertakan garis bawah atau salah satu karakter berikut: =, . @: /-

Jenis: String

Batasan Panjang: Panjang minimum 1. Panjang maksimum 256.

Pola: S-1-[\d-]+

Wajib: Ya

ServerId

Pengidentifikasi unik yang ditetapkan sistem untuk server yang memiliki akses ini ditetapkan.

Jenis: String

Kendala Panjang: Panjang tetap 19.

Pola: s-([0-9a-f]{17})

Diperlukan: Ya

Sintaksis Respons

{
   "Access": { 
      "ExternalId": "string",
      "HomeDirectory": "string",
      "HomeDirectoryMappings": [ 
         { 
            "Entry": "string",
            "Target": "string",
            "Type": "string"
         }
      ],
      "HomeDirectoryType": "string",
      "Policy": "string",
      "PosixProfile": { 
         "Gid": number,
         "SecondaryGids": [ number ],
         "Uid": number
      },
      "Role": "string"
   },
   "ServerId": "string"
}

Elemen Respons

Jika tindakan berhasil, layanan mengirimkan kembali respons HTTP 200.

Layanan mengembalikan data berikut dalam format JSON.

Access

Pengidentifikasi eksternal server tempat akses dilampirkan.

Tipe: Objek DescribedAccess

ServerId

Pengidentifikasi unik yang ditetapkan sistem untuk server yang memiliki akses ini ditetapkan.

Jenis: String

Kendala Panjang: Panjang tetap 19.

Pola: s-([0-9a-f]{17})

Kesalahan

Untuk informasi tentang kesalahan yang umum untuk semua tindakan, lihat Kesalahan Umum.

InternalServiceError

Pengecualian ini dilemparkan ketika kesalahan terjadi dalam AWS Transfer Family layanan.

Kode Status HTTP: 500

InvalidRequestException

Pengecualian ini dilontarkan ketika klien mengirimkan permintaan yang salah format.

Kode Status HTTP: 400

ResourceNotFoundException

Pengecualian ini dilemparkan ketika sumber daya tidak ditemukan oleh layanan AWS Transfer Family.

Kode Status HTTP: 400

ServiceUnavailableException

Permintaan gagal karena layanan AWS Transfer Family tidak tersedia.

Kode Status HTTP: 500

Lihat Juga

Untuk informasi selengkapnya tentang penggunaan API ini di salah satu AWS SDK khusus bahasa, lihat berikut ini: