All Products
Search
Document Center

OpenSearch:GetDeployGraph

Last Updated:Oct 16, 2024

Displays the overview of the deployment.

Operation description

Method

GET

URI

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

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
searchengine:GetDeployGraphget
  • Instance
    acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}
    none
none

Request syntax

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

Request parameters

ParameterTypeRequiredDescriptionExample
instanceIdstringNo

The instance ID.

ha-cn-7pp2pcna701

Sample requests


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

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

requestIdstring

Id of the request

E7B7D598-B080-5C8E-AA35-D43EC0D5F886
resultobject

The results returned.

graphobject

The deployment information.

onlineMasterarray<object>

The metadata of online clusters.

onlineMasterobject
idlong

The ID of the data center.

1
namestring

The name of the online cluster.

ha-cn-pl32rf0****_hz_pre_vpc_domain_1
domainNamestring

The name of the data center.

hz_pre_vpc_domain_1
hippoIdstring

The resource ID.

5377
zoneMetasarray<object>

The zone metadata.

zoneMetaobject
namestring

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

ha-cn-pl32rf0****_qrs
tagstring

The tag.

ha-cn-pl32rf0****_qrs_hz_pre_vpc_domain_1
suezAdminNamestring

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
typestring

The node type.

qrs
domainInfostring

The name of the data center.

hz_pre_vpc_domain_1
tableMetasarray<object>

The metadata of data sources.

tableMetaobject
tableDeployIdlong

The deployment ID of the table.

2177
namestring

The name of the data source.

ha-cn-pl32rf0****_test_api
tagstring

The tag.

ha-cn-pl32rf0****_test_api_hz_pre_vpc_domain_1
domainNamestring

The name of the data center.

hz_pre_vpc_domain_1
buildDeployIdlong

The ID of the offline deployment.

1
typestring

The type of the data source.

odps
indexMetasarray<object>

The index metadata.

indexMetaobject
namestring

The index name.

test_api
tagstring

The tag.

test_api_hz_pre_vpc_domain_1
domainNamestring

The name of the data center.

hz_pre_vpc_domain_1
tableDeployIdlong

The deployment ID of the table.

2409
tableNamestring

The name of the data source.

ha-cn-pl32rf0****_test_api
zoneNamestring

The name of the QRS worker.

ha-cn-pl32rf0****_qrs
zoneIndexRelationobject

The association relationships between zones and indexes.

array

The association relationships between zones and indexes.

itemstring

The cluster associated with the indexes.

general_hz_pre_vpc_domain_1
tableIndexRelationobject

The association relationships between data sources and indexes.

array

The association relationships between data sources and indexes.

itemstring

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

Sample success responses

JSONformat

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

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2023-08-28The response structure of the API has changedView Change Details
2022-01-12Add OperationView Change Details