实例状态说明
5.1.4 查询指定实例
"result" : "success",
"instance" : "7166cdea-dbad-4d79-9610-7163e6f8b640"
} ] }
状态码
状态码 描述
200 批量删除缓存实例成功。
500 内部服务错误。
400 非法请求。
错误码
请参见错误码。
5.1.4 查询指定实例
功能介绍
通过实例ID查询实例的详细信息。
调试
您可以在API Explorer中调试该接口，并获取该接口关联的CLI示例： hcloud DCS ShowInstance。
URI
GET /v2/{project_id}/instances/{instance_id}
表5-31 路径参数
参数 是否必选 参数类型 描述
instance_id 是 String 实例ID。
project_id 是 String 项目ID
请求参数
无
响应参数
状态码： 200
表5-32 响应 Body 参数
参数 参数类型 描述
vpc_name String VPC的名称。
charging_mod
e Integer 付费模式，0表示按需计费，1表示包年/包月计 费。
vpc_id String VPC ID user_name String 用户名。
created_at String 完成创建时间。格式为：
2017-03-31T12:24:46.297Z description String 实例描述。
security_grou
p_id String 安全组ID。
security_grou
p_name String 租户安全组名称。
max_memory Integer 总内存，单位：MB。
used_memory Integer 已使用的内存，单位：MB。
capacity Integer 缓存实例的容量（G Byte）。
capacity_mino
r String 小规格缓存实例（小于1G）的容量（G Byte）。
maintain_begi
n String 维护时间窗开始时间，为UTC时间，格式为
HH:mm:ss
maintain_end String 维护时间窗结束时间，为UTC时间，格式为 HH:mm:ss
engine String 缓存实例的引擎类型。
no_password_
access String 是否允许免密码访问缓存实例。
● true：该实例无需密码即可访问。
● false：该实例必须通过密码认证才能访问。
ip String 连接缓存实例的IP地址。如果是集群实例，返回 多个IP地址，使用逗号分隔。如：192.168.0.1，
192.168.0.2。
instance_back
up_policy BackupPolicy
object 备份策略，实例类型为主备和集群时支持。
az_codes Array of
strings 实例所在的可用区。返回“可用区Code”
参数 参数类型 描述
access_user String 通过密码认证访问缓存实例的认证用户名。
instance_id String 实例ID。
port Integer 缓存的端口。
user_id String 用户id。
name String 实例名称。
spec_code String 产品规格编码 subnet_id String 子网ID。
subnet_name String 子网名称。
subnet_cidr String 子网网段。
engine_versio
n String 缓存版本。
order_id String 订单ID。
status String 缓存实例的状态。详细状态说明见缓存实例状态
说明]
domain_name String 实例的域名。
readonly_dom
ain_name String 实例的只读域名，只有主备实例有该字段。
enable_publici
p Boolean Redis缓存实例是否开启公网访问功能。
● true：开启
● false：不开启
publicip_id String Redis缓存实例绑定的弹性IP地址的id。 如果未开 启公网访问功能，该字段值为null。
publicip_addr
ess String Redis缓存实例绑定的弹性IP地址。 如果未开启公 网访问功能，该字段值为null。
enable_ssl Boolean Redis缓存实例开启公网访问功能时，是否选择支 持ssl。
● true：开启
● false：不开启 service_upgra
de Boolean 实例是否存在升级任务。
● true：存在
● false：不存在
参数 参数类型 描述 service_task_i
d String 升级任务的ID。
● 当service_upgrade为true时，为升级任务的 ID。
● 当service_upgrade为false时，该参数为空。
enterprise_pro
ject_id String 企业项目ID。
backend_addr
s String 集群实例的后端服务地址。
表5-33 BackupPolicy
参数 参数类型 描述
backup_type String 备份类型。
● auto：自动备份
● manual：手动备份
save_days Integer 当backup_type设置为auto时，该参数为必填。
保留天数，单位：天，取值范围：1-7。
periodical_bac
kup_plan BackupPlan
object 备份计划，当backup_type设置为auto时，该参 数为必填。
表5-34 BackupPlan
参数 参数类型 描述
timezone_offs
et String 备份的时区。取值为-1200 ~+1200之间的时区。
若为空则默认使用DCS-Server节点的当前时区。
backup_at Array of
integers 每周的周几开始备份，取值1-7，1代表周一，7代 表周日。
period_type String 备份周期类型，目前支持“weekly”。
begin_at String 备份执行时间，“00:00-01:00”代表0点开始执 行备份。
请求示例
GET https://{dcs_endpoint}/v2/{project_id}/instances/{instance_id}
响应示例
状态码： 200
查询指定实例成功。
{ "publicip_id" : null, "vpc_name" : "vpc-807d", "charging_mode" : 0,
"enterprise_project_name" : "default",
"vpc_id" : "d1e8008d-8182-4c86-a142-1ae9349bdc64", "user_name" : "r00209145",
"created_at" : "2018-12-11T07:24:18.149Z", "description" : null,
"security_group_id" : "ecefdad9-c8be-42aa-9d5d-9ab46a221240", "enable_ssl" : false,
"max_memory" : 65536, "publicip_address" : null, "capacity" : 64,
"maintain_begin" : "02:00:00", "engine" : "Redis",
"maintain_end" : "06:00:00", "capacity_minor" : null, "service_upgrade" : false, "subnet_name" : "subnet-7e46", "no_password_access" : "true", "service_task_id" : null, "ip" : "192.168.1.48",
"subnet_cidr" : "192.168.1.0/24", "used_memory" : 33,
"security_group_name" : "sg--test-hanwang", "instance_backup_policy" : null,
"az_codes" : [ "cn-north-4a" ], "access_user" : null,
"enterprise_project_id" : "0",
"instance_id" : "979e9a6b-e2f5-4b5d-8e98-fea495ea27a1", "enable_publicip" : false,
"port" : 6379,
"user_id" : "9bfac09d9bcd4eb7bb1465a7bcff815b",
"domain_name" : "redis-979e9a6-dcs-125d.dcs.huaweicloud.com", "name" : "dcs-125d",
"spec_code" : "dcs.cluster",
"subnet_id" : "9b32218f-6389-485a-912e-076fe9df6fa7", "engine_version" : "3.0.7",
"order_id" : null, "status" : "RUNNING"
}