すべてのプロダクト
Search
ドキュメントセンター

PolarDB:DescribeGatewayApikeyList

最終更新日:Jun 26, 2026

現在の UID 配下のすべての API キーを照会します。

今すぐお試しください

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

テスト

RAM 認証

この操作の認証情報はありません。問題が発生した場合は、アカウントマネージャーにご連絡ください。

リクエスト構文

POST  HTTP/1.1

リクエストパラメーター

パラメーター

必須 / 任意

説明

PageNumber

integer

任意

ページ番号。デフォルト値: 1。

1

PageSize

integer

任意

1 ページあたりのエントリ数。有効な値:

  • 30

  • 50

  • 100 デフォルト値: 30

30

RegionId

string

必須

リージョン ID。

cn-beijing

レスポンスフィールド

フィールド

説明

object

レスポンスのスキーマ。

RequestId

string

リクエストの ID。

A0450B18-BBD4-5DF9-8E71-610F1A921CDE

TotalRecordCount

integer

レコードの総数。

1

PageRecordCount

integer

現在のページのレコード数。

1

PageNumber

integer

ページ番号。

1

PageSize

integer

1 ページあたりのエントリ数。有効な値:

  • 30

  • 50

  • 100

デフォルト値: 30。

30

TotalPages

integer

ページの総数。

1

Items

array<object>

消費者オブジェクトのリスト。

object

消費者オブジェクト。

ConsumerId

string

ユーザー ID。

c-mqveroemc***

Name

string

ユーザー名。

test

ConsumerGroupId

string

ユーザーグループ ID。

cg-xxxxxx

ConsumerTag

string

消費者タグ。

test

ApiKey

string

使用中の API キー。

xxxxxxxx

GwClusterId

string

ゲートウェイインスタンス ID。

pg-xxxxxxxx

CreateTime

string

作成時間。

2020-08-14T05:58:42Z

ModifyTime

string

最終変更時間。

2024-10-29T09:31:37Z

成功レスポンス

JSONJSON

{
  "RequestId": "A0450B18-BBD4-5DF9-8E71-610F1A921CDE",
  "TotalRecordCount": 1,
  "PageRecordCount": 1,
  "PageNumber": 1,
  "PageSize": 30,
  "TotalPages": 1,
  "Items": [
    {
      "ConsumerId": "c-mqveroemc***",
      "Name": "test",
      "ConsumerGroupId": "cg-xxxxxx",
      "ConsumerTag": "test",
      "ApiKey": "xxxxxxxx",
      "GwClusterId": "pg-xxxxxxxx",
      "CreateTime": "2020-08-14T05:58:42Z",
      "ModifyTime": "2024-10-29T09:31:37Z"
    }
  ]
}

エラーコード

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

変更履歴

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