ObtainCredential - Identity as a Service - Alibaba Cloud ドキュメントセンター

機密情報を含む認証情報リソースを照会します。

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。
API：アクションを具体的に実行するための API。
アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。
リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。
- リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。
- リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。
条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。
依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

eiam:ObtainCredential

get

*Credential

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

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
InstanceId	string	必須	インスタンスの ID。	idaas_ue2jvisn35ea5lmthk267xxxxx
CredentialId	string	必須	認証情報の ID。	cred_mkv7rgt4d7i4u7zqtzev2mxxxx

レスポンスフィールド

フィールド	型	説明	例
	object
RequestId	string	リクエストの ID。	0441BD79-92F3-53AA-8657-F8CE4A2B912A
Credential	object	認証情報。
InstanceId	string	インスタンスの ID。	idaas_ue2jvisn35ea5lmthk267xxxxx
CredentialId	string	認証情報の ID。	cred_mkv7rgt4d7i4u7zqtzev2mxxxx
Status	string	認証情報のステータス。有効な値: enabled: 有効。 disabled: 無効。	enabled
CredentialIdentifier	string	認証情報の識別子。	credential_identifier_test
CredentialName	string	認証情報の名前。	credential_name
CredentialSubjectType	string	認証情報が属する主題のタイプ。有効な値: authentication_token_provider: 認証トークンプロバイダー。	authentication_token_provider
CredentialSubjectId	string	認証情報が属する主題の ID。	apt_werthgfdsasffxxxxx
CredentialScenarioLabel	string	認証情報のシナリオラベル。有効な値: llm: large 言語モデル。 saas: サードパーティ SaaS サービス。	llm
CredentialType	string	認証情報のタイプ。有効な値: api_key: API キー認証情報。 oauth_client: OAuth クライアント認証情報。	api_key
CredentialCreationType	string	認証情報の作成タイプ。有効な値: system_init: システムによって作成。 user_custom: ユーザーによって作成。	user_custom
Description	string	認証情報の説明。	credential_description
CreateTime	integer	作成時間 (UNIX タイムスタンプフォーマット)。単位: ミリ秒。	1649830225000
UpdateTime	integer	更新時間 (UNIX タイムスタンプフォーマット)。単位: ミリ秒。	1649830227000
CredentialContent	object	認証情報の内容。
OAuthClientContent	object	OAuth 2.0 クライアント認証情報の詳細。
ClientId	string	クライアント ID。	dmvncmxersdxxxxxx
ClientSecret	string	クライアントシークレット。	nsklnertyt5ddwizncxxxx
ApiKeyContent	object	API キー認証情報の詳細。
ApiKey	string	API キー。	nsklncmwizncxxxx
CredentialSharingScope	string
ExclusiveUserId	string
CredentialExternalId	string

例

成功レスポンス

JSONJSON

{
  "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": ""
  }
}

エラーコード

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。