获取Lindorm实例列表。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
lindorm:GetLindormInstanceList | Read |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
RegionId | string | 是 | 实例所属的地域 ID,可调用 DescribeRegions 接口获取。 | cn-hangzhou |
QueryStr | string | 否 | 实例名称关键字,可根据该关键字模糊搜索。 | test |
PageNumber | integer | 是 | 指定要查询的页码。 | 1 |
PageSize | integer | 是 | 指定分页查询时每页行数。 | 20 |
ServiceType | string | 否 | 实例类型,取值:
| lindorm |
SupportEngine | integer | 否 | 查询的实例支持的数据引擎类型,取值:
说明
例如:SupportEngine 取值为 15,15=8+4+2+1,表示该实例支持搜索引擎、时序引擎、宽表引擎和文件引擎。SupportEngine 取值为 6,6=4+2,表示该实例支持时序引擎和宽表引擎。
| 15 |
Tag | object [] | 否 | 标签列表。 | |
Key | string | 否 | 标签的键。N 的取值范围:1~20。 说明
可以传入多个标签的键。例如:第一对中的 Key 表示传入第一个标签的键。第二对中的 Key 表示传入第二个标签的键。
| test |
Value | string | 否 | 标签的值。N 的取值范围:1~20。 说明
可以传入多个标签的值。例如:第一对中的 Value 表示传入第一个标签的值。第二对中的 Value 表示传入第二个标签的值。
| 2.2.18 |
ResourceGroupId | string | 否 | 资源组 ID。 | rg-aek3b63arvg27vi |
返回参数
示例
正常返回示例
JSON
格式
{
"RequestId": "1CA1FAFD-E8DC-51C2-AA7E-CA6E2D049BA0",
"PageNumber": 1,
"PageSize": 20,
"Total": 1,
"InstanceList": [
{
"VpcId": "vpc-bp1n3i15v90el48nx****",
"EngineType": "15",
"ExpireTime": "2022-04-26 00:00:00",
"CreateTime": "2021-09-16 14:13:13",
"PayType": "PREPAY",
"AliUid": 0,
"InstanceStorage": "960",
"InstanceId": "ld-bp17pwu1541ia****",
"NetworkType": "vpc",
"ServiceType": "lindorm",
"RegionId": "cn-hangzhou",
"CreateMilliseconds": 1631772842000,
"InstanceAlias": "test",
"ZoneId": "cn-hangzhou-h",
"InstanceStatus": "ACTIVATION",
"ExpiredMilliseconds": 1650902400000,
"EnableStream": true,
"Tags": [
{
"Key": "test",
"Value": "2.2.18"
}
],
"EnableCompute": true,
"ResourceGroupId": "rg-aekzledqeat****",
"EnableMessage": true,
"EnableVector": true,
"EnableLts": true,
"EnableColumn": true
}
]
}
错误码
HTTP status code | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | Instance.IsDeleted | The instance is deleted. | 操作失败,该实例已删除。 |
400 | Instance.IsNotAvailable | The instance is unavailable. | 操作失败,实例不可用。 |
403 | Lindorm.Errorcode.OperationDenied | You are not authorized to operate on the specified resource. | - |
403 | API.Forbidden | The API operation is forbidden in this environment. | 操作失败,当前环境中该API无法使用。 |
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 | ||||||||
---|---|---|---|---|---|---|---|---|---|---|
2024-03-29 | OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更 | 看变更集 | ||||||||
| ||||||||||
2024-02-19 | OpenAPI 错误码发生变更 | 看变更集 | ||||||||
| ||||||||||
2023-11-15 | OpenAPI 错误码发生变更 | 看变更集 | ||||||||
|