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

Descrição da operação

Método

GET

URI

/openapi/ha3/instances/{instanceId}/data-sources

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:ListDataSources

list

*Instance

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

Nenhuma

Sintaxe da solicitação

GET /openapi/ha3/instances/{instanceId}/data-sources 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****

Parâmetros da solicitação

Parâmetro

Tipo

Obrigatório

Descrição

Exemplo

Nenhum parâmetro necessário.

Exemplos de solicitações

GET /openapi/ha3/instances/ha3_instances_id/data-sources

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	The response parameters.
requestId	string	O ID da solicitação.	93A9E542-8CF8-5BA6-99AB-94C0FE520429
result	array<object>	Os resultados retornados.
	object	A lista de informações das fontes de dados.
name	string	O nome da fonte de dados.	ha-cn-pl32rf0****_test_api
type	string	O tipo da fonte de dados.	odps
domain	string	O data center no qual a fonte de dados está implantada.	vpc_hz_domain_1
indexes	array	Os índices.
	string	O índice da fonte de dados.	index1
lastFulTime	integer	O horário em que os dados completos da fonte de dados foram consultados pela última vez.	1718787785
status	string	O status da fonte de dados. Valores válidos: new: A fonte de dados está sendo criada. publish: A fonte de dados está no estado normal. trash: A fonte de dados está sendo excluída.	new

Exemplo de resposta.

Resposta correta

{
  "requestId": "0A6EB64B-B4C8-CF02-810F-E660812972FF",
  "result": [
    {
      "name": "data_source_name",
      "type": "odps",
      "domain": "test",  // Implantação offline
      "indexes": [
        "index1",
        "index2"
      ],
      "partitions": [
        "ds=2020"
        "ds=2021"
      ],
      "lastFullTime": 1628502036000,
      "config":{
        "accessKey": "xxx",
        "accessSecret": "xxxs",
        "project":"xxxx",
        "table":"xxx",
        "partition":"xxxx"
      },
      "autoBuildIndex": true,
      "status": "new"	   // new: Criando; publish: normal; trash: Excluindo
    },
    {
      "name": "data_source_name",
      "type": "odps",
      "domain": "test",  // Implantação offline      
      "indexes": [
        "index1",
        "index2"
      ],
      "partitions": [
        "ds=2020"
        "ds=2021"
      ],
      "lastFullTime": 1628502036000,
      "config":{
        "accessKey": "xxx",
        "accessSecret": "xxxs",
        "project":"xxxx",
        "table":"xxx",
        "partition":"xxxx"
      },
      "autoBuildIndex": true,
      "status": "new"   // new: Criando; publish: normal; trash: Excluindo
    }
  ]
}

Exemplos

Resposta de sucesso

JSON formato

{
  "requestId": "93A9E542-8CF8-5BA6-99AB-94C0FE520429",
  "result": [
    {
      "name": "ha-cn-pl32rf0****_test_api",
      "type": "odps",
      "domain": "vpc_hz_domain_1",
      "indexes": [
        "index1"
      ],
      "lastFulTime": 1718787785,
      "status": "new"
    }
  ]
}

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.