通过指定的实例ID查看实例详情。
接口说明
方法
GET
URI
/openapi/ha3/instances/{instanceId}
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
searchengine:GetInstance |
get |
*Instance
|
无 | 无 |
请求语法
GET /openapi/ha3/instances/{instanceId} HTTP/1.1请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| instanceId |
string |
是 |
实例 ID。 |
ha-cn-pl32rf0**** |
请求示例
GET /openapi/ha3/instances/ha3-cn-xxxxxx
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
Schema of Response |
||
| result |
object |
返回结果 |
|
| description |
string |
实例描述 |
测试实例 |
| resourceGroupId |
string |
资源组 ID |
rg-aekzjvw24**** |
| expiredTime |
string |
到期时间 |
024-05-21 16:49:31.0 |
| commodityCode |
string |
商品 code |
opensearch_ha3post_public_cn |
| instanceId |
string |
资源一级 ID |
ha-cn-pl32rf0**** |
| createTime |
string |
创建时间 |
2022-06-17T02:01:26Z |
| lockMode |
string |
锁定状态 |
Unlock |
| chargeType |
string |
付费类型 |
POSYPAY |
| updateTime |
string |
更新时间 |
024-05-21 16:49:31.0 |
| inDebt |
boolean |
是否欠费 |
false |
| status |
string |
实例状态阶段
|
INIT |
| tags |
array<object> |
标签。 |
|
|
object |
标签。 |
||
| key |
string |
标签键 |
opensearch |
| value |
string |
标签值 |
opensearch |
| edition |
string |
实例版本 -vector: 向量检索版 -engine:召回引擎版 |
vector |
| userName |
string |
用户名 |
admin |
| version |
string |
引擎版本号 |
ha3_3.10.0 |
| bsVersion |
string |
bs 版本号 |
bs_3.13.2 |
| noQrs |
boolean |
是否是单节点实例 |
false |
| newMode |
boolean |
是否为新版本控制台页面 |
true |
| network |
object |
网络搜索引擎实例信息 |
|
| vSwitchId |
string |
虚拟交换机 id |
vsw-bp11ldcf59q2n**** |
| vpcId |
string |
vpc 网络 id |
vpc-wz9axk41d9vff**** |
| endpoint |
string |
网关接入点。 |
ha-cn-35t3r****.ha.aliyuncs.com |
| publicEndpoint |
string |
公网域名 |
ha-cn-35t3ni****.public.ha.aliyuncs.com |
| allow |
string |
公网域名白名单 |
127.0.0.1 |
| spec |
object |
节点规格 |
|
| qrsResource |
object |
查询节点规格 |
|
| category |
string |
机型 -local_ssd:本地 SSD 盘型 -cloud: 云盘型 |
local_ssd |
| cpu |
integer |
CPU 核数。 |
2 |
| mem |
integer |
内存，单位：G。 |
10 |
| disk |
integer |
节点存储空间大小，单位：GB。 |
100 |
| nodeCount |
integer |
节点数量 |
1 |
| searchResource |
object |
数据节点规格 |
|
| category |
string |
机型 -local_ssd:本地 SSD 盘型 -cloud: 云盘型 |
local_ssd |
| cpu |
integer |
CPU 核数。 |
2 |
| mem |
integer |
内存，单位：G。 |
10 |
| disk |
integer |
节点存储空间大小，单位：GB。 |
100 |
| nodeCount |
integer |
节点数量 |
1 |
| zoneCount |
integer |
可用区数量 |
1 |
| requestId |
string |
请求 ID |
E7B7D598-B080-5C8E-AA35-D43EC0D5F886 |
返回示例
正常返回示例
{
"result":
{
"inDebt": false,
"lockMode": "Unlock",
"trFreeUrl": "",
"chargeType": "POSTPAY",
"edition": "vector",
"description": "ha-cn-vkl3rgrfc01",
"updateTime": "2024-05-30 10:52:00.0",
"userName": "admin",
"version": "vector_service_1.2.2",
"spec":
{
"qrsResource":
{
"category": "local_ssd",
"cpu": 2,
"mem": 8,
"disk": 100,
"nodeCount": 0
},
"searchResource":
{
"category": "local_ssd",
"cpu": 2,
"mem": 16,
"disk": 100,
"nodeCount": 1
}
},
"network":
{
"vSwitchId": "vsw-bp16qw5mbrzx66lv4n0m2",
"vpcId": "vpc-bp1956duqqe2lm2lvqjf1",
"endpoint": "ha-cn-vkl3rgrfc01.ha.aliyuncs.com"
},
"tags":
[
{
"value": "rg-acfmv2hk2jpsxia",
"key": "acs:rm:rgId"
}
],
"noQrs": true,
"instanceId": "ha-cn-vkl3rgrfc01",
"createTime": "2024-05-30 10:50:33.0",
"commodityCode": "opensearch_ha3post_public_cn",
"resourceGroupId": "rg-acfmv2hk2jpsxia",
"newMode": true,
"status": "READY"
},
"requestId": "B916FBC8-DF19-1D12-A72F-61AFFDD871AD"
}
异常返回示例
{
"requestId": "BD1EA715-DF6F-06C2-004C-C1FA0D3A9820",
"httpCode": 404,
"code": "App.NotFound",
"message": "App not found"
}
示例
正常返回示例
JSON格式
{
"result": {
"description": "测试实例",
"resourceGroupId": "rg-aekzjvw24****",
"expiredTime": "024-05-21 16:49:31.0",
"commodityCode": "opensearch_ha3post_public_cn",
"instanceId": "ha-cn-pl32rf0****",
"createTime": "2022-06-17T02:01:26Z",
"lockMode": "Unlock",
"chargeType": "POSYPAY",
"updateTime": "024-05-21 16:49:31.0",
"inDebt": false,
"status": "INIT",
"tags": [
{
"key": "opensearch",
"value": "opensearch"
}
],
"edition": "vector",
"userName": "admin",
"version": "ha3_3.10.0",
"bsVersion": "bs_3.13.2",
"noQrs": false,
"newMode": true,
"network": {
"vSwitchId": "vsw-bp11ldcf59q2n****\n",
"vpcId": "vpc-wz9axk41d9vff****\n",
"endpoint": "ha-cn-35t3r****.ha.aliyuncs.com\n",
"publicEndpoint": "ha-cn-35t3ni****.public.ha.aliyuncs.com\n",
"allow": "127.0.0.1\n"
},
"spec": {
"qrsResource": {
"category": "local_ssd",
"cpu": 2,
"mem": 10,
"disk": 100,
"nodeCount": 1
},
"searchResource": {
"category": "local_ssd",
"cpu": 2,
"mem": 10,
"disk": 100,
"nodeCount": 1
}
},
"zoneCount": 1
},
"requestId": "E7B7D598-B080-5C8E-AA35-D43EC0D5F886"
}错误码
访问错误中心查看更多错误码。
变更历史
更多信息，参考变更详情。