全部产品
Search
文档中心

云原生数据库 PolarDB:DescribeGatewayApikeyList - 查询该UID下所有的ApiKeys

更新时间:Jun 26, 2026

查询该UID下所有的apikeys

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

当前API暂无授权信息透出。

请求语法

POST  HTTP/1.1

请求参数

名称

类型

必填

描述

示例值

PageNumber

integer

查询页码,默认值为 1。

1

PageSize

integer

每页记录数,取值范围如下:

  • 30

  • 50

  • 100 默认值为 30

30

RegionId

string

地域 ID。

cn-beijing

返回参数

名称

类型

描述

示例值

object

Schema of Response

RequestId

string

Id of the request

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

TotalRecordCount

integer

总记录数。

1

PageRecordCount

integer

本页记录数

1

PageNumber

integer

查询页码。

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

CreateTime

string

创建时间。

2020-08-14T05:58:42Z

ModifyTime

string

最后修改时间。

2024-10-29T09:31:37Z

示例

正常返回示例

JSON格式

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

错误码

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

变更历史

更多信息,参考变更详情