機能の概要
指定された組織とプロジェクトの下で、APIキーのリストをページネーションで取得します。
呼び出しの説明
インターフェース制約
呼び出し元はマルチクラウドAPIにアクセスするためのキーを保有している必要があります。AccessKey IDとAccessKey Secretの取得方法については、アクセスキーの管理を参照してください。
リクエストパス
GET /api/v2/maas/apikeys
リクエストパラメータ
クエリパラメータ
名前 |
型 |
必須 |
説明 |
サンプル値 |
|---|---|---|---|---|
| uid | string | いいえ | アカウントID。ゲートウェイによって設定されます。欠落している場合はINVALID_PARAMETERを返します。 | {uid} |
| Action | string | いいえ | クエリアクション識別子で、レスポンスのactionフィールドにそのまま返されます。同じ名前のヘッダーでも指定できます。 | ListAIServiceAPIKeys |
| pageNumber | integer | いいえ | ページ番号。1から始まり、デフォルトは1です。 | 1 |
| pageSize | integer | いいえ | 1ページあたりの件数。デフォルトは10、最大は100です。これを超える場合、サーバー側で強制的に20に設定されます。 | 10 |
リクエストヘッダー
名前 |
型 |
必須 |
説明 |
サンプル値 |
|---|---|---|---|---|
| Authorization | string | はい | IAM認証情報。 | -u ak:sk |
| requestId | string | いいえ | リクエストの一意の識別子。 | req-abc123 |
| X-Request-Id | string | いいえ | リクエストの一意の識別子。 | req-abc123 |
| X-OB-Org-Id | string | はい | 組織ID。すべてのインターフェースで必須です。 | org-xxxxxxxx |
| X-OB-Project-Id | string | はい | プロジェクトID。すべてのインターフェースで必須です。 | proj-xxxxxxxx |
戻り値
パラメータ名 |
型 |
説明 |
|---|---|---|
| action | string | リクエストアクション識別子。 |
| data | object | 戻されるデータオブジェクト。 |
| data.list | array | APIキーのリスト。 |
| data.list[].id | string | APIキーID。 |
| data.list[].name | string | APIキー名。 |
| data.list[].createdAt | string | 作成日時。 |
| data.list[].updatedAt | string | 更新日時。 |
| data.list[].expiresAt | string | 有効期限。 |
| data.total | integer | 総レコード数。 |
| requestId | string | リクエストID。 |
| server | string | サーバーアドレス。 |
例
リクエスト例
curl -X GET \
'https://api-cloud.oceanbase.com/api/v2/maas/apikeys?pageNumber=1&pageSize=10' \
-u ak:sk \
-H 'X-OB-Org-Id: org-xxxxxxxx' \
-H 'X-OB-Project-Id: proj-xxxxxxxx' \
-H 'requestId: req-abc123'
レスポンス例
{
"action": "ListAIServiceAPIKeys",
"data": {
"list": [
{
"id": "xxxxxx",
"name": "MyAPIKey",
"createdAt": "2024-01-01T00:00:00Z",
"updatedAt": "2024-01-01T00:00:00Z",
"expiresAt": "2025-01-01T00:00:00Z"
}
],
"total": 1
},
"requestId": "xxxxxx",
"server": "xxx.xxx.x.xxx:xxxx"
}