Todos os produtos
Search
Central de documentação

PolarDB:DescribeApikeyAttribute

Última atualização: Jun 29, 2026

Consulta os detalhes de uma chave de API especificada.

Experimente agora

Experimente esta API no OpenAPI Explorer, sem necessidade de assinatura manual. Chamadas bem-sucedidas geram automaticamente código SDK correspondente aos seus parâmetros. Faça o download com segurança de credenciais integrada para uso local.

Testar

Autorização RAM

Nenhuma autorização necessária para esta operação. Se você encontrar problemas com esta operação, entre em contato com o suporte técnico.

Sintaxe da solicitação

POST  HTTP/1.1

Parâmetros da solicitação

Parâmetro

Tipo

Obrigatório

Descrição

Exemplo

ApiKey

string

Sim

A chave de API em texto simples.

6c4b1f0317cd4fd7a5b446d3503d**

RegionId

string

Sim

O ID da região.

cn-hangzhou

PageSize

integer

Não

O número de entradas por página. Valores válidos: 30, 50 e 100.

Valor padrão: 30.

30

PageNumber

integer

Não

O número da página. Valor padrão: 1.

1

Elementos de resposta

Elemento

Tipo

Descrição

Exemplo

object

Esquema da resposta.

RequestId

string

O ID da solicitação.

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

Items

array<object>

A lista de objetos de consumidor.

array<object>

O objeto de consumidor.

Consumer

object

As informações do consumidor.

ConsumerId

string

c-71qh3pscbd3i

GwClusterId

string

pg-2ze5n62ef4s165***

Name

string

test

ConsumerGroupId

string

cg-bq6rcdjp02vt

ConsumerTag

string

test

ApiKey

string

***

Status

string

Enabled

CreateTime

string

2021-07-18T07:32:30Z

ModifyTime

string

2026-04-10T01:48:25Z

UsageStatistics

array<object>

As estatísticas de uso do consumidor.

object

As estatísticas de uso do consumidor.

GwClusterId

string

pg-bp1ln7w98yrhzz7i2

DimensionType

string

Consumer

DimensionRefId

string

c-xxxxxx

TotalInputToken

string

10

TotalOutputToken

string

10

TotalCacheToken

string

10

TotalCostPoints

string

10

MonthlyInputToken

string

10

MonthlyOutputToken

string

10

MonthlyCacheToken

string

10

MonthlyCostPoints

string

10

TotalToken

string

10

MonthlyToken

string

10

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "F3322AFE-083E-4D77-A074-421301******",
  "Items": [
    {
      "Consumer": {
        "ConsumerId": "c-71qh3pscbd3i",
        "GwClusterId": "pg-2ze5n62ef4s165***",
        "Name": "test",
        "ConsumerGroupId": "cg-bq6rcdjp02vt",
        "ConsumerTag": "test",
        "ApiKey": "***",
        "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"
        }
      ]
    }
  ]
}

Códigos de erro

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.