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

Descrição da operação

Método

GET

URI

/openapi/ha3/instances/{instanceId}/data-sources/{dataSourceName}/generations?domainName={domainName}

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

list

*Instance

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

Nenhuma

Sintaxe da solicitação

GET /openapi/ha3/instances/{instanceId}/data-sources/{dataSourceName}/generations 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****
dataSourceName	string	Sim	O nome da fonte de dados.	ha-cn-pl32rf0****_test_api

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
validStatus	boolean	Não	Especifica as versões de índice a serem retornadas. Valores válidos: true (padrão): retorna as versões de índice que estão completas e não expiradas. false: retorna todas as versões de índice.	true
domainName	string	Sim	O data center onde a fonte de dados está implantada.	bj_vpc_domain_1

Exemplos de solicitações

GET /openapi/ha3/instances/ha3_instances_id/data-sources/my_data_source/generations??domainName=pre_domain_1

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
requestId	string	O ID da solicitação.	022F36C7-9FB4-5D67-BEBC-3D14B0984463
result	array<object>	A lista.
	array<object>	O resultado retornado.
generation	integer	O ID da versão de índice completa.	1626143930
createTime	integer	O timestamp gerado quando a compilação do índice foi iniciada.	1626143673
status	string	O status da versão de índice.	STOPPED
buildDeployId	integer	O ID da implantação offline.	122
partition	object	Os shards da versão de índice. O valor é um par chave-valor em que a chave indica o nome do índice e o valor indica o número de shards. O número de shards do valor.
	integer	O número de shards.	1
timestamp	integer	O timestamp inicial a partir do qual os dados incrementais são recuperados.	1626143673
dataDumpRoot	string	O caminho do índice de dump no sistema de arquivos Apsara File Storage for HDFS.	hdfs://opensearch/dump.json

Exemplo de resposta

{
  "requestId": "0A6EB64B-B4C8-CF02-810F-E660812972FF",
  "result": [
    {
      "generationId":1626143930,
      "timestamp":16261436737,
      "createTime":1626143673,
      "status":"STOPPED",
      "partition":{
        "index1":1
      },
      "buildDeployId":122
    },{
      "generationId":1626143930,
      "timestamp":16261435453,
      "createTime":1626143673,
      "status":"STOPPED",
      "partition":{
        "index1":1
      },
      "buildDeployId":122
    }
  ]
}

Exemplos

Resposta de sucesso

JSON formato

{
  "requestId": "022F36C7-9FB4-5D67-BEBC-3D14B0984463",
  "result": [
    {
      "generation": 1626143930,
      "createTime": 1626143673,
      "status": "STOPPED",
      "buildDeployId": 122,
      "partition": {
        "key": 1
      },
      "timestamp": 1626143673,
      "dataDumpRoot": "hdfs://opensearch/dump.json"
    }
  ]
}

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.