获取实例列表。
接口说明
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| searchengine:ListInstances | List |
|
| 无 |
请求语法
GET /openapi/ha3/instances
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| pageNumber | integer | 否 | 指定页码，默认为：1 | 1 |
| pageSize | integer | 否 | 指定每页展示条数，默认为 10，限制:[1-50] | 10 |
| instanceId | string | 否 | 实例 id | ha-cn-83570439y0n |
| description | string | 否 | 通过实例描述称进行过滤，支持模糊匹配。 | 问天引擎实例 |
| resourceGroupId | string | 否 | 资源组 id。 | rg-aekzgpiswzbksdi |
| edition | string | 否 | 实例类型，vector(向量索引版)，engine(召回引擎版) | vector |
返回参数
返回示例
正常返回示例
{
"requestId": "90D6B8F5-FE97-4509-9AAB-367836C51818",
"result": [
{
"instanceId": "igraph-cn-xxxxxx1",
"spec": {
"password": "passwd",
"searchResource": {
"disk": 50,
"mem": 8,
"cpu": 2,
"nodeCount": 2
},
"instanceName": "testInstance",
"vSwitchId": "vswitch_id_xxx",
"vpcId": "vpc_id_xxx",
"qrsResource": {
"disk": 50,
"mem": 8,
"cpu": 2,
"nodeCount": 2
},
"region": "cn-hangzhou",
"userName": "user"
},
"status": {
"phase": "PENDING",
"instancePhase": "INIT",
"createSuccess": false
}
},
{
"instanceId": "igraph-cn-xxxxxx2",
"spec": {
"password": "passwd",
"searchResource": {
"disk": 50,
"mem": 8,
"cpu": 2,
"nodeCount": 2
},
"instanceName": "testInstance",
"vSwitchId": "vswitch_id_xxx",
"vpcId": "vpc_id_xxx",
"qrsResource": {
"disk": 50,
"mem": 8,
"cpu": 2,
"nodeCount": 2
},
"region": "cn-hangzhou",
"userName": "user"
},
"status": {
"phase": "PENDING",
"instancePhase": "INIT",
"createSuccess": false
}
}
],
"totalCount": 20
}
异常返回示例
{
"requestId": "BD1EA715-DF6F-06C2-004C-C1FA0D3A9820",
"httpCode": 404,
"code": "App.NotFound",
"message": "App not found"
}
示例
正常返回示例
JSON格式
{
"result": [
{
"description": "应急测试",
"resourceGroupId": "rg-aekzgpiswzbksdi",
"expiredTime": "1634885083",
"commodityCode": "\"\"",
"status": "2",
"instanceId": "ha-cn-2r42n8oh001",
"createTime": "2022-06-04T02:03:21Z",
"lockMode": "Unlock",
"chargeType": "PrePaid",
"updateTime": "2018-12-06T11:17:49.0",
"inDebt": false,
"network": {
"vSwitchId": "vsw-bp11ldcf59q2nbwkqgj6z",
"vpcId": "vpc-wz9axk41d9vffoc79x0oe",
"endpoint": "\"\""
},
"tags": [
{
"key": "",
"value": ""
}
]
}
],
"totalCount": 5,
"requestId": "89B968E6-1E41-58DF-BB25-5F98ECC759CE"
}错误码
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|---|---|
| 2022-01-12 | 新增 OpenAPI | 看变更集 |