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

Obtém as informações de implantação de uma fonte de dados.

Descrição da operação

Método

GET

URI

/openapi/ha3/instances/{instanceId}/data-sources/{dataSourceName}/deploys/{deployName}

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

get

*Instance

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

Nenhuma

Sintaxe da solicitação

GET /openapi/ha3/instances/{instanceId}/data-sources/{dataSourceName}/deploys/{deployName} 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****
deployName	string	Sim	O data center.	vpc_hz_domain_1
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

Nenhum parâmetro necessário.

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
requestId	string	O ID da solicitação.	2AE63638-5420-56DC-BF59-37D8174039A0
result	object	O resultado retornado.
storage	object	As informações da fonte de dados.
endpoint	string	The endpoint of the MaxCompute data source.	http://service.cn-hangzhou.maxcompute.aliyun-inc.com/api
accessKey	string	The AccessKey ID of the MaxCompute data source.	L***p
accessSecret	string	The AccessKey secret of the MaxCompute data source.	5**9a6
project	string	The name of the MaxCompute project.	wireless_1688_personal_rec
partition	string	The partition of the MaxCompute data source. For example: ds=20180102	ds=20220926
table	string	The name of the table in the SARO or MaxCompute data source.	behavior
namespace	string	Information related to SARO.	lazada-campaign-flink
path	string	Information related to HDFS.	/beiming_xobject/dwd_xobjectsandbox__list_create_action_by_new/
ossPath	string	Information related to the OSS data source.	/opensearch/test.json
bucket	string	The OSS bucket.	test-oss-bucket
catalog	string
database	string
tag	string
autoBuildIndex	boolean	Indica se a indexação completa automática está ativada.	true
processor	object	Os parâmetros do processador.
args	string	The startup parameters for the process.	{ "processInfos": [], "groupId": "opensearch", "containerConfigs": [], "priority": { "minor_priority": 0, "major_priority": 64 } }
resource	string	The resource information.	[{ "_bs_role": "processor.*.inc", "priority": { "major_priority": 32, "minor_priority": 0 }, "slotResources": [{ "slotResources": [{ "amount": 200, "name": "cpu" }, { "amount": 8192, "name": "mem" }, { "amount": 0, "name": "T4" }, { "amount": 10, "type": "SCALAR", "name": "disk_ratio_9999" }, { "amount": 20480, "type": "SCALAR", "name": "disk_size_9999" }] }] }]
extend	object	O conteúdo estendido da configuração de campo. A chave pode ser `vector` para campos vetoriais ou `embedding` para campos que requerem embedding.
saro	object	The information about the SARO data source.
path	string	The path of the HDFS data source.	dist-dmj-job/src/main/java
version	string	The version number.	0.6.0
hdfs	object	The HDFS information.
path	string	The path of the HDFS data source.	dist-dmj-job/src/main/java
odps	object	The information about the MaxCompute data source.
partitions	object	The partition information of the data source.
	string	The partition information of the data source.	ds=20220926
oss	object	The OSS information.
path	string	The path of the OSS data source.	oss://opensearch
swift	object	As informações sobre dados incrementais do Swift.
zk	string	The ZooKeeper service.	test-zk
topic	string	The topic.	ha-cn-pl32rf0****_test_api

Exemplos

Resposta de sucesso

JSON formato

{
  "requestId": "2AE63638-5420-56DC-BF59-37D8174039A0",
  "result": {
    "storage": {
      "endpoint": "http://service.cn-hangzhou.maxcompute.aliyun-inc.com/api",
      "accessKey": "L***p",
      "accessSecret": "5**9a6",
      "project": "wireless_1688_personal_rec",
      "partition": "ds=20220926",
      "table": "behavior",
      "namespace": "lazada-campaign-flink",
      "path": "/beiming_xobject/dwd_xobjectsandbox__list_create_action_by_new/",
      "ossPath": "/opensearch/test.json",
      "bucket": "test-oss-bucket",
      "catalog": "",
      "database": "",
      "tag": ""
    },
    "autoBuildIndex": true,
    "processor": {
      "args": "{\n\t\"processInfos\": [],\n\t\"groupId\": \"opensearch\",\n\t\"containerConfigs\": [],\n\t\"priority\": {\n\t\t\"minor_priority\": 0,\n\t\t\"major_priority\": 64\n\t}\n}",
      "resource": "[{\n\t\"_bs_role\": \"processor.*.inc\",\n\t\"priority\": {\n\t\t\"major_priority\": 32,\n\t\t\"minor_priority\": 0\n\t},\n\t\"slotResources\": [{\n\t\t\"slotResources\": [{\n\t\t\t\"amount\": 200,\n\t\t\t\"name\": \"cpu\"\n\t\t}, {\n\t\t\t\"amount\": 8192,\n\t\t\t\"name\": \"mem\"\n\t\t}, {\n\t\t\t\"amount\": 0,\n\t\t\t\"name\": \"T4\"\n\t\t}, {\n\t\t\t\"amount\": 10,\n\t\t\t\"type\": \"SCALAR\",\n\t\t\t\"name\": \"disk_ratio_9999\"\n\t\t}, {\n\t\t\t\"amount\": 20480,\n\t\t\t\"type\": \"SCALAR\",\n\t\t\t\"name\": \"disk_size_9999\"\n\t\t}]\n\t}]\n}]"
    },
    "extend": {
      "saro": {
        "path": "dist-dmj-job/src/main/java",
        "version": "0.6.0"
      },
      "hdfs": {
        "path": "dist-dmj-job/src/main/java"
      },
      "odps": {
        "partitions": {
          "key": "ds=20220926"
        }
      },
      "oss": {
        "path": "oss://opensearch"
      }
    },
    "swift": {
      "zk": "test-zk",
      "topic": "ha-cn-pl32rf0****_test_api"
    }
  }
}

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.