全部產品
Search
文件中心

OpenSearch:GetDeployGraph - 展示部署全域概覽

更新時間:Dec 24, 2025

展示部署全域概覽。

介面說明

方法

GET

URI

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

調試

您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊,可以在RAM權限原則語句的Action元素中使用,用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下:

  • 操作:是指具體的許可權點。

  • 存取層級:是指每個操作的存取層級,取值為寫入(Write)、讀取(Read)或列出(List)。

  • 資源類型:是指操作中支援授權的資源類型。具體說明如下:

    • 對於必選的資源類型,用前面加 * 表示。

    • 對於不支援資源級授權的操作,用全部資源表示。

  • 條件關鍵字:是指雲產品自身定義的條件關鍵字。

  • 關聯操作:是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權,操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

searchengine:GetDeployGraph

get

*Instance

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

請求文法

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

路徑參數

名稱

類型

必填

描述

樣本值

instanceId

string

執行個體 ID

ha-cn-pl32rf0****

請求參數

名稱

類型

必填

描述

樣本值

當前API無需請求參數

請求樣本


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

返回參數

名稱

類型

描述

樣本值

object

requestId

string

請求 ID。

E7B7D598-B080-5C8E-AA35-D43EC0D5F886

result

object

返回結果。

{}

graph

object

部署資訊

onlineMaster

array<object>

線上叢集元資訊

object

id

integer

機房 id

1

name

string

線上叢集名稱

ha-cn-pl32rf0****_hz_pre_vpc_domain_1

domainName

string

機房

hz_pre_vpc_domain_1

hippoId

string

資源 id

5377

zoneMetas

array<object>

zone 元資訊列表

object

zone 元資訊

name

string

節點名稱

ha-cn-pl32rf0****_qrs

tag

string

標籤

ha-cn-pl32rf0****_qrs_hz_pre_vpc_domain_1

suezAdminName

string

suez admin 名稱

ha-cn-pl32rf0****_hz_pre_vpc_domain_1

type

string

類型

qrs

domainInfo

string

機房

hz_pre_vpc_domain_1

tableMetas

array<object>

資料來源元資訊

object

tableDeployId

integer

表部署 id

2177

name

string

資料來源名稱

ha-cn-pl32rf0****_test_api

tag

string

標籤

ha-cn-pl32rf0****_test_api_hz_pre_vpc_domain_1

domainName

string

機房

hz_pre_vpc_domain_1

buildDeployId

integer

離線部署 id

1

type

string

資料來源類型

odps

indexMetas

array<object>

索引元資訊列表

object

索引元資訊

name

string

索引名稱

test_api

tag

string

標籤

test_api_hz_pre_vpc_domain_1

domainName

string

機房

hz_pre_vpc_domain_1

tableDeployId

integer

表部署 id

2409

tableName

string

資料來源名稱

ha-cn-pl32rf0****_test_api

zoneName

string

節點名稱

ha-cn-pl32rf0****_qrs

zoneIndexRelation

object

zone 和索引關聯關係列表

array

zone 和索引關聯關係

string

索引關聯集群

general_hz_pre_vpc_domain_1

tableIndexRelation

object

資料來源和索引關聯關係列表

array

資料來源和索引關聯關係

string

索引關聯表

test_api_hz_pre_vpc_domain_1

返回樣本

正確返回 

{

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

        }

樣本

正常返回樣本

JSON格式

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

錯誤碼

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊,參考變更詳情