获取实例详情
更新时间：2024-03-15
请求说明
- 查询单个实例的详细信息。
- 当前版本为v2。
请求结构
GET /v2/instance/{instanceId} HTTP/1.1
Host: redis.{region}.baidubce.com
Authorization: authorization string请求头域
除公共头域外，无其它特殊头域。
请求参数
| 参数名称 | 类型 | 是否必须 | 参数位置 | 描述 |
|---|---|---|---|---|
| instanceId | String | 是 | URL参数 | 待查询的实例ID |
返回头域
除公共头域，无其它特殊头域。
返回参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| instanceId | String | 实例ID |
| instanceName | String | 实例名称 |
| instanceStatus | String | 实例状态 |
| clusterType | String | 引擎类型为Redis，取值： 企业版集群: “cluster” 主从:“master_slave” |
| engine | String | 引擎类型，redis,memcache,Redis 容量型(原 PegaDB) |
| engineVersion | String | 引擎版本 |
| nodeType | String | 节点规格 |
| storeType | int | 存储类型 0:高性能存储,1:分级存储 |
| shardNum | int | 分片数量 |
| vnetIp | String | 私网IP |
| domain | String | 域名 |
| port | String | 内网端口 |
| instanceCreateTime | Datetime | 实例创建时间 |
| instanceExpireTime | Datetime | 实例到期时间 |
| capacity | Float | 总容量，单位GB |
| usedCapacity | Double | 已用容量，单位GB |
| paymentTiming | String | 付费方式 包年包月：Prepaid，按量付费：Postpaid |
| zoneNames | List<String> | 可用区list |
| replicationNum | int | 副本数 |
| replicationInfo | List <ReplicationMap> | 副本信息 |
| diskFlavor | int | 存储容量 |
| enableReadOnly | int | 副本只读开关 |
| vpcId | String | VPC的ID |
| subnets | List<Subnet> | 子网列表 |
| autoRenew | Boolean | 是否自动续费，是：“true”，否：“false” |
| entrance | String | 统一读入口地址。开启统一读入口后生效。 |
Subnet
| 参数名称 | 参数类型 | 参数描述 |
|---|---|---|
| name | String | 子网名 |
| subnetId | String | 子网Id |
| zoneName | String | 子网所在可用区 |
| cidr | String | 子网cidr |
| vpcId | String | 所属vpc的id |
ReplicationMap
| 参数名称 | 参数类型 | 参数描述 | |
|---|---|---|---|
| availabilityZone | String | 可通过调用获取可用区列表接口查询可用区列表。zoneName命名规范是“国家-region-可用区序列"，小写，例如北京可用区A为"cn-bj-a" | |
| subnetId | String | 子网Id | |
| isMaster | Int | 是否是主节点 1代表主 0代表从 |
请求示例
GET /v2/instance/scs-bj-cxisuftlkquj HTTP/1.1
HOST: redis.bj.baidubce.com
Content-Type: application/json
Authorization: bce-auth-v1/0255cb4f78f140728045b551d6a317ec/2018-11-13T05:46:05Z/1800/host/70268ec1d0491c86e67f345ad3aee4cf7f8924dade9b7f3e2f1a95814a00c129返回示例
HTTP/1.1 200 OK
x-bce-request-id: 7869616F-7A68-6977-656E-406261696475
Content-Type: application/json
{
"engine": "redis",
"instanceStatus": "Running",
"domain": "redis.qftampylopsp.scs.bj.bce.qa.sandbox.baidu.com",
"vpcId": "vpc-j1vaxw1cx2mw",
"nodeType": "cache.n1.medium",
"subnets": [
{
"subnetId": "sbn-hvq6kecs1jj6",
"cidr": "192.168.0.0/20",
"name": "系统预定义子网",
"zoneName": "cn-bj-a"
}
],
"instanceId": "scs-bj-zpkrihnhtwca",
"instanceName": "redis-khbr3qqr",
"clusterType": "master_slave",
"paymentTiming": "Postpaid",
"instanceNum": 1,
"vnetIp": "192.168.15.87",
"instanceCreateTime": "2020-11-10T11:31:42Z",
"engineVersion": "6.0",
"capacity": 4,
"storeType": 0,
"zoneNames": [
"cn-bj-a"
],
"replicationNum": 2,
"replicationInfo": [{
"availabilityZone": "cn-bj-a",
"subnetId": "sbn-rvv87cdd0gv9",
"isMaster": 1
}],
"port": 6379,
"usedCapacity": 0
}