# 查询指定实例 - ShowInstance #### 功能介绍 通过实例ID查询实例的详细信息。 #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-dcs/api-call-process.html)。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-dcs/api-grant-policy.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | dcs:instance:get | Read | instance \* | - g:EnterpriseProjectId - g:ResourceTag/\ | - | - | #### URI GET /v2/{project_id}/instances/{instance_id} 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | instance_id | 是 | String | **参数解释**： 实例ID。可通过DCS控制台进入实例详情界面查看。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | | project_id | 是 | String | **参数解释**： 项目ID。获取方法请参见[获取项目ID](https://support.huaweicloud.com/api-dcs/dcs-api-0312045.html)。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | #### 请求参数 无 #### 响应参数 **状态码：200** 表2响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | vpc_name | String | **参数解释**： VPC的名称。 **取值范围**： 不涉及。 | | charging_mode | Integer | **参数解释**： 付费模式。 **取值范围**： - 0：按需计费。 - 1：包年/包月计费。 | | vpc_id | String | **参数解释**： Redis缓存实例所在的虚拟私有云ID。 **取值范围**： 不涉及。 | | user_name | String | **参数解释**： 实例所在的用户名。 **取值范围**： 不涉及。 | | created_at | String | **参数解释**： 完成创建时间。格式为：2017-03-31T12:24:46.297Z。 **取值范围**： 不涉及。 | | description | String | **参数解释**： 实例描述。 **取值范围**： 不涉及。 | | security_group_id | String | **参数解释**： Redis缓存实例绑定的安全组ID。 **取值范围**： 不涉及。 | | security_group_name | String | **参数解释**： 租户安全组名称。 **取值范围**： 不涉及。 | | max_memory | Integer | **参数解释**： 总内存，单位：MB。 **取值范围**： 不涉及。 | | used_memory | Integer | **参数解释**： 已使用的内存，单位：MB。 **取值范围**： 不涉及。 | | capacity | Integer | **参数解释**： 缓存实例的容量，单位：GB。 **取值范围**： 不涉及。 | | capacity_minor | String | **参数解释**： 小于1GB规格缓存实例的容量，单位：GB。 **取值范围**： 不涉及。 | | 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 | **参数解释**： Redis缓存实例绑定的子网ID。 **取值范围**： 不涉及。 | | subnet_name | String | **参数解释**： 子网名称。 **取值范围**： 不涉及。 | | subnet_cidr | String | **参数解释**： 子网网段。 **取值范围**： 不涉及。 | | engine_version | String | **参数解释**： 缓存版本。 **取值范围**： - 3.0 - 4.0 - 5.0 - 6.0 - 7.0 当缓存引擎为Memcached时，取值为空。 | | order_id | String | **参数解释**： 订单ID。 **取值范围**： 不涉及。 | | status | String | **参数解释**： 缓存实例的状态。 **取值范围**： 详细状态说明见[缓存实例状态说明](https://support.huaweicloud.com/api-dcs/dcs-api-0312047.html)。 | | 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 | **参数解释**： 实例子状态。 **取值范围**： - normal：正常。 - ClientIpTransOpening：正在开启源IP透传中。 - ClientIpTransClosing：正在关闭源IP透传中。 | | tags | Array of [ResourceTags] objects | **参数解释**： 实例标签键值。 | | cpu_type | String | **参数解释**： 实例CPU类型。 **取值范围**： - x86_64：x86计算 - aarch64：Arm计算 | | enterprise_project_name | String | **参数解释**： 企业项目名称。 **取值范围**： 不涉及。 | | product_type | String | **参数解释**： 产品类型。 **取值范围**： - generic：基础版。 - enterprise：企业版。 | | storage_type | String | **参数解释**： 存储类型。 **取值范围**： - DRAM：内存型。 - SSD：存储型。 | | 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 | **参数解释**： 是否支持慢日志。 **取值范围**： - true：支持。 - false：不支持。 | | 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 | **参数解释**： 运营系统中的规格编码。 **取值范围**： 不涉及。 | | free | String | **参数解释**： 该参数与is_free相同，未启用，返回null。 **取值范围**： 不涉及。 | | is_free | String | **参数解释**： 该参数未启用，返回null。 **取值范围**： 不涉及。 | | libos | Boolean | **参数解释**： 该参数未启用，返回false。 **取值范围**： 不涉及。 | | crr_role | String | **参数解释**： 该参数未启用，返回null。 **取值范围**： 不涉及。 | | active_active | [ActiveActiveInfo] object | **参数解释**： 实例AA多活特性，该参数未启用，返回null。 **取值范围**： 不涉及。 | | task | AnyType | **参数解释**： 实例当前任务。 **取值范围**： 不涉及。 | | proxy_links | Array of [ProxyLink] objects | **参数解释**： 实例proxy节点连接情况，该参数未启用，返回null。 **取值范围**： 不涉及。 | 表3InstanceBackupPolicy | 参数 | 参数类型 | 描述 | |:---|:---|:---| | 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。 **取值范围**： 不涉及。 | 表4BackupPolicyResp | 参数 | 参数类型 | 描述 | |:---|:---|:---| | backup_type | String | **参数解释**： 备份类型。 **取值范围**： - auto：自动备份。 - manual：手动备份。 | | save_days | Integer | **参数解释**： 保留天数，单位：天。由自动备份切换为手动备份时，保留自动备份策略信息。 **取值范围**： 1-7 | | periodical_backup_plan | [BackupPlan] object | **参数解释**： 备份计划。由自动备份切换为手动备份时，保留自动备份策略信息。 **取值范围**： 不涉及。 | 表5BackupPlan | 参数 | 参数类型 | 描述 | |:---|:---|:---| | timezone_offset | String | **参数解释**： 备份的时区。该参数已废弃，没有实际作用。 **取值范围**： 不涉及。 | | backup_at | Array of integers | **参数解释**： 每周的周几开始备份。由自动切换为手动时，保留自动备份策略信息。 **取值范围**： 1-7，分别表示星期一到星期日。 | | period_type | String | **参数解释**： 备份周期类型，目前支持"weekly"。由自动切换为手动时，保留自动备份策略信息。 **取值范围**： weekly：每星期。 | | begin_at | String | **参数解释**： 备份开始执行时间，该时间为UTC时间，例如"00:00-01:00"代表UTC时间0点开始执行备份。只能是整点时间段，间隔时间限定为一个小时。由自动切换为手动时，保留自动备份策略信息。 **取值范围**： 不涉及。 | 表6Features | 参数 | 参数类型 | 描述 | |:---|:---|:---| | support_acl | Boolean | **参数解释**： 实例是否支持ACL。 **取值范围**： - true：是 - false：否 | | support_transparent_client_ip | Boolean | **参数解释**： 实例是否支持客户端IP透传。 **取值范围**： - true：是 - false：否 | | support_ssl | Boolean | **参数解释**： 实例是否支持SSL。 **取值范围**： - true：是 - false：否 | | support_acl_read_policy | Boolean | **参数解释**： 实例是否支持ACL只读路由策略。 **取值范围**： - true：是 - false：否 | | support_audit_log | Boolean | **参数解释**： 实例是否支持审计日志。 **取值范围**： - true：是 - false：否 | 表7DomainNameInfo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | support_public_resolve | Boolean | **参数解释**： 是否开启公网域名解析。 **取值范围**： - true：开启 - false：未开启 | | is_latest_rules | Boolean | **参数解释**： 当前域名是否已为最新。 **取值范围**： - true：是 - false：否 | | zone_name | String | **参数解释**： 域名的区域后缀。 **取值范围**： 不涉及。 | | history_domain_names | Array of [DomainNameEntity] objects | **参数解释**： 历史域名信息。 **取值范围**： 不涉及。 | 表8DomainNameEntity | 参数 | 参数类型 | 描述 | |:---|:---|:---| | domain_name | String | **参数解释**： 实例历史域名。 **取值范围**： 不涉及。 | | is_readonly | Boolean | **参数解释**： 是否只读域名。 **取值范围**： - true：是 - false：否 | 表9ResourceTags | 参数 | 参数类型 | 描述 | |:---|:---|:---| | key | String | **参数解释**： 标签键。 **取值范围**： 不涉及。 | | value | String | **参数解释**： 标签值。 **取值范围**： 不涉及。 | 表10BandwidthInfo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | 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 | **参数解释**： 任务是否运行。 **取值范围**： 不涉及。 | | assured_bandwidth | Integer | **参数解释**： 实例基准带宽，单位：Mbit/s。 **取值范围**： 不涉及。 | | max_bandwidth_for_node | Integer | **参数解释**： 节点最大带宽，单位：Mbit/s。 **取值范围**： 不涉及。 | 表11ActiveActiveInfo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | active_active_status | AnyType | **参数解释**： 实例AA多活状态。 **取值范围**： enabled：可以开启AA多活。 disabled：不可以开启AA多活。 opening：已开启AA多活。 closing：已关闭AA多活。 | | active_cluster_index | AnyType | **参数解释**： 实例AA集群索引。 **取值范围**： 不涉及。 | 表12ProxyLink | 参数 | 参数类型 | 描述 | |:---|:---|:---| | ip | AnyType | **参数解释**： proxy节点ipv4。 **取值范围**： 不涉及。 | | ipv6_ip | AnyType | **参数解释**： proxy节点ipv6。 **取值范围**： 不涉及。 | | az_code | AnyType | **参数解释**： proxy节点所在可用区信息。 **取值范围**： 不涉及。 | | role | AnyType | **参数解释**： proxy节点角色信息。 **取值范围**： 不涉及。 | | domain_name | AnyType | **参数解释**： proxy节点域名信息。 **取值范围**： 不涉及。 | #### 请求示例 ``` 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", "free" : null, "is_free" : null, "libos" : false, "crr_role" : null, "active_active" : null, "task" : "EXTENDING", "proxy_links" : null } ``` #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 查询指定实例成功。 | | 400 | 非法请求。 | | 500 | 内部服务错误。 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-dcs/ErrorCode.html)。