Todos os produtos
Search
Central de documentação

OpenSearch:GetDeployGraph

Última atualização: Jul 04, 2026

Exibe a visão geral da implantação.

Descrição da operação

Método

GET

URI

/openapi/ha3/instances/{instanceId}/deploy-graph

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

get

*Instance

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

Nenhuma Nenhuma

Sintaxe da solicitação

GET /openapi/ha3/instances/{instanceId}/deploy-graph HTTP/1.1

Parâmetros de caminho

Parâmetro

Tipo

Obrigatório

Descrição

Exemplo

instanceId

string

Não

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/{instanceId}/deploy-graph

Elementos de resposta

Elemento

Tipo

Descrição

Exemplo

object

The response parameters.

requestId

string

O ID da solicitação.

E7B7D598-B080-5C8E-AA35-D43EC0D5F886

result

object

Os resultados retornados.

{}

graph

object

As informações de implantação.

onlineMaster

array<object>

The metadata of online clusters.

object

id

integer

The ID of the data center.

1

name

string

The name of the online cluster.

ha-cn-pl32rf0****_hz_pre_vpc_domain_1

domainName

string

The name of the data center.

hz_pre_vpc_domain_1

hippoId

string

The resource ID.

5377

zoneMetas

array<object>

The zone metadata.

object

name

string

The name of the Query Result Searcher (QRS) worker.

ha-cn-pl32rf0****_qrs

tag

string

The tag.

ha-cn-pl32rf0****_qrs_hz_pre_vpc_domain_1

suezAdminName

string

The name of the service that is used to manage the relationships between online clusters and indexes.

ha-cn-pl32rf0****_hz_pre_vpc_domain_1

type

string

The node type.

qrs

domainInfo

string

The name of the data center.

hz_pre_vpc_domain_1

tableMetas

array<object>

The metadata of data sources.

object

tableDeployId

integer

The deployment ID of the table.

2177

name

string

The name of the data source.

ha-cn-pl32rf0****_test_api

tag

string

The tag.

ha-cn-pl32rf0****_test_api_hz_pre_vpc_domain_1

domainName

string

The name of the data center.

hz_pre_vpc_domain_1

buildDeployId

integer

The ID of the offline deployment.

1

type

string

The type of the data source.

odps

indexMetas

array<object>

The index metadata.

object

name

string

The index name.

test_api

tag

string

The tag.

test_api_hz_pre_vpc_domain_1

domainName

string

The name of the data center.

hz_pre_vpc_domain_1

tableDeployId

integer

The deployment ID of the table.

2409

tableName

string

The name of the data source.

ha-cn-pl32rf0****_test_api

zoneName

string

The name of the QRS worker.

ha-cn-pl32rf0****_qrs

zoneIndexRelation

object

The association relationships between zones and indexes.

array

The association relationships between zones and indexes.

string

The cluster associated with the indexes.

general_hz_pre_vpc_domain_1

tableIndexRelation

object

The association relationships between data sources and indexes.

array

The association relationships between data sources and indexes.

string

The table associated with the indexes.

test_api_hz_pre_vpc_domain_1

Exemplos de respostas

Respostas de sucesso

{

  "requestId": "0A6EB64B-B4C8-CF02-810F-E660812972FF",

  "result": {

    "app": {

      "creator": "74087",

      "gmtModified": 1628151698000,

      "groupId": 596,

      "platformType": "tisplus",

      "description": "qrs",

      "gmtCreate": 1628151698000,

      "isActive": 0,

      "type": "online_group",

      "appStatus": 0,

      "procStatus": 0,

      "isDeleted": 0,

      "name": "search4TestPlugin",

      "id": 5171

    },

    "hippos": [],

    "appGroupName": "biz",

    "name": "search4TestPlugin",

    "availableDeploys": [

      {

        "gmtModified": 1594193012000,

        "virtualDomainList": "6,7,8",

        "platformType": "[\"tisplus\",\"tisplus_khronos\",\"tisplus_dingtalk\"]",

        "description": "pre_et2",

        "groups": "",

        "gmtCreate": 1565752477000,

        "type": "INNET",

        "modules": "[\"online\"]",

        "foundationDetailList": "15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,94",

        "name": "pre_et2",

        "hippoId": "hippo_et2_7u",

        "id": 5

      },

      {

        "gmtModified": 1571642223000,

        "platformType": "[\"tisplus\"]",

        "description": "oc27",

        "groups": "",

        "gmtCreate": 1571642223000,

        "type": "INNET",

        "modules": "[\"online\"]",

        "foundationDetailList": "67,68,69,70,71,72,73,74,75,76,77,78,79",

        "name": "oc27_pre",

        "hippoId": "hippo_7u_oc27",

        "id": 15

      }

    ],

    "graph": {

      "zoneMetas": [

        {

          "suezAdminName": "search4TestPlugin_pre",

          "zoneMetaId": 8509,

          "domainInfo": "pre",

          "mainZone": true,

          "name": "search4TestPlugin_qrs",

          "zoneId": 11379,

          "tag": "search4TestPlugin_qrs_pre",

          "clusterId": 5265,

          "type": "qrs"

        },

        {

          "suezAdminName": "search4TestPlugin_pre",

          "zoneMetaId": 8510,

          "domainInfo": "pre",

          "mainZone": true,

          "name": "test_searcher",

          "zoneId": 11380,

          "tag": "test_searcher_pre",

          "clusterId": 5265,

          "type": "searcher"

        }

      ],

      "tableIndexRelation": {

        "product_sku_pre_ea120": [

          "product_sku_pre_ea120"

        ]

      },

      "onlineMaster": [

        {

          "appId": 5171,

          "domainId": 1,

          "domainName": "pre",

          "gmtCreate": 1628561292000,

          "gmtModified": 1628562498000,

          "hippoGroupId": "20",

          "id": 5265,

          "monitorStatus": 1,

          "name": "search4TestPlugin_pre",

          "processorInfoId": 27789,

          "zkAddr": ""

        }

      ],

      "indexMetas": [

        {

          "tableDeployId": 7366,

          "zoneMetaId": 8510,

          "domainName": "pre_ea120",

          "name": "product_sku",

          "tableId": 6866,

          "tag": "product_sku_pre_ea120",

          "zoneName": "test_searcher",

          "tableName": "product_sku"

        }

      ],

      "offlineMaster": [

        {

          "appId": 5214,

          "domainId": 18,

          "domainName": "pre_ea120",

          "gmtCreate": 1628501863000,

          "gmtModified": 1628501863000,

          "id": 3751,

          "isPublic": 2,

          "monitorStatus": 1,

          "name": "search4_multi_biz_bs",

          "platformType": "tisplus",

          "processorInfoId": 27755,

          "zkAddr": ""

        }

Exemplos

Resposta de sucesso

JSON formato

{
  "requestId": "E7B7D598-B080-5C8E-AA35-D43EC0D5F886",
  "result": {
    "graph": {
      "onlineMaster": [
        {
          "id": 1,
          "name": "\t\nha-cn-pl32rf0****_hz_pre_vpc_domain_1",
          "domainName": "hz_pre_vpc_domain_1",
          "hippoId": "5377"
        }
      ],
      "zoneMetas": [
        {
          "name": "ha-cn-pl32rf0****_qrs",
          "tag": "\t\nha-cn-pl32rf0****_qrs_hz_pre_vpc_domain_1",
          "suezAdminName": "\t\nha-cn-pl32rf0****_hz_pre_vpc_domain_1",
          "type": "qrs",
          "domainInfo": "hz_pre_vpc_domain_1"
        }
      ],
      "tableMetas": [
        {
          "tableDeployId": 2177,
          "name": "ha-cn-pl32rf0****_test_api",
          "tag": "ha-cn-pl32rf0****_test_api_hz_pre_vpc_domain_1",
          "domainName": "hz_pre_vpc_domain_1",
          "buildDeployId": 1,
          "type": "odps"
        }
      ],
      "indexMetas": [
        {
          "name": "test_api",
          "tag": "test_api_hz_pre_vpc_domain_1",
          "domainName": "hz_pre_vpc_domain_1",
          "tableDeployId": 2409,
          "tableName": "ha-cn-pl32rf0****_test_api",
          "zoneName": "ha-cn-pl32rf0****_qrs"
        }
      ],
      "zoneIndexRelation": {
        "key": [
          "general_hz_pre_vpc_domain_1"
        ]
      },
      "tableIndexRelation": {
        "key": [
          "test_api_hz_pre_vpc_domain_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.