展示部署全局概览。
接口说明
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| searchengine:GetDeployGraph | Read |
|
| 无 |
请求语法
GET /openapi/ha3/instances/{instanceId}/deploy-graph
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| instanceId | string | 否 | 实例 ID | ha-cn-7pp2pcna701 |
返回参数
返回示例
正确返回
{
"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": 0,
"name": "",
"domainName": "",
"hippoId": ""
}
],
"zoneMetas": [
{
"name": "",
"tag": "",
"suezAdminName": "",
"type": "",
"domainInfo": ""
}
],
"tableMetas": [
{
"tableDeployId": 0,
"name": "",
"tag": "",
"domainName": "",
"buildDeployId": 0,
"type": ""
}
],
"indexMetas": [
{
"name": "",
"tag": "",
"domainName": "",
"tableDeployId": 0,
"tableName": "",
"zoneName": ""
}
],
"zoneIndexRelation": {
"key": [
""
]
},
"tableIndexRelation": {
"key": [
""
]
}
}
}
}错误码
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 | ||
|---|---|---|---|---|
| 2023-08-28 | OpenAPI 返回结构发生变更 | 看变更集 | ||
| ||||
| 2022-01-12 | 新增 OpenAPI | 看变更集 |