GetAutoIncrementUsageStatistic - Database Autonomy Service: Central de Documentação do Alibaba Cloud

Consulta o uso de IDs de tabelas de incremento automático.

Descrição da operação

Esta operação é aplicável apenas a instâncias do ApsaraDB RDS for MySQL e clusters do PolarDB for MySQL.
Se você usar um SDK do Alibaba Cloud ou um SDK do Database Autonomy Service (DAS) para chamar esta operação, recomendamos que use a versão mais recente do SDK.
Se você usar um SDK para chamar o DAS, deverá definir a região como cn-shanghai.

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

A tabela abaixo descreve a autorização necessária para chamar esta API. Você pode defini-la em uma política do Resource Access Management (RAM). As colunas da tabela estão detalhadas abaixo:

Ação: As ações que podem ser usadas no elemento Action das instruções de política de permissão do RAM para conceder permissões para executar a operação.
API: A API que você pode chamar para executar a ação.
Nível de acesso: O nível de acesso predefinido concedido para cada API. Valores válidos: create, list, get, update e delete.
Tipo de recurso: O tipo de recurso que suporta autorização para executar a ação. Indica se a ação suporta permissão em nível de recurso. O recurso especificado deve ser compatível com a ação. Caso contrário, a política será ineficaz.
- Para APIs com permissões em nível de recurso, os tipos de recursos obrigatórios são marcados com um asterisco (*). Especifique o Nome de Recurso Alibaba Cloud (ARN) correspondente no elemento Resource da política.
- Para APIs sem permissões em nível de recurso, é exibido como Todos os Recursos. Use um asterisco (*) no elemento Resource da política.
Chave de condição: As chaves de condição definidas pelo serviço. A chave permite controle granular, aplicando-se somente a ações ou a ações associadas a recursos específicos. Além das chaves de condição específicas do serviço, o Alibaba Cloud fornece um conjunto de chaves de condição comuns aplicáveis a todos os serviços compatíveis com RAM.
Ação dependente: As ações dependentes necessárias para executar a ação. Para concluir a ação, o usuário RAM ou a função RAM deve ter permissões para executar todas as ações dependentes.

Ação

Nível de acesso

Tipo de recurso

Chave de condição

Ação dependente

hdm:GetAutoIncrementUsageStatistic

none

*All Resource

*

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
InstanceId	string	Sim	O ID da instância.	rm-2ze8g2am97624****
DbNames	string	Não	O nome do banco de dados. Se você especificar um banco de dados, a operação consultará o uso de IDs de tabelas de incremento automático no banco de dados especificado. Caso contrário, a operação consultará o uso de IDs de tabelas de incremento automático em todos os bancos de dados da instância. Nota Especifique o valor do parâmetro como um array JSON, como ['db1','db2']. Separe vários nomes de bancos de dados com vírgulas (,).	['db1','db2']
RatioFilter	number	Sim	O limite de uso de IDs de incremento automático. Somente o uso que excede o limite é retornado. Os valores válidos são decimais que variam de 0 a 1.	0.9
RealTime	boolean	Sim	Especifica se devem ser consultados dados em tempo real. Valores válidos: true: consulta dados em tempo real, exceto os dados gerados nos últimos 10 minutos.** false**: consulta dados gerados nas últimas 2 horas. Se não existirem tais dados, consulta os dados mais recentes.	false

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Os parâmetros de resposta.
Code	integer	O código de status HTTP retornado.	200
Message	string	A mensagem retornada. Nota Se a solicitação for bem-sucedida, Successful será retornado. Caso contrário, uma mensagem de erro, como um código de erro, será retornada.	Successful
Data	object	Os dados retornados.
Finish	boolean	Indica se a tarefa está concluída. Valores válidos: true false	false
Timestamp	integer	O horário em que a solicitação foi feita. Este valor é um timestamp UNIX que representa o número de milissegundos decorridos desde 1 de janeiro de 1970, 00:00:00 UTC.	1697183353000
TaskStatus	string	O status da tarefa. Valores válidos: INIT: A tarefa está sendo inicializada. RUNNING: A tarefa está sendo executada. SUCCESS: A tarefa foi bem-sucedida. FAIL: A tarefa falhou.	INIT
ErrorInfo	string	A mensagem de erro retornada se a tarefa falhar.	the given database name list invalid, none of the database names in the list exist on the instance
AutoIncrementUsageList	array<object>	Os detalhes de uso de IDs de incremento automático.
	object
DbName	string	The database name.	db01
TableName	string	The table name.	test_table
ColumnName	string	The column name.	id
AutoIncrementCurrentValue	integer	The latest auto-increment ID.	2147483647
MaximumValue	integer	The maximum auto-increment ID that is supported by the current data type.	2147483647
AutoIncrementRatio	number	The usage ratio of auto-increment IDs.	1
RequestId	string	O ID da solicitação.	0A74B755-98B7-59DB-8724-1321B394****
Success	boolean	Indica se a solicitação foi bem-sucedida. Valores válidos: true false	true

Exemplos

Resposta de sucesso

JSON formato

{
  "Code": 200,
  "Message": "Successful",
  "Data": {
    "Finish": false,
    "Timestamp": 1697183353000,
    "TaskStatus": "INIT",
    "ErrorInfo": "the given database name list invalid, none of the database names in the list exist on the instance",
    "AutoIncrementUsageList": [
      {
        "DbName": "db01",
        "TableName": "test_table",
        "ColumnName": "id",
        "AutoIncrementCurrentValue": 2147483647,
        "MaximumValue": 2147483647,
        "AutoIncrementRatio": 1
      }
    ]
  },
  "RequestId": "0A74B755-98B7-59DB-8724-1321B394****",
  "Success": true
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
400	InvalidParams	The request parameters are invalid.
403	NoPermission	You are not authorized to do this action.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.