CreateBatchConsumer - 批量创建网关用户ApiKey

更新时间:
复制 MD 格式

批量创建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

piKey 状态,默认 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"
    }
  ]
}

错误码

访问错误中心查看更多错误码。

变更历史

更多信息,参考变更详情