文档首页/ 分布式缓存服务 DCS/ API参考/ API V2（推荐）/ 生命周期管理/ 查询指定实例

更新时间：2024-12-16 GMT+08:00

在线调试

CLI示例

查看PDF

查询指定实例

功能介绍

通过实例ID查询实例的详细信息。

调用方法

请参见如何调用API。

URI

GET /v2/{project_id}/instances/{instance_id}

表1 路径参数
参数	是否必选	参数类型	描述
instance_id	是	String	实例ID。
project_id	是	String	项目ID。获取方法请参见获取项目ID。

请求参数

无

响应参数

状态码： 200

表2 响应Body参数
参数	参数类型	描述
vpc_name	String	VPC的名称。
charging_mode	Integer	付费模式，0表示按需计费，1表示包年/包月计费。
vpc_id	String	VPC ID。
user_name	String	用户名。
created_at	String	完成创建时间。格式为：2017-03-31T12:24:46.297Z
description	String	实例描述。
security_group_id	String	安全组ID。
security_group_name	String	租户安全组名称。
max_memory	Integer	总内存，单位：MB。
used_memory	Integer	已使用的内存，单位：MB。
capacity	Integer	缓存实例的容量（G Byte）。
capacity_minor	String	小规格缓存实例（小于1G）的容量（G Byte）。
maintain_begin	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_backup_policy	InstanceBackupPolicy object	备份策略，实例类型为主备和集群时支持。
az_codes	Array of strings	实例所在的可用区。返回“可用区Code”
available_zones	Array of strings	实例所在的可用区ID。返回"可用区ID"。
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_version	String	缓存版本。
order_id	String	订单ID。
status	String	缓存实例的状态。详细状态说明见缓存实例状态说明。
domain_name	String	实例的域名。
readonly_domain_name	String	实例的只读域名，只有主备实例有该字段。
enable_publicip	Boolean	Redis 3.0缓存实例是否开启公网访问功能。 true：开启 false：不开启
publicip_id	String	Redis缓存实例绑定的弹性IP地址的id。如果未开启公网访问功能，该字段值为null。
publicip_address	String	Redis缓存实例绑定的弹性IP地址。如果未开启公网访问功能，该字段值为null。
enable_ssl	Boolean	Redis缓存实例开启公网访问功能时，是否选择支持ssl。 true：开启 false：不开启
service_upgrade	Boolean	实例是否存在升级任务。 true：存在 false：不存在
service_task_id	String	升级任务的ID。当service_upgrade为true时，为升级任务的ID。当service_upgrade为false时，该参数为空。
enterprise_project_id	String	企业项目ID。
backend_addrs	String	集群实例的后端服务地址。
features	Features object	实例支持特性。
domain_name_info	DomainNameInfo object	实例域名重建、公网解析操作相关信息。
transparent_client_ip_enable	Boolean	是否开启客户端IP透传。
sub_status	String	实例子状态。
tags	Array of ResourceTag objects	实例标签键值。
cpu_type	String	实例CPU类型，通常为x86_64或aarch64。
enterprise_project_name	String	企业项目名称。
update_at	String	更新时间，形如2022-07-06T09:32:16.502Z
product_type	String	产品类型。取值范围如下： generic：基础版 enterprise：企业版
storage_type	String	存储类型：内存存储。
launched_at	String	启动时间，形如2022-07-06T09:32:16.502Z
cache_mode	String	缓存实例类型。取值范围如下： single：表示单机实例 ha：表示主备实例 cluster：表示cluster集群实例 proxy：表示Proxy集群实例 ha_rw_split：表示读写分离实例
support_slow_log_flag	String	是否支持慢日志。
db_number	Integer	数据库数量。
replica_count	Integer	副本数。
sharding_count	Integer	集群实例分片个数。
bandwidth_info	BandwidthInfo object	带宽信息。
cloud_service_type_code	String	云服务类型编码。
cloud_resource_type_code	String	云资源类型编码。
inquery_spec_code	String	运营系统中的规格编码。

表3 InstanceBackupPolicy
参数	参数类型	描述
backup_policy_id	String	备份策略ID。
created_at	String	创建时间。格式为：2022-04-11T09:45:24.790Z
updated_at	String	更新时间。格式为：2022-04-12T02:22:03.269Z
policy	BackupPolicyResp object	备份策略。
tenant_id	String	租户ID。

表4 BackupPolicyResp
参数	参数类型	描述
backup_type	String	备份类型。 auto：自动备份 manual：手动备份
save_days	Integer	保留天数，单位：天，取值范围：1-7。由自动切换为手动时，保留自动备份策略信息。
periodical_backup_plan	BackupPlan object	备份计划。由自动切换为手动时，保留自动备份策略信息。

表5 BackupPlan
参数	参数类型	描述
timezone_offset	String	备份的时区。该参数已废弃，没有实际作用。
backup_at	Array of integers	每周的周几开始备份，取值1-7，1代表周一，7代表周日。由自动切换为手动时，保留自动备份策略信息。
period_type	String	备份周期类型，目前支持“weekly”。由自动切换为手动时，保留自动备份策略信息。
begin_at	String	备份开始执行时间，该时间为UTC时间，例如“00:00-01:00”代表UTC时间0点开始执行备份。只能是整点时间段，间隔时间限定为一个小时。由自动切换为手动时，保留自动备份策略信息。

表6 Features
参数	参数类型	描述
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: 否

表7 DomainNameInfo
参数	参数类型	描述
support_public_resolve	Boolean	是否开启公网域名解析。 true：开启 false：未开启
is_latest_rules	Boolean	当前域名是否已为最新。 true：是 false：否
zone_name	String	域名的区域后缀。
history_domain_names	Array of DomainNameEntity objects	历史域名信息。

表8 DomainNameEntity
参数	参数类型	描述
domain_name	String	实例历史域名。
is_readonly	Boolean	是否只读域名。 true：是 false：否

表9 ResourceTag
参数	参数类型	描述
key	String	标签键。不能为空。对于同一资源键值唯一。长度不超过36个字符。标签的键必须唯一且输入不能为空。
value	String	标签值。 action为create时必选。action为delete时非必选。长度不超过43个字符。

**表10** BandwidthInfo
参数	参数类型	描述
begin_time	Long	临时扩容开始时间。
end_time	Long	临时扩容结束时间。
current_time	Long	当前时间。
bandwidth	Integer	当前带宽，单位为Mbit/s。
next_expand_time	Long	下一个扩容时间。
expand_count	Integer	扩容数量。
expand_effect_time	Long	临时扩容时间间隔。
expand_interval_time	Long	下一次可以扩容间隔时间。
max_expand_count	Integer	最大扩容数量。
task_running	Boolean	任务是否运行。

请求示例

GET https://{dcs_endpoint}/v2/{project_id}/instances/{instance_id}

响应示例

状态码： 200

查询指定实例成功。

{
  "publicip_id" : null,
  "vpc_name" : "dcs-beta",
  "charging_mode" : 0,
  "enterprise_project_name" : "default",
  "vpc_id" : "5e37b3be-950a-48e1-b498-65b63d336481",
  "user_name" : "clouduser",
  "created_at" : "2022-08-29T08:53:47.319Z",
  "description" : null,
  "cache_mode" : "ha",
  "security_group_id" : "securityGroupId",
  "enable_ssl" : false,
  "max_memory" : 128,
  "publicip_address" : null,
  "capacity" : 0,
  "maintain_begin" : "18:00:00",
  "engine" : "Redis",
  "maintain_end" : "19:00:00",
  "capacity_minor" : ".125",
  "service_upgrade" : false,
  "subnet_name" : "dcs-beta",
  "no_password_access" : "true",
  "service_task_id" : null,
  "ip" : "192.168.0.251",
  "subnet_cidr" : "192.168.0.0/24",
  "used_memory" : 2,
  "security_group_name" : "securityGroupId",
  "instance_backup_policy" : null,
  "az_codes" : [ "xx-xxxxx-xx" ],
  "available_zones" : [ "d539378ec1314c85b76fefa3f7071458" ],
  "access_user" : null,
  "enterprise_project_id" : "0",
  "instance_id" : "a4c545cd-10b2-4efc-b0ab-a9b554ca0621",
  "enable_publicip" : false,
  "port" : 6379,
  "user_id" : "d53977d1adfb49c5b025ba7d33a13fd7",
  "domain_name" : "redis-a4c545cd-10b2-4efc-b0ab-a9b554ca0621.dcs.example.com",
  "name" : "dcs-billing",
  "spec_code" : "redis.ha.xu1.tiny.r2.128",
  "subnet_id" : "a4112635-3ec0-471c-95c3-5cf49b9533af",
  "engine_version" : "5.0",
  "order_id" : null,
  "status" : "RUNNING",
  "features" : {
    "support_acl" : true,
    "support_transparent_client_ip" : true,
    "support_ssl" : false,
    "support_audit_log" : false
  },
  "domain_name_info" : {
    "support_public_resolve" : true,
    "is_latest_rules" : true,
    "zone_name" : "dcs.example.com",
    "history_domain_names" : null
  },
  "transparent_client_ip_enable" : true,
  "sub_status" : "normal",
  "cpu_type" : "x86_64",
  "cloud_service_type_code" : "hws.service.type.dcs",
  "cloud_resource_type_code" : "hws.resource.type.dcs3",
  "inquery_spec_code" : "redis.ha.xu1.tiny.r2.128"
}

状态码

状态码	描述
200	查询指定实例成功。
400	非法请求。
500	内部服务错误。

错误码

请参见错误码。

父主题：生命周期管理

上一篇：批量删除实例

下一篇：删除实例

意见反馈

文档内容是否对您有帮助？

有帮助没帮助

提供反馈

提交成功！非常感谢您的反馈，我们会继续努力做到更好！您可在我的云声建议查看反馈及问题处理状态。

系统繁忙，请稍后重试

在使用文档中是否遇到以下问题

内容与产品页面不一致

内容不易理解

缺失示例代码

步骤不可操作

搜不到想要的内容

缺少最佳实践

意见反馈（选填）

0/500

请至少选择一项反馈信息并填写问题反馈

字符长度不能超过500

直接提交取消

如您有其它疑问，您也可以通过华为云社区问答频道来与我们联系探讨

智能客服提问云社区提问

查询指定实例

功能介绍

调用方法

URI

请求参数

响应参数

请求示例

响应示例

状态码

错误码

相关文档

意见反馈

文档内容是否对您有帮助？

7*24

备案

专业服务

退订

建议反馈

售前咨询热线