ObtainCredential - Identity as a Service - Alibaba Cloud Documentation Center

Mengkueri resource kredensial yang berisi informasi sensitif.

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:ObtainCredential

get

*Kredensial.

acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/credential/{#CredentialId}

None

Parameter permintaan

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	ID instans.	idaas_ue2jvisn35ea5lmthk267xxxxx
CredentialId	string	Yes	ID kredensial.	cred_mkv7rgt4d7i4u7zqtzev2mxxxx

Elemen respons

Element	Type	Description	Example
	object
RequestId	string	ID permintaan.	0441BD79-92F3-53AA-8657-F8CE4A2B912A
Credential	object	Informasi kredensial.
InstanceId	string	ID instans.	idaas_ue2jvisn35ea5lmthk267xxxxx
CredentialId	string	ID kredensial.	cred_mkv7rgt4d7i4u7zqtzev2mxxxx
Status	string	Status kredensial. Nilai valid: enabled: Diaktifkan. disabled: Dinonaktifkan.	enabled
CredentialIdentifier	string	Pengenal kredensial.	credential_identifier_test
CredentialName	string	Nama kredensial.	credential_name
CredentialSubjectType	string	Tipe subjek tempat kredensial berada. Nilai valid: authentication_token_provider: penyedia token otentikasi.	authentication_token_provider
CredentialSubjectId	string	ID subjek tempat kredensial berada.	apt_werthgfdsasffxxxxx
CredentialScenarioLabel	string	Label skenario kredensial. Nilai valid: llm: model bahasa tingkat tinggi. saas: layanan SaaS pihak ketiga.	llm
CredentialType	string	Tipe kredensial. Nilai valid: api_key: kredensial otentikasi kunci API. oauth_client: kredensial otentikasi klien OAuth.	api_key
CredentialCreationType	string	Tipe pembuatan kredensial. Nilai valid: system_init: Dibuat oleh sistem. user_custom: Dibuat oleh pengguna.	user_custom
Description	string	Deskripsi kredensial.	credential_description
CreateTime	integer	Waktu pembuatan, dalam format stempel waktu UNIX. Unit: milidetik.	1649830225000
UpdateTime	integer	Waktu pembaruan, dalam format stempel waktu UNIX. Unit: milidetik.	1649830227000
CredentialContent	object	Konten kredensial.
OAuthClientContent	object	The details of the OAuth 2.0 client credential.
ClientId	string	The client ID.	dmvncmxersdxxxxxx
ClientSecret	string	The client secret.	nsklnertyt5ddwizncxxxx
ApiKeyContent	object	The details of the API key credential.
ApiKey	string	The API key.	nsklncmwizncxxxx
CredentialSharingScope	string
ExclusiveUserId	string
CredentialExternalId	string

Contoh

Respons sukses

JSONformat

{
  "RequestId": "0441BD79-92F3-53AA-8657-F8CE4A2B912A",
  "Credential": {
    "InstanceId": "idaas_ue2jvisn35ea5lmthk267xxxxx",
    "CredentialId": "cred_mkv7rgt4d7i4u7zqtzev2mxxxx",
    "Status": "enabled",
    "CredentialIdentifier": "credential_identifier_test",
    "CredentialName": "credential_name",
    "CredentialSubjectType": "authentication_token_provider",
    "CredentialSubjectId": "apt_werthgfdsasffxxxxx",
    "CredentialScenarioLabel": "llm",
    "CredentialType": "api_key",
    "CredentialCreationType": "user_custom",
    "Description": "credential_description",
    "CreateTime": 1649830225000,
    "UpdateTime": 1649830227000,
    "CredentialContent": {
      "OAuthClientContent": {
        "ClientId": "dmvncmxersdxxxxxx",
        "ClientSecret": "nsklnertyt5ddwizncxxxx"
      },
      "ApiKeyContent": {
        "ApiKey": "nsklncmwizncxxxx"
      }
    },
    "CredentialSharingScope": "",
    "ExclusiveUserId": "",
    "CredentialExternalId": ""
  }
}

Kode kesalahan

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.