GetDatabaseSchema - OpenSearch: Central de Documentação do Alibaba Cloud

Descrição da operação

Método\n\n`java\nGET\n`\n\n### URI\n\n`java\n/openapi/ha3/instances/{instanceId}/sql-studio/databases/{database}/tables/{tableName}/schema\n`

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

searchengine:GetDatabaseSchema

get

*Instance

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

Nenhuma

Sintaxe da solicitação

GET /openapi/ha3/instances/{instanceId}/sql-studio/databases/{database}/tables/{tableName}/schema HTTP/1.1

Parâmetros de caminho

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
instanceId	string	Sim	O ID da instância.	ha-cn-pl32rf0****
database	string	Sim	O nome do banco de dados.	general
tableName	string	Sim	O nome da tabela.	graph_index_summary_

Parâmetros da solicitação

Parâmetro

Tipo

Obrigatório

Descrição

Exemplo

Nenhum parâmetro necessário.

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
requestId	string	O ID da solicitação.	022F36C7-9FB4-5D67-BEBC-3D14B0984463
result	array<object>	O resultado.
	array<object>	O resultado.
fieldName	string	O nome do campo.	id
fieldType	string	O tipo do campo.	STRING
indexName	string	O nome do índice.	test_tusou_v2
indexType	string	O tipo do índice.	NUMBER
fieldTypeDetail	object	Os detalhes do tipo do campo.	FT_UINT64

Exemplos

Resposta de sucesso

JSON formato

{
  "requestId": "022F36C7-9FB4-5D67-BEBC-3D14B0984463",
  "result": [
    {
      "fieldName": "id",
      "fieldType": "STRING",
      "indexName": "test_tusou_v2",
      "indexType": "NUMBER",
      "fieldTypeDetail": {
        "test": "test",
        "test2": 1
      }
    }
  ]
}

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.