コンテンツにスキップ

一覧取得



GET /api/v1/workspace/accesskey/list

概要

現在のワークスペース内でアカウントにバインドされていない有効な API Key レコードを一覧表示します。

呼び出し前の準備と使用手順

呼び出しには現在のワークスペースの workspace.openAPIKeyManage 権限が必要です。以下の例では一般的なフィールドを抜粋しています。一覧にページネーションはなく、Owner 以外は Owner Key を表示できません。デフォルトでは Owner のレコードが先頭に並び、同じグループ内ではレコード ID の降順になります。uuid を取得したら詳細を参照できます。手動で作成されアカウントにバインドされていないワークスペース Key は、ワークスペースの Owner が完全な認証情報を読み取ることができます。Owner 以外は、今回使用したこの Key についてのみ完全な値を読み取ることができ、その他のレコードはマスクされます。個人、Agent などその他のソースもマスクされます。ログやチケットに記載するレスポンスはマスクしてください。

リクエストヘッダー

パラメータ名 型 必須 説明
DF-API-KEY string Y ワークスペースの呼び出し認証情報。レコード UUID と呼び出し認証情報は別のフィールドです。
例: <DF-API-KEY>
取得または入力方法: 現在のワークスペースの API Key 管理から完全な認証情報を取得します。

Query リクエストパラメータ

パラメータ名 型 必須 説明
search string 名前のあいまい一致で検索します。省略または空欄の場合は絞り込みません。
null 許可: False
例: 应用
取得または入力方法: ワークスペースの API Key 管理ページから名前をコピーします。名前の一部を入力してもかまいません。
orderBy string 一覧のソートフィールド。省略時はデフォルトの並び順を使用します。
null 許可: False
選択可能な値: ['createAt', 'callCount', 'lastCallAt']
例: lastCallAt
取得または入力方法: 必要に応じて作成時刻 createAt、呼び出し回数 callCount、最終呼び出し lastCallAt から選択します。
order string デフォルトは desc です。orderBy と併用します。
null 許可: False
選択可能な値: ['asc', 'desc']
例: desc
取得または入力方法: 昇順 asc または降順 desc を選択します。

パラメータの補足説明

例に示すリソース識別子はプレースホルダーです。対象ワークスペースの実際の値に置き換えてください。

リクエスト例

curl --get -H "DF-API-KEY: <DF-API-KEY>" \
  'https://openapi.guance.com/api/v1/workspace/accesskey/list' \
  --data-urlencode "search=应用" \
  --data-urlencode "orderBy=lastCallAt" \
  --data-urlencode "order=desc"

レスポンス

HTTP 200、application/json。

フィールド 型 説明
content array<object> 条件に一致した Key レコード。
content[].uuid string API Key レコードの UUID。多くの場合プレフィックスは wsak_ です。API Key 管理 API のパスに使用します。
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 発生条件 メッセージまたはレスポンスの説明 対処方法
406 ft.ParameterValidationFailed 宣言されていないパラメータが渡された、またはパラメータ値が検証に失敗した パラメータ検証に失敗しました。メッセージに無効なフィールドが示されます。 各フィールドの位置と選択可能な値を確認してください。

フィードバック

このページは役に立ちましたか?