全部產品
Search
文件中心

PolarDB:CreateBatchConsumer

更新時間:Jun 26, 2026

批次建立apikey。

調試

您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

當前API暫無授權資訊透出。

請求文法

POST  HTTP/1.1

請求參數

名稱

類型

必填

描述

樣本值

GwClusterId

string

閘道執行個體 ID。

pg-xxxxxxxx

Count

integer

使用者 ApiKey 個數。

1

ConsumerGroupId

string

使用者群組 ID。

cg-xxxxxx

ClientToken

string

用於保證請求的冪等性,防止重複提交請求。由用戶端產生該參數值,保證在不同請求間唯一,大小寫敏感、不超過 64 個 ASCII 字元。

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

RegionId

string

地域 ID。

cn-beijing

返回參數

名稱

類型

描述

樣本值

object

Schema of Response

RequestId

string

Id of the request

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

TotalRecordCount

integer

總記錄數。

2

PageRecordCount

integer

本頁記錄數。

1

PageNumber

integer

查詢頁碼,預設值為 1。

1

PageSize

integer

每頁記錄數,取值範圍如下:

  • 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

完整 APIKey,僅本次返回。

xxxxxxxx

GwClusterId

string

閘道執行個體 ID。

pg-xxxxxxxxxx

ApiStatus

string

APIKey 狀態,預設 Active。

Active

Status

string

Consumer 狀態,預設 Enabled。

Enabled

樣本

正常返回樣本

JSON格式

{
  "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"
    }
  ]
}

錯誤碼

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊,參考變更詳情