コンテンツにスキップ

一覧¶

GET /api/v1/workspace/accesskey/list

概要¶

Key 一覧を取得します。

Query リクエストパラメータ¶

パラメータ名	タイプ	必須	説明
search	string		名前で検索します。例: supper_workspace 空の場合は許可されません: False
orderBy	string		並び替えフィールド。`createAt` / `callCount` / `lastCallAt` をサポートします。例: callCount 空の場合は許可されません: False 選択可能な値: ['createAt', 'callCount', 'lastCallAt']
order	string		並び順。`asc` / `desc` をサポートし、デフォルトは `desc` です。例: desc 空の場合は許可されません: False 選択可能な値: ['asc', 'desc']

パラメータ補足説明¶

作成 API は、新しい API Key の平文の ak/sk を引き続き返します。本 API の呼び出しに使用する OpenAPI API Key が owner ロールを持つ場合、取得 API はワークスペース API Key の平文の ak/sk を返します。owner ロールでない場合、現在の呼び出し資格情報に対応するワークスペース API Key のレコードのみ平文の ak/sk を返し、その他のレコードはマスクされた ak/sk（末尾 4 桁のみ保持）を返します。このルールは個人 API Key には適用されません。

リクエスト例¶

curl 'https://openapi.guance.com/api/v1/workspace/accesskey/list' \
-H 'DF-API-KEY: <DF-API-KEY>' \
--compressed

レスポンス¶

{
    "code": 200,
    "content": [
        {
            "callCount": 12,
            "createAt": 1677808718,
            "creator": "acnt_xxxx32",
            "creatorInfo": {
                "email": "xxx@guance.com",
                "iconUrl": "",
                "name": "88Test",
                "username": "Test"
            },
            "deleteAt": -1,
            "id": 4,
            "lastCallAt": 1677809718,
            "name": "test",
            "sk": "xxx",
            "status": 0,
            "updateAt": 1677808718,
            "updator": "acnt_xxxx32",
            "uuid": "xxx",
            "workspaceUUID": "wksp_xxxx32"
        }
    ],
    "errorCode": "",
    "message": "",
    "success": true,
    "traceId": "TRACE-B73F5F23-046C-4A84-8B33-D028C92994C4"
}