Call GetDeployGraph to view the deployment overview - OpenSearch - Alibaba Cloud - OpenSearch

Retrieves the deployment overview for a specified instance.

Operation description

Method

GET

URI

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

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

searchengine:GetDeployGraph

get

*Instance

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

None

Request syntax

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

Path Parameters

Parameter	Type	Required	Description	Example
instanceId	string	No	The instance ID.	ha-cn-pl32rf0****

Request parameters

Parameter

Type

Required

Description

Example

No parameters required.

Sample requests

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

Response elements

Element	Type	Description	Example
	object	The response parameters.
requestId	string	The request ID.	E7B7D598-B080-5C8E-AA35-D43EC0D5F886
result	object	The results returned.	{}
graph	object	The deployment information.
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 manages online cluster and index relationships.	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 relationships between zones and indexes.
	array	The relationships between zones and indexes.
	string	The cluster associated with the indexes.	general_hz_pre_vpc_domain_1
tableIndexRelation	object	The relationships between data sources and indexes.
	array	The relationships between data sources and indexes.
	string	The table associated with the indexes.	test_api_hz_pre_vpc_domain_1

Sample responses

Success responses

{

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

        }

Examples

Success response

JSON format

{
  "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"
        ]
      }
    }
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.