DescribeApikeyAttribute - 查询该apikey的详细信息

更新时间:
复制 MD 格式

查询该apikey的详细信息。

调试

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

调试

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

polardb:DescribeApikeyAttribute

get

*全部资源

*

无 无

请求语法

POST  HTTP/1.1

请求参数

名称

类型

必填

描述

示例值

ApiKey

string

是

明文 ApiKey

6c4b1f0317cd4fd7a5b446d3503d**

RegionId

string

是

地域 ID。

cn-hangzhou

PageSize

integer

否

每页记录数,取值为 30、50 或 100。

默认值为 30。

30

PageNumber

integer

否

查询页码,默认值为 1。

1

返回参数

名称

类型

描述

示例值

object

Schema of Response

RequestId

string

请求 ID。

F3322AFE-083E-4D77-A074-421301******

Items

array<object>

消费者对象列表

array<object>

消费者对象

Consumer

object

Consumer 信息

ConsumerId

string

消费者 ID。

c-71qh3pscbd3i

GwClusterId

string

网关实例 ID。

pg-2ze5n62ef4s165***

Name

string

Consumer 名称

test

ConsumerGroupId

string

用户组 ID。

cg-bq6rcdjp02vt

ConsumerTag

string

消费者标签。

test

ApiKey

string

API 密钥

6c4b1f0317cd4fd7a5b446d3503d**

Status

string

Consumer 状态

Enabled

CreateTime

string

创建时间。格式为 YYYY-MM-DDTHH:mm:ssZ(UTC 时间)。

2021-07-18T07:32:30Z

ModifyTime

string

最后修改时间。 格式为 YYYY-MM-DDTHH:mm:ssZ(UTC 时间)。

2026-04-10T01:48:25Z

UsageStatistics

array<object>

该 Consumer 对应的用量统计记录

object

该 Consumer 对应的用量统计记录

GwClusterId

string

网关实例 ID。

pg-bp1ln7w98yrhzz7i2

DimensionType

string

统计维度,通常为 Consumer

Consumer

DimensionRefId

string

维度引用 ID,即 ConsumerId

c-xxxxxx

TotalInputToken

string

累计输入 token

10

TotalOutputToken

string

累计输出 token

10

TotalCacheToken

string

累计缓存 token

10

TotalCostPoints

string

累计消耗点数

10

MonthlyInputToken

string

当月输入 token

10

MonthlyOutputToken

string

当月输出 token

10

MonthlyCacheToken

string

当月缓存 token

10

MonthlyCostPoints

string

当月消耗点数

10

TotalToken

string

累计 token

10

MonthlyToken

string

当月 token

10

示例

正常返回示例

JSON格式

{
  "RequestId": "F3322AFE-083E-4D77-A074-421301******",
  "Items": [
    {
      "Consumer": {
        "ConsumerId": "c-71qh3pscbd3i",
        "GwClusterId": "pg-2ze5n62ef4s165***",
        "Name": "test",
        "ConsumerGroupId": "cg-bq6rcdjp02vt",
        "ConsumerTag": "test",
        "ApiKey": "6c4b1f0317cd4fd7a5b446d3503d**",
        "Status": "Enabled",
        "CreateTime": "2021-07-18T07:32:30Z",
        "ModifyTime": "2026-04-10T01:48:25Z"
      },
      "UsageStatistics": [
        {
          "GwClusterId": "pg-bp1ln7w98yrhzz7i2",
          "DimensionType": "Consumer\n\n",
          "DimensionRefId": "c-xxxxxx",
          "TotalInputToken": "10",
          "TotalOutputToken": "10",
          "TotalCacheToken": "10",
          "TotalCostPoints": "10",
          "MonthlyInputToken": "10",
          "MonthlyOutputToken": "10",
          "MonthlyCacheToken": "10",
          "MonthlyCostPoints": "10",
          "TotalToken": "10",
          "MonthlyToken": "10"
        }
      ]
    }
  ]
}

错误码

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

变更历史

更多信息,参考变更详情。