取得¶
GET /api/v1/workspace/accesskey/{ak_uuid}/get
概要¶
レコード UUID を指定して、現在のワークスペース内にある特定の API Key の情報と認可を取得します。
呼び出し前の準備と使用手順¶
呼び出しには現在のワークスペースの workspace.openAPIKeyManage 権限が必要です。以下の例では一般的なフィールドのみを抜粋しています。API Key リストの content[].uuid からレコード UUID を取得してください。手動で作成されアカウントにバインドされていないワークスペース Key は、ワークスペースの Owner が完全な資格情報を取得できます。Owner 以外の場合は、今回使用するこの Key についてのみ完全な値を取得でき、その他のレコードはマスクされます。個人、Agent などその他のソースもマスクされます。ログやチケットに含まれるレスポンスはマスキングしてください。
パスパラメータ¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| ak_uuid | string | Y | 対象レコードの UUID。実際の Secret Key は指定できません。 例: wsak_example取得・指定方法: API Key リストの content[].uuid から取得します。 |
リクエストヘッダー¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| DF-API-KEY | string | Y | ワークスペースの呼び出し資格情報。レコード UUID と呼び出し資格情報は別のフィールドです。 例: <DF-API-KEY>取得・指定方法: 現在のワークスペースの API Key 管理から完全な資格情報を取得します。 |
パラメータの補足説明¶
例に含まれるリソース識別子はプレースホルダーです。対象ワークスペースの実際の値に置き換えてください。
リクエスト例¶
curl --get -H "DF-API-KEY: <DF-API-KEY>" \
'https://openapi.guance.com/api/v1/workspace/accesskey/wsak_example/get'
レスポンス¶
HTTP 200、application/json。
| フィールド | 型 | 説明 |
|---|---|---|
| content.uuid | string | API Key レコードの UUID。一般的なプレフィックスは wsak_ です。API Key 管理インターフェースのパスに使用します。 |
| content.name | string | API Key の名前。 |
| content.workspaceUUID | string | 所属するワークスペース。 |
| content.createdWay | string | API Key の作成元。 |
| content.remark | string | API Key の備考。 |
| content.isOwnerRole | integer または boolean | この API Key がワークスペースの所有者ロールを持つかどうか。 |
| content.callCount | integer | 記録された呼び出し回数。 |
| content.lastCallAt | integer | 最後に記録された呼び出し時刻。Unix 秒。記録がない場合は -1 になることがあります。 |
| content.createAt | integer | レコードの作成時刻。Unix 秒。 |
| content.accountUUID | string | 明示的にバインドされたアカウントの UUID。未バインドの場合は空文字列。 |
| content.effectiveAccountUUID | string | 認証に使用する身元識別子。未バインドの場合はこの API Key レコードの UUID。 |
| content.accountInfo | object または null | バインドされたアカウントの情報。未バインドの場合は null。 |
| content.roles | array<object> |
有効なロールの集合。順序は固定されません。 |
| content.roles[].uuid | string | ロールの UUID。 |
| content.roles[].name | string | ロール名。 |
| content.permissions | array<string> |
有効な権限識別子の集合。順序は固定されません。 |
| content.rolePermissions | object | 各ロールが持つ権限識別子。ロール UUID をキー、権限文字列の配列を値とします。 |
| content.declaration | object または null | ワークスペースの宣言。 |
| content.ak | string | Access Key の識別子。現在の身元に応じてマスクされる場合があります。 |
| content.sk | string | Secret Key の資格情報。現在の身元に応じてマスクされる場合があります。レスポンスは機密情報として扱ってください。 |
| content.creatorInfo | object | 作成者の情報。取得できない場合は空のオブジェクト。 |
{
"code": 200,
"content": {
"uuid": "wsak_example",
"name": "应用数据读取",
"workspaceUUID": "wksp_example",
"createdWay": "manual",
"remark": "",
"isOwnerRole": 0,
"callCount": 14,
"lastCallAt": 1785427200,
"createAt": 1785423600,
"accountUUID": "",
"effectiveAccountUUID": "wsak_example",
"accountInfo": null,
"roles": [
{
"uuid": "role_example",
"name": "应用数据只读"
}
],
"permissions": [
"routine.defaultAccess"
],
"rolePermissions": {
"role_example": [
"routine.defaultAccess"
]
},
"declaration": null,
"ak": "*************abcd",
"sk": "*************ef01",
"creatorInfo": {}
},
"errorCode": "",
"message": "",
"success": true,
"traceId": "TRACE-EXAMPLE"
}
エラーレスポンス¶
認証、レート制限、および共通リクエストのエラーについては共通エラー定義を参照してください。
| HTTP ステータス | errorCode | 発生条件 | メッセージまたはレスポンスの説明 | 対処方法 |
|---|---|---|---|---|
| 404 | ft.AKNotExistOrDelete | 同一ワークスペース内に一致する有効かつ非システムの API Key が存在しない | API Key が存在しないか、削除されています。 | 現在のワークスペースのリストから返された UUID を使用してください。 |
| 403 | ft.Forbidden | Owner 以外が Owner の Key を読み取ろうとした | 操作権限がありません。 | 認可要件を満たす呼び出し身元を使用してください。 |
| 403 | ft.AgentMemberDisabled | API Key にバインドされたアカウントが無効化されている | バインドされたアカウントが利用できません。 | バインドされたアカウントが利用可能な状態か確認してください。 |
| 404 | ft.AgentMemberNotFound | API Key にバインドされたアカウントが存在しないか、削除されている | バインドされたアカウントが見つかりません。 | バインド関係とアカウントの状態を確認してください。 |
| 404 | ft.WorkspaceAgentMemberNotFound | バインドされたアカウントに有効なワークスペースメンバー関係がない | 対応するワークスペースメンバーが見つかりません。 | このアカウントが現在のワークスペースのメンバーであるかを確認してください。 |