查询所有实例列表
功能介绍
查询租户的缓存实例列表，支持按照条件查询。
URI
GET /v1.0/{project_id}/instances?start={start}&limit={limit}&name={name}&status={status}&id={id}&include_failure={include_failure}
|
参数 |
类型 |
必选 |
说明 |
|---|---|---|---|
|
project_id |
String |
是 |
项目ID。获取方式，参考获取项目ID。 |
|
start |
Integer |
否 |
数据的起始序号，默认起始序号为1。 |
|
limit |
Integer |
否 |
每页显示条数，最小值为1，最大值为2000，若不设置该参数，则为最大显示条数1000。 |
|
name |
String |
否 |
实例名称。 |
|
id |
String |
否 |
实例ID。 |
|
status |
String |
否 |
实例状态。详细状态说明见缓存实例状态说明。 |
|
include_failure |
String |
否 |
是否返回创建失败的实例数。 当参数值为“true”时，返回创建失败的实例数。参数值为“false”或者其他值，不返回创建失败的实例数。 |
示例
GET https://{dcs_endpoint}/v1.0/bd6b78e2ff9e4e47bc260803ddcc7a21/instances?start=1&limit=10&name=&status=&id=&include_failure=true
请求消息
请求参数
无。
请求示例
无。
响应消息
响应参数
|
参数 |
类型 |
说明 |
|---|---|---|
|
name |
String |
实例名称。 |
|
engine |
String |
缓存引擎。 |
|
capacity |
Integer |
缓存容量（G Byte）。 |
|
ip |
String |
连接缓存实例的IP地址。如果是集群实例，返回多个IP地址，使用逗号分隔。如：192.168.0.1，192.168.0.2。 |
|
port |
Integer |
缓存的端口。 |
|
status |
String |
缓存实例的状态。详细状态说明见缓存实例状态说明。 |
|
max_memory |
Integer |
总内存，单位：MB。 |
|
used_memory |
Integer |
已使用的内存，单位：MB。 |
|
instance_id |
String |
实例ID。 |
|
resource_spec_code |
String |
资源规格标识。 例如：
更多规格标识可查看 《分布式缓存服务用户指南》的“实例规格”章节，查找到对应的“产品规格编码”列。 |
|
engine_version |
String |
缓存版本。 |
|
internal_version |
String |
DCS内部版本号。 |
|
charging_mode |
Integer |
收费模式，0表示不计费。 |
|
capacity_minor |
String |
小规格缓存容量（G Byte）。 |
|
vpc_id |
String |
VPC ID。 |
|
vpc_name |
String |
VPC的名称。 |
|
created_at |
String |
创建时间。格式为：2017-03-31T12:24:46.297Z。 |
|
error_code |
String |
实例创建失败或状态异常时的错误码，错误码的说明见错误码。 |
|
user_id |
String |
用户ID。 |
|
user_name |
String |
用户名。 |
|
maintain_begin |
String |
维护时间窗开始时间，格式为hh:mm:ss。 |
|
maintain_end |
String |
维护时间窗结束时间，格式为hh:mm:ss。 |
|
security_group_id |
String |
租户安全组名称。 |
响应示例
{"instances":[
{
"max_memory":2048,
"used_memory":1,
"instance_id":"add1eee3-eaad-4975-a8d7-8cf853460e3d",
"name":"lboka-single-4",
"resource_spec_code":"redis.single.xu1.large.2",
"spec_code":"redis.single.xu1.large.2",
"engine":"Redis",
"engine_version":"4.0",
"internal_version":null,
"charging_mode":0,
"capacity":2,
"capacity_minor":null,
"vpc_id":"9d3938d4-d622-48f3-ab62-23f8ff8b7830",
"vpc_name":null,
"ip":"192.168.1.91",
"domainName":"redis-add1eee3-eaad-4975-a8d7-8cf853460e3d.dcs.com",
"domain_name":"redis-add1eee3-eaad-4975-a8d7-8cf853460e3d.dcs.com",
"readonlyDomainName":null,
"readonly_domain_name":null,
"port":6379,
"status":"RUNNING",
"freeze_scene":null,
"created_at":"2021-04-18T13:36:44.144Z",
"update_at":"2021-04-18T13:37:10.575Z",
"error_code":null,
"user_id":"e96cb82994ef49648c2bfad79455b0ef",
"user_name":"lboka",
"maintain_begin":"02:00:00",
"maintain_end":"06:00:00",
"no_password_access":"false",
"access_user":null,
"enable_publicip":false,
"publicip_id":null,
"publicip_address":null,
"enable_ssl":false,
"service_upgrade":false,
"service_task_id":"",
"security_group_id":null,
"tags":null,
"subnet_id":"fd47ed9c-78a9-44c5-a712-06d251381e04"},
],
"instance_num":1
}
