DescribeTairSkvDdbTableSchema - Tair (Redis® OSS-Compatible): Central de Documentação do Alibaba Cloud

Descrição da operação

Esta operação consulta o esquema da tabela e as informações de configuração de uma instância de tabela KV Serverless do Tair.
Você deve especificar o parâmetro InstanceId. Defina este parâmetro com o ID da instância que você deseja consultar.
O parâmetro BackupId especifica o conjunto de backups da tabela a ser consultada.
O pacote de resposta inclui as especificações de tempo de vida (TTL) e a definição detalhada do esquema da tabela.

Para invocar esta operação, consulte os parâmetros de solicitação abaixo.

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

kvstore:DescribeTairSkvDdbTableSchema

get

*DBInstance

acs:kvstore:{#regionId}:{#accountId}:instance/{#instanceId}

Nenhuma

Sintaxe da solicitação

POST  HTTP/1.1

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
InstanceId	string	Sim	O ID da instância a ser consultada.	tt-bp1zxszhcgatnx\\\\\\\\
BackupId	string	Não	O ID do arquivo de backup.	78241****

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Esquema da resposta.
RequestId	string	O ID da solicitação. Para mais informações, consulte os parâmetros comuns.	A1604E1B-6825-1577-BBDA-2A64E8D5F126
Schema	string	As informações do esquema da tabela no formato JSON.	{"attributeDefinitions":[{"attributeType":"S","attributeName":"pk"},{"attributeType":"S","attributeName":"sk"}],"keySchema":[{"attributeName":"pk","keyType":"HASH"},{"attributeName":"sk","keyType":"RANGE"}]}
TtlSpec	string	A propriedade TTL. A alternância das configurações de parâmetros no formato JSON.	{"attributeName":"Expiretime","enabled":true}

{
		"TtlSpec":"{\"attributeName\":\"Expiretime\",\"enabled\":true}",
		"RequestId":"A1604E1B-6825-1577-BBDA-2A64E8D5F126",
		"Schema":"{\"attributeDefinitions\":[{\"attributeType\":\"S\",\"attributeName\":\"pk\"},{\"attributeType\":\"S\",\"attributeName\":\"sk\"}],\"keySchema\":[{\"attributeName\":\"pk\",\"keyType\":\"HASH\"},{\"attributeName\":\"sk\",\"keyType\":\"RANGE\"}]}"
	}

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "A1604E1B-6825-1577-BBDA-2A64E8D5F126",
  "Schema": "{\"attributeDefinitions\":[{\"attributeType\":\"S\",\"attributeName\":\"pk\"},{\"attributeType\":\"S\",\"attributeName\":\"sk\"}],\"keySchema\":[{\"attributeName\":\"pk\",\"keyType\":\"HASH\"},{\"attributeName\":\"sk\",\"keyType\":\"RANGE\"}]}",
  "TtlSpec": "{\"attributeName\":\"Expiretime\",\"enabled\":true}"
}

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.