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

PolarDB:CreateBatchConsumer

最終更新日:Jun 26, 2026

API キーをバッチで作成します。

今すぐお試しください

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

テスト

RAM 認証

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

リクエスト構文

POST  HTTP/1.1

リクエストパラメーター

パラメーター

必須 / 任意

説明

GwClusterId

string

必須

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

pg-xxxxxxxx

Count

integer

必須

作成するユーザー API キーの数。

1

ConsumerGroupId

string

必須

ユーザーグループの ID。

cg-xxxxxx

ClientToken

string

任意

リクエストのべき等性を確保し、リクエストの重複送信を防止するために使用されるクライアントトークン。値はクライアントによって生成され、異なるリクエスト間で一意である必要があります。値は大文字と小文字が区別され、64 文字以内の ASCII 文字で指定する必要があります。

6000170000591aed949d0f5********************

RegionId

string

必須

リージョン ID。

cn-beijing

レスポンスフィールド

フィールド

説明

object

レスポンスのスキーマ。

RequestId

string

リクエストの ID。

A7E6A8FD-C50B-46B2-BA85-D8B8D3******

TotalRecordCount

integer

レコードの総数。

2

PageRecordCount

integer

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

1

PageNumber

integer

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

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-xxxxxxxxxx

ApiStatus

string

API キーのステータス。デフォルト値: Active。

Active

Status

string

消費者のステータス。デフォルト値: Enabled。

Enabled

成功レスポンス

JSONJSON

{
  "RequestId": "A7E6A8FD-C50B-46B2-BA85-D8B8D3******",
  "TotalRecordCount": 2,
  "PageRecordCount": 1,
  "PageNumber": 1,
  "PageSize": 30,
  "TotalPages": 1,
  "Items": [
    {
      "ConsumerId": "c-mqveroemc***",
      "Name": "test",
      "ConsumerGroupId": "cg-xxxxxx",
      "ConsumerTag": "test",
      "ApiKey": "xxxxxxxx",
      "GwClusterId": "pg-xxxxxxxxxx",
      "ApiStatus": "Active",
      "Status": "Enabled"
    }
  ]
}

エラーコード

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

変更履歴

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