查询 OceanBase 集群列表信息。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
当前API暂无授权信息透出。
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
InstanceId | string | 否 | OceanBase 集群 ID。 | ob317v4uif**** |
ResourceGroupId | string | 否 | 资源组 ID 信息。 如果不填写,返回全部资源。 | group1 |
PageSize | integer | 否 | 分页查询时设置的每页行数。
| 10 |
PageNumber | integer | 否 | 分页查询的页码。
| 1 |
InstanceName | string | 否 | OceanBase 集群名称。 长度为 1~20 个英文或中文字符。 如未指定该参数,默认值为集群的 InstanceId。 | ob4prod |
SearchKey | string | 否 | 根据实例 ID、实例名称、租户 ID 和租户名称进行模糊搜索。 | pay |
返回参数
示例
正常返回示例
JSON
格式
{
"Instances": [
{
"VpcId": "vpc-8vb8qjrixzovjpy******",
"CommodityCode": "oceanbase_oceanbasepost_public_cn",
"ExpireTime": "2021-10-17T16:00:00Z",
"State": "ONLINE",
"InstanceClass": "14C70G",
"CreateTime": "2021-10-19T07:13:41Z",
"DeployMode": "1-1-1",
"CpuArchitecture": "X86_64、 AARCH64",
"MaintainTime": "19:00Z-20:00Z",
"DeployType": "multiple",
"PayType": "PREPAY",
"DiskSize": "200",
"DiskType": "cloud_essd_pl1",
"InstanceId": "ob317v4uif****",
"ExpireSeconds": 2606682,
"Mem": 70,
"EnableUpgradeNodes": true,
"Cpu": 14,
"AvailableZones": [
"cn-hangzhou-i"
],
"Version": "2.2.77",
"InstanceName": "ob4test",
"Series": "NORMAL",
"UsedDiskSize": 20,
"ResourceGroupId": "group1",
"Resource": {
"Cpu": {
"TotalCpu": 14,
"UsedCpu": 10,
"UnitCpu": 10,
"OriginalTotalCpu": 14
},
"Memory": {
"TotalMemory": 70,
"UsedMemory": 10,
"UnitMemory": 10,
"OriginalTotalMemory": 72
},
"DiskSize": {
"TotalDiskSize": 200,
"UsedDiskSize": 100,
"UnitDiskSize": 200,
"OriginalTotalDiskSize": 200
},
"UnitCount": 1,
"CapacityUnit": {
"MaxCapacityUnit": 4,
"MinCapacityUnit": 1,
"UsedCapacityUnit": 2
}
},
"InstanceType": "CLUSTER",
"InstanceRole": "NORMAL",
"InTempCapacityStatus": false,
"DataDiskAutoScaleConfig": {
"AutoScale": true,
"Upperbound": 16,
"UpperThreshold": 80,
"UpperMergeThreshold": 90,
"MaxDiskSize": 80000,
"ScaleStepInNormal": 50,
"ScaleStepInMerge": 100,
"UpperScaleStrategy": "RAW"
},
"EnableReadOnlyReplicaManagement": true,
"SpecType": ""
}
],
"TotalCount": 2,
"RequestId": "EE205C00-30E4-****-****-87E3A8A2AA0C"
}
错误码
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|---|---|
2024-06-06 | OpenAPI 返回结构发生变更 | 查看变更详情 |
2024-04-15 | OpenAPI 返回结构发生变更 | 查看变更详情 |
2024-02-02 | OpenAPI 返回结构发生变更 | 查看变更详情 |
2023-12-26 | OpenAPI 返回结构发生变更 | 查看变更详情 |
2023-12-07 | OpenAPI 返回结构发生变更 | 查看变更详情 |
2023-11-20 | OpenAPI 返回结构发生变更 | 查看变更详情 |
2023-10-30 | OpenAPI 返回结构发生变更 | 查看变更详情 |
2023-08-21 | OpenAPI 返回结构发生变更 | 查看变更详情 |
2023-07-04 | OpenAPI 返回结构发生变更 | 查看变更详情 |
2022-01-17 | OpenAPI 返回结构发生变更 | 查看变更详情 |