查询所有实例列表

project_id

是

String

项目ID。获取方法请参见获取项目ID。

instance_id

否

String

实例ID。

include_failure

否

String

是否返回创建失败的实例数。 当参数值为“true”时，返回创建失败的实例数。参数值为“false”或者其他值，不返回创建失败的实例数。

include_delete

否

String

是否返回已删除的实例数。 当参数值为“true”时，返回已删除的实例数。参数值为“false”或者其他值，不返回已删除的实例数。

name

否

String

实例名称。

offset

否

Integer

偏移量，表示从此偏移量开始查询， offset大于等于0。

limit

否

Integer

每页显示条数，最小值为1，最大值为1000，若不设置该参数，则为10。

status

否

String

实例状态。详细状态说明见缓存实例状态说明。

name_equal

否

String

是否按照实例名称进行精确匹配查询。

默认为“false”，表示模糊匹配实例名称查询。若参数值为“true”表示按照实例名称进行精确匹配查询。

tags

否

String

根据实例标签键值对进行查询。{key}表示标签键，{value}表示标签值。

如果同时使用多个标签键值对进行查询，中间使用逗号分隔开，表示查询同时包含指定标签键值对的实例。

ip

否

String

连接缓存实例的IP地址。

capacity

否

String

缓存实例的容量（G Byte）。

instance_num

Integer

实例个数。

instances

Array of InstanceListInfo objects

实例的详情数组。

publicip_id

String

Redis缓存实例绑定的弹性IP地址的ID。 该参数暂未开启，字段值为null。

vpc_name

String

VPC的名称。

charging_mode

Integer

计费模式，0表示按需计费。

vpc_id

String

VPC ID。

subnet_id

String

子网ID。

security_group_id

String

安全组ID。

created_at

String

创建时间。格式为：2017-03-31T12:24:46.297Z

updated_at

String

更新时间。格式为：2017-03-31T19:24:46.297Z

enable_ssl

Boolean

该参数暂未启用。

max_memory

Integer

总内存，单位：MB。

used_memory

Integer

已使用的内存，单位：MB。

publicip_address

String

Redis缓存实例绑定的弹性IP地址。 该参数暂未开启，字段值为null。

capacity

Integer

缓存容量（G Byte）。

capacity_minor

String

小规格缓存实例（小于1G）的容量（G Byte）。

order_id

String

订单ID，按需实例时此值为null。

maintain_begin

String

维护时间窗开始时间，为UTC时间，格式为HH:mm:ss。

maintain_end

String

维护时间窗结束时间，为UTC时间，格式为HH:mm:ss。

engine

String

缓存引擎。

engine_version

String

缓存版本。

service_upgrade

Boolean

实例是否存在升级任务。

• true：存在
• false：不存在

no_password_access

String

是否允许免密码访问缓存实例。

• true：该实例无需密码即可访问。
• false：该实例必须通过密码认证才能访问。

service_task_id

String

升级任务的ID。

• 当service_upgrade为true时，为升级任务的ID。
• 当service_upgrade为false时，该参数为空。

ip

String

连接缓存实例的IP地址。如果是集群实例，返回多个IP地址，使用逗号分隔。如：192.168.0.1，192.168.0.2。

access_user

String

通过密码认证访问缓存实例的认证用户名。

instance_id

String

实例ID。

enable_publicip

Boolean

该参数暂未启用。

port

Integer

缓存的端口。

user_id

String

用户id。

user_name

String

用户名。

domain_name

String

实例的域名。

readonly_domain_name

String

实例的只读域名，只有主备实例有该字段。

name

String

实例名称。

spec_code

String

产品规格编码。

status

String

实例状态。详细状态说明见缓存实例状态说明。

tags

Array of ResourceTag objects

实例标签键值。

description

String

实例描述备注

cpu_type

String

实例CPU类型，通常为x86_64或aarch64

az_codes

Array of strings

有资源的可用区编码。

features

Features object

实例支持特性。

sub_status

String

实例子状态。

key

String

标签键。

• 不能为空。
• 对于同一资源键值唯一。
• 长度不超过36个字符。
• 标签的键必须唯一且输入不能为空。

value

String

标签值。

• action为create时必选。action为delete时非必选。
• 长度不超过43个字符。

support_acl

Boolean

是否支持ACL。

• true：是
• false：否

support_transparent_client_ip

Boolean

实例是否支持客户端IP透传。

• true：是
• false：否

support_ssl

Boolean

是否支持SSL。

• true：是
• false：否

support_audit_log

Boolean

是否支持审计日志。

• true: 是
• false: 否

error_msg

String

错误信息。

最大长度：1024

error_code

String

错误码。

最大长度：9

error_ext_msg

String

扩展错误信息（暂未使用，赋值为null）。

最大长度：1024

error_msg

String

错误信息。

最大长度：1024

error_code

String

错误码。

最大长度：9

error_ext_msg

String

扩展错误信息（暂未使用，赋值为null）。

最大长度：1024

error_msg

String

错误信息。

最大长度：1024

error_code

String

错误码。

最大长度：9

error_ext_msg

String

扩展错误信息（暂未使用，赋值为null）。

最大长度：1024

error_msg

String

错误信息。

最大长度：1024

error_code

String

错误码。

最大长度：9

error_ext_msg

String

扩展错误信息（暂未使用，赋值为null）。

最大长度：1024

error_msg

String

错误信息。

最大长度：1024

error_code

String

错误码。

最大长度：9

error_ext_msg

String

扩展错误信息（暂未使用，赋值为null）。

最大长度：1024

200

查询所有实例列表成功。

400

非法请求。

401

认证信息非法。

403

请求被拒绝访问。

404

所请求的资源不存在。

500

内部服务错误。