Todos los productos
Search
Centro de documentos

PolarDB:CreateBatchConsumer

Última actualización: Sep 24, 2026

Crea claves de API en lotes.

Descripción de la operación

Nota
  • Cada clúster puede tener un máximo de tres copias de seguridad creadas manualmente a la vez.

  • Si se devuelve el mensaje de error Exceeding the daily backup times of this DB cluster, ya existen tres copias de seguridad creadas manualmente en su clúster. Elimine las copias de seguridad antes de llamar a esta operación.

  • Después de llamar a esta operación, se crea una tarea de copia de seguridad en segundo plano. Si el volumen de datos es grande, la copia de seguridad puede tardar mucho tiempo. Espere a que la copia de seguridad se complete.

Pruébelo ahora

Pruebe esta API en OpenAPI Explorer sin necesidad de firma manual. Las llamadas exitosas generan automáticamente código SDK acorde a sus parámetros. Descárguelo con seguridad de credenciales integrada para uso local.

Test

Autorización de RAM

No se requiere autorización para esta operación. Si experimenta problemas al ejecutarla, póngase en contacto con el soporte técnico.

Sintaxis de la solicitud

POST  HTTP/1.1

Parámetros de la solicitud

Parámetro

Tipo

Obligatorio

Descripción

Ejemplo

GwClusterId

string

Sí

El ID de la instancia de gateway.

pg-xxxxxxxx

Count

integer

No

El número de claves de API de usuario.

1

ConsumerGroupId

string

No

El ID del grupo de consumidores.

cg-xxxxxx

ClientToken

string

No

El token de cliente que se utiliza para garantizar la idempotencia de la solicitud y evitar envíos duplicados. El token lo genera el cliente y debe ser único entre las distintas solicitudes. El token distingue entre mayúsculas y minúsculas y no puede superar los 64 caracteres ASCII de longitud.

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

CreditToken

string

No

El código de canje. Si se especifica, se utiliza la rama de activación de recarga, y la cantidad y la cuota se obtienen de la base de datos.

"9"

Description

string

No

El prefijo de descripción del consumidor.

myapp

RegionId

string

Sí

El ID de la región.

cn-beijing

Elementos de la respuesta

Elemento

Tipo

Descripción

Ejemplo

object

El esquema de la respuesta.

RequestId

string

El ID de la solicitud.

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

TotalRecordCount

integer

El número total de registros.

2

PageRecordCount

integer

El número de registros en la página actual.

1

PageNumber

integer

El número de página. Valor predeterminado: 1.

1

PageSize

integer

El número de registros por página. Valores válidos:

  • 30

  • 50

  • 100

Valor predeterminado: 30.

30

TotalPages

integer

El número total de páginas.

1

Items

array<object>

La lista de objetos de consumidor.

object

El objeto de consumidor.

ConsumerId

string

El ID del consumidor.

c-mqveroemc***

Name

string

El nombre del consumidor.

test

ConsumerGroupId

string

El ID del grupo de consumidores.

cg-xxxxxx

ConsumerTag

string

La etiqueta del consumidor.

test

ApiKey

string

La clave de API completa. Se devuelve solo en esta respuesta.

xxxxxxxx

GwClusterId

string

El ID de la instancia de gateway.

pg-xxxxxxxxxx

ApiStatus

string

El estado de la clave de API. Valor predeterminado: Active.

Active

ApiKeyStatus

string

El estado de la clave de API. Valor predeterminado: Active.

Active

Status

string

El estado del consumidor. Valor predeterminado: Enabled.

Enabled

GmtCreated

string

La hora de creación.

2024-10-16 16:46:20

GmtModified

string

La hora de actualización.

2026-01-04T16:09:29+08:00

Description

string

La descripción de la aplicación o las observaciones.

myapp

ApiKeyMd5

string

El hash MD5 de la clave de API.

0769a11c2d474f96fbb527f8e273d3de

BudgetPolicyId

string

El ID de la política de presupuesto. Cada clave tiene una política de presupuesto independiente.

023aacc1effc4b56bb154bfbec6ba9**

BudgetLimit

integer

El límite de presupuesto, que es igual al número de créditos por paquete.

3000

BudgetUsed

integer

La cuota utilizada.

0

ExpireTime

string

La hora de vencimiento.

La hora se expresa en el estándar ISO 8601 en la zona horaria UTC (formato: AAAA-MM-DDTHH:mm:ssZ).

2025-06-25T09:37:10Z

Active

boolean

Indica si la clave está activa.

true

Expired

boolean

Indica si la clave ha vencido.

false

Ejemplos

Respuesta exitosa

JSON Formato

{
  "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",
      "ApiKeyStatus": "Active",
      "Status": "Enabled",
      "GmtCreated": "2024-10-16 16:46:20\n",
      "GmtModified": "2026-01-04T16:09:29+08:00",
      "Description": "myapp",
      "ApiKeyMd5": "0769a11c2d474f96fbb527f8e273d3de",
      "BudgetPolicyId": "023aacc1effc4b56bb154bfbec6ba9**",
      "BudgetLimit": 3000,
      "BudgetUsed": 0,
      "ExpireTime": "2025-06-25T09:37:10Z",
      "Active": true,
      "Expired": false
    }
  ]
}

Códigos de error

Consulte Códigos de error para ver la lista completa.

Notas de la versión

Consulte Notas de la versión para ver la lista completa.