すべてのプロダクト
Search
ドキュメントセンター

:GetDeployGraph

最終更新日:Dec 24, 2025

デプロイメントの概要を表示します。

操作説明

メソッド

GET

URI

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

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

  • アクション:特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。

  • API:アクションを具体的に実行するための API。

  • アクセスレベル:各 API に対して事前定義されているアクセスの種類。有効な値:create、list、get、update、delete。

  • リソースタイプ:アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。

    • リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。

    • リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。

  • 条件キー:サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。

  • 依存アクション:ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

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****

リクエストパラメーター

パラメーター

必須 / 任意

説明

リクエストパラメーターは必要ありません。

リクエスト例

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>

ゾーンメタデータ。

object

name

string

Query Result Searcher (QRS) ワーカーの名前。

ha-cn-pl32rf0****_qrs

tag

string

タグ。

ha-cn-pl32rf0****_qrs_hz_pre_vpc_domain_1

suezAdminName

string

オンラインクラスターとインデックス間の関係を管理するために使用されるサービスの名前。

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

QRS ワーカーの名前。

ha-cn-pl32rf0****_qrs

zoneIndexRelation

object

ゾーンとインデックスの間の関連付け関係。

array

ゾーンとインデックスの間の関連付け関係。

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

        }

成功レスポンス

JSONJSON

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

エラーコード

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。