ListInstances
获取实例列表
服务地址：
华东1（杭州）
输入参数
只看必填
pageNumber指定页码
pageSize指定每页展示条数
instanceId实例id
description通过实例描述称进行过滤
resourceGroupId资源组id
edition实例类型
tags标签
0实例标签
key标签键
value标签值
添加
catalog
database
table
dataSourceType
插件下载了解更多
VS Code 插件
安装插件之前，确保已安装 VS Code安装插件之前，确保已安装 VS Code
Alibaba Cloud Developer ToolkitbetaAlibaba Cloud OpenAPI
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
安 装
JetBrains 插件
安装插件之前，确保已安装 JetBrains IDE安装插件之前，确保已安装 JetBrains IDE
Alibaba Cloud Developer ToolkitbetaAlibaba Cloud OpenAPI
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.
安 装

接口说明

方法

GET

URI

/openapi/ha3/instances

请求语法

GET /openapi/ha3/instances HTTP/1.1

请求参数

字段名称字段详情
pageNumberinteger<int32>

指定页码，默认为：1

示例值:1
pageSizeinteger<int32>

指定每页展示条数，默认为 10，限制:[1-50]

示例值:10
instanceIdstring

实例 id

示例值:ha-cn-pl32rf0****参考取值来源:
    UpdateInstance
    CreateInstance
    CloneSqlInstance
    ExecuteSqlInstance
descriptionstring

通过实例描述称进行过滤，支持模糊匹配。

示例值:问天引擎实例
resourceGroupIdstring

资源组 id。

示例值:rg-aekzgpiswzbksdi
editionstring

实例类型，vector(向量索引版)，engine(召回引擎版)

示例值:vector
tagsarray<object>

标签。

catalogstring
databasestring
参考取值来源:
    ListDatabases
tablestring
dataSourceTypestring
参考取值来源:
    GetDataSourceDeploy

请求说明

| 参数 | 类型 | 是否必需 | 描述 |

| ----------- | ------ | -------- | ------------------------------------------------------------ | | status | String | 否 | 通过实例状态进行过滤。Running, Ready, Initializing,Starting | | expiredTime | Long | 否 | 秒级时间戳，通过过期时间过滤，大于当前时间会过滤出即将过期的实例（不包含已经过期的实例） |

示例

请求示例

GET /openapi/ha3/instances?name=test&instanceId=abc&page=1&size=10

返回参数

字段名称字段详情
resultarray<object>

返回结果

totalCountinteger<int32>

总记录数。

示例值:5
requestIdstring

请求 ID

示例值:89B968E6-1E41-58DF-BB25-5F98ECC759CE

返回说明

返回示例

正常返回示例

{
    "result":
    [
        {
            "inDebt": false,
            "lockMode": "Unlock",
            "trFreeUrl": "",
            "chargeType": "POSTPAY",
            "edition": "engine",
            "description": "测试实例",
            "updateTime": "2024-05-06 14:08:24.0",
            "userName": "admin",
            "version": "ha3_3.10.0",
            "spec":
            {
                "qrsResource":
                {
                    "category": "local_ssd",
                    "cpu": 2,
                    "mem": 8,
                    "disk": 100,
                    "nodeCount": 5
                },
                "searchResource":
                {
                    "category": "local_ssd",
                    "cpu": 2,
                    "mem": 16,
                    "disk": 100,
                    "nodeCount": 4
                }
            },
            "network":
            {
                "vSwitchId": "vsw-bp179zkffzyva26ua8xil",
                "vpcId": "vpc-bp1956duqqe2lm2lvqjf1",
                "endpoint": "ha-cn-35t3ni61z06.ha.aliyuncs.com",
                "publicEndpoint": "ha-cn-35t3ni61z06.public.ha.aliyuncs.com",
                "allow": "127.0.0.1"
            },
            "tags":
            [
                {
                    "value": "rg-acfmv2hk2jpsxia",
                    "key": "acs:rm:rgId"
                }
            ],
            "noQrs": false,
            "instanceId": "ha-cn-35t3ni61z06",
            "createTime": "2024-03-14 10:49:32.0",
            "commodityCode": "opensearch_ha3post_public_cn",
            "resourceGroupId": "rg-acfmv2hk2jpsxia",
            "status": "READY"
        }
    ],
    "requestId": "949FDF5E-6FF6-13B9-A196-59B25F143B7F",
    "totalCount": 1
}

异常返回示例

{
  "requestId": "BD1EA715-DF6F-06C2-004C-C1FA0D3A9820",
  "httpCode": 404,
  "code": "App.NotFound",
  "message": "App not found"
}
变更历史
变更时间变更内容概要操作
2024-07-17
变更返回参数
2024-06-28
删除返回参数
2022-11-30
新增请求参数edition
2022-01-12
新增OpenAPI，获取实例列表