GetCustomField - Identity as a Service - Alibaba Cloud Documentation Center

Mengambil informasi tentang bidang yang diperluas.

Coba sekarang

Coba API ini di OpenAPI Explorer tanpa perlu penandatanganan manual. Panggilan yang berhasil akan secara otomatis menghasilkan contoh kode SDK sesuai dengan parameter Anda. Unduh kode tersebut dengan kredensial bawaan yang aman untuk penggunaan lokal.

Test

RAM authorization

Tabel berikut menjelaskan otorisasi yang diperlukan untuk memanggil API ini. Anda dapat menentukannya dalam kebijakan Resource Access Management (RAM). Kolom pada tabel dijelaskan sebagai berikut:

Action: Aksi yang dapat digunakan dalam elemen Action pada pernyataan kebijakan izin RAM untuk memberikan izin guna melakukan operasi tersebut.
API: API yang dapat Anda panggil untuk melakukan aksi tersebut.
Access level: Tingkat akses yang telah ditentukan untuk setiap API. Nilai yang valid: create, list, get, update, dan delete.
Resource type: Jenis resource yang mendukung otorisasi untuk melakukan aksi tersebut. Ini menunjukkan apakah aksi tersebut mendukung izin tingkat resource. Resource yang ditentukan harus kompatibel dengan aksi tersebut. Jika tidak, kebijakan tersebut tidak akan berlaku.
- Untuk API dengan izin tingkat resource, jenis resource yang diperlukan ditandai dengan tanda bintang (*). Tentukan Nama Sumber Daya Alibaba Cloud (ARN) yang sesuai dalam elemen Resource pada kebijakan.
- Untuk API tanpa izin tingkat resource, ditampilkan sebagai All Resources. Gunakan tanda bintang (*) dalam elemen Resource pada kebijakan.
Condition key: Kunci kondisi yang didefinisikan oleh layanan. Kunci ini memungkinkan kontrol granular, berlaku baik hanya untuk aksi maupun untuk aksi yang terkait dengan resource tertentu. Selain kunci kondisi spesifik layanan, Alibaba Cloud menyediakan serangkaian common condition keys yang berlaku di semua layanan yang didukung RAM.
Dependent action: Aksi dependen yang diperlukan untuk menjalankan aksi tersebut. Untuk menyelesaikan aksi tersebut, pengguna RAM atau role RAM harus memiliki izin untuk melakukan semua aksi dependen.

Action

Access level

Resource type

Condition key

Dependent action

eiam:GetCustomField

get

*CustomField

acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/customfield/{#FieldId}

None

Parameter permintaan

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	ID instans.	idaas_ue2jvisn35ea5lmthk267xxxxx
FieldId	string	Yes	ID bidang.	ufd_001

Elemen respons

Element	Type	Description	Example
	object
RequestId	string	ID permintaan.	0441BD79-92F3-53AA-8657-F8CE4A2B912A
CustomField	object	Informasi bidang kustom.
InstanceId	string	ID instans.	idaas_z4pwq7v5ankdimdelzo2zbmzo4
FieldId	string	ID bidang.	ufd_ncvy5trszg3zajaal5iofauy2q
EntityType	string	Jenis entitas tempat bidang tersebut berada.	user
FieldName	string	Pengidentifikasi bidang.	userId
FieldDisplayName	string	Nama tampilan bidang.	userId
FieldDisplayType	string	Jenis tampilan bidang. Valid values: input : input number : number select : select checkbox : checkbox	input
FieldDataType	string	Jenis data. Valid values: number : number boolean : boolean string : string	string
DefaultValue	string	Nilai default bidang.	test
FieldDataConfig	object	Item konfigurasi nilai bidang.
Items	array<object>	A list of field configuration items.
	object	Custom field configuration.
DisplayName	string	The display name of the configuration item.	hobby
Value	string	The value of the configuration item.	game
Status	string	The status of the configuration item. Valid values: disabled : disabled enabled : enabled	enabled
Unique	boolean	Menunjukkan apakah bidang tersebut bersifat unik.	false
Encrypted	boolean	Menunjukkan apakah bidang tersebut dienkripsi.	false
Required	boolean	Menunjukkan apakah bidang tersebut wajib diisi.	false
UserPermission	string	Izin sisi pengguna (sisi portal). Valid values: read_write : dapat diedit. hide : disembunyikan. read_only : terlihat.	read_only
CreateTime	integer	Waktu saat bidang yang diperluas dibuat, dalam format stempel waktu UNIX. Satuan: milidetik.	17642960730
UpdateTime	integer	Waktu saat bidang yang diperluas terakhir diperbarui, dalam format stempel waktu UNIX. Satuan: milidetik.	17642960730
Status	string	Status bidang yang diperluas. Valid values: disabled : dinonaktifkan. enabled : diaktifkan.	enabled
Description	string	Deskripsi bidang yang diperluas.	test

Contoh

Respons sukses

JSONformat

{
  "RequestId": "0441BD79-92F3-53AA-8657-F8CE4A2B912A",
  "CustomField": {
    "InstanceId": "idaas_z4pwq7v5ankdimdelzo2zbmzo4",
    "FieldId": "ufd_ncvy5trszg3zajaal5iofauy2q",
    "EntityType": "user",
    "FieldName": "userId",
    "FieldDisplayName": "userId",
    "FieldDisplayType": "input",
    "FieldDataType": "string",
    "DefaultValue": "test",
    "FieldDataConfig": {
      "Items": [
        {
          "DisplayName": "hobby",
          "Value": "game",
          "Status": "enabled"
        }
      ]
    },
    "Unique": false,
    "Encrypted": false,
    "Required": false,
    "UserPermission": "read_only",
    "CreateTime": 17642960730,
    "UpdateTime": 17642960730,
    "Status": "enabled",
    "Description": "test"
  }
}

Kode kesalahan

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.