获取gaussdb实例列表 - ListGaussdbs
功能介绍
功能介绍:获取gaussdb实例列表
响应:请求成功返回HTTP 200及响应体。
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,当前API调用无需身份策略权限。
URI
GET /v1/{project_id}/sdg/asset/gaussdb
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 参数解释: 项目ID,标识当前请求所属的华为云项目,可参考获取项目ID相关文档获取 约束限制: 满足正则匹配"^[a-z0-9]{32}$",32位小写字母和数字 取值范围: 长度为32个字符,只能由小写英文字母和数字组成 默认取值: 不涉及 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Auth-Token | 是 | String | 参数解释: 用户Token。通过调用IAM服务查询用户Token接口获取(响应消息头中X-Subject-Token的值) 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| instances | Array of OpenGaussInstance objects | 参数解释: Gauss实例列表 不涉及 取值范围: 不涉及 |
| total_count | Integer | 参数解释: 实例总数 不涉及 取值范围: 不涉及 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| project_id | String | 参数解释: 项目ID 取值范围: 不涉及 |
| id | String | 参数解释: 资源ID,唯一标识 取值范围: 不涉及 |
| name | String | 参数解释: openGauss实例名称 取值范围: 不涉及 |
| status | String | 参数解释: 操作结果状态 取值范围: 不涉及 |
| private_ips | Array of strings | 参数解释: 内网IP列表 取值范围: 不涉及 |
| public_ips | Array of strings | 参数解释: 公网IP列表 取值范围: 不涉及 |
| port | Integer | 参数解释: 端口号 取值范围: 不涉及 |
| type | String | 参数解释: openGauss实例类型 取值范围: 不涉及 |
| region | String | 参数解释: 区域 取值范围: 不涉及 |
| datastore | OpenGaussDatastore object | 参数解释: 数据库信息 取值范围: 不涉及 |
| created | String | 参数解释: 创建时间 取值范围: 不涉及 |
| updated | String | 参数解释: 更新时间,UTC时间格式,格式为yyyy-MM-ddTHH:mm:ssZ 取值范围: 不涉及 |
| db_user_name | String | 参数解释: 数据库用户名 取值范围: 不涉及 |
| vpc_id | String | 参数解释: 虚拟私有云ID 取值范围: 不涉及 |
| subnet_id | String | 参数解释: 子网ID 取值范围: 不涉及 |
| security_group_id | String | 参数解释: 安全组ID 取值范围: 不涉及 |
| flavor_ref | String | 参数解释: 规格编码 取值范围: 不涉及 |
| volume | OpenGaussVolume object | 参数解释: 磁盘信息 取值范围: 不涉及 |
| switch_strategy | String | 参数解释: 切换策略 取值范围: 不涉及 |
| backup_strategy | OpenGaussBackupStrategyFor object | 参数解释: 备份策略 取值范围: 不涉及 |
| maintenance_window | String | 参数解释: 维护窗口 取值范围: 不涉及 |
| nodes | Array of OpenGaussNode objects | 参数解释: 节点列表 取值范围: 不涉及 |
| disk_encryption_id | String | 参数解释: 磁盘加密ID 取值范围: 不涉及 |
| enterprise_project_id | String | 参数解释: 企业项目ID 取值范围: 不涉及 |
| time_zone | String | 参数解释: 实例时区 取值范围: 不涉及 |
| charge_info | OpenGaussChargeInfo object | 参数解释: 计费信息 取值范围: 不涉及 |
| tags | Array of OpenGaussTag objects | 参数解释: 标签列表 取值范围: 不涉及 |
| dsspool_id | String | 参数解释: 专属存储池ID 取值范围: 不涉及 |
| related_instance | OpenGaussRelatedInstance object | 参数解释: 关联实例 取值范围: 不涉及 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| type | String | 参数解释: 数据存储类型 取值范围: 0到1024个字符 |
| version | String | 参数解释: 存储版本 取值范围: 0到1024个字符 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| size | Integer | 参数解释: 大小 取值范围: 0~200 |
| type | String | 参数解释: 卷类型 取值范围: 0到1024个字符 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| keep_days | Integer | 参数解释: 保留天数 取值范围: 不涉及 |
| start_time | String | 参数解释: 备份开始时间窗口,格式为 HH:mm-HH:mm 取值范围: 不涉及 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| availability_zone | String | 参数解释: 可用区 取值范围: 不涉及 |
| id | String | 参数解释: 资源ID,唯一标识 取值范围: 不涉及 |
| name | String | 参数解释: openGauss节点名称 取值范围: 不涉及 |
| role | String | 参数解释: 节点角色 取值范围: 不涉及 |
| status | String | 参数解释: 操作结果状态 取值范围: 不涉及 |
| private_ip | String | 参数解释: 私有IP 取值范围: 不涉及 |
请求示例
获取gaussdb实例列表
/v1/2b31ed5200000ebedb6e570000000000/sdg/asset/gaussdb
响应示例
状态码:200
{
"instances" : [ {
"project_id" : "a1b2c3d4-5e6f-7a8b-9c0d-1e2f3a4b5c6d",
"id" : "0cfd1d3e-2c4a-4d1f-8e2b-9a3c4d5e6f70",
"name" : "gaussdb-instance-01",
"status" : "ACTIVE",
"port" : 8000,
"type" : "Enterprise",
"region" : "cn-north-4",
"private_ips" : [ "192.168.1.10" ],
"public_ips" : [ "10.0.0.1" ],
"datastore" : {
"type" : "GaussDB",
"version" : "3.1"
},
"created" : "2024-01-01T00:00:00Z",
"updated" : "2024-01-01T00:00:00Z",
"db_user_name" : "root",
"vpc_id" : "3a7b8c9d-0e1f-2a3b-4c5d-6e7f8a9b0c1d",
"subnet_id" : "f7e6d5c4-b3a2-1908-7f6e-5d4c3b2a1908",
"security_group_id" : "826314dd-1b5b-4037-b976-5f9b7a17df46",
"flavor_ref" : "db.c6.large.2",
"volume" : {
"size" : 40,
"type" : "SATA"
},
"switch_strategy" : "default",
"backup_strategy" : {
"keep_days" : 7,
"start_time" : "02:00-03:00"
},
"maintenance_window" : "02:00-04:00",
"nodes" : [ {
"availability_zone" : "cn-north-4a",
"id" : "a1b2c3d4-5e6f-7a8b-9c0d-1e2f3a4b5c6d",
"name" : "gaussdb-node-01",
"role" : "master",
"status" : "ACTIVE",
"private_ip" : "192.168.1.10"
} ],
"disk_encryption_id" : "0cfd1d3e-2c4a-4d1f-8e2b-9a3c4d5e6f70",
"enterprise_project_id" : "2b31ed5200000ebedb6e570000000000",
"time_zone" : "UTC",
"charge_info" : {
"charge_mode" : "postPaid",
"is_auto_pay" : "true",
"is_auto_renew" : "true",
"period_num" : 1,
"period_type" : "month"
},
"tags" : [ {
"key" : "env",
"value" : "prod"
} ],
"dsspool_id" : "a1b2c3d4-5e6f-7a8b-9c0d-1e2f3a4b5c6d",
"related_instance" : {
"id" : "f7e6d5c4-b3a2-1908-7f6e-5d4c3b2a1908",
"type" : "Enterprise"
}
} ],
"total_count" : 1
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | 请求已成功 |
错误码
请参见错误码。