查询 OceanBase 代理服务信息。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
oceanbase:DescribeProxyService |
get |
*全部资源
|
无 | 无 |
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| InstanceId |
string |
是 |
OceanBase 集群 ID。 |
ob317v4uif**** |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
请求的返回结果。 |
||
| RequestId |
string |
请求 ID。 |
EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C |
| Data |
object |
数据列表。 |
|
| ProxyClusterId |
string |
代理集群 ID。 |
proxy-3t****zrieasg |
| ProxyMode |
string |
代理模式。 |
shared |
| Zone |
string |
可用区。 |
cn-shanghai-e,cn-shanghai-f |
| UnitSpec |
string |
单元规格。 |
4C8GB |
| UnitNum |
integer |
单元数量。 |
1 |
| CurrentEndpointNum |
integer |
当前地址数。 |
1 |
| EndpointNumQuota |
integer |
地址数量配额。 |
3 |
| CreateTime |
string |
创建时间。 |
2023-07-05T08:23:10Z |
| Status |
string |
代理状态。 |
ONLINE |
| ProxyServiceVersion |
string |
代理服务版本。 |
1.0 |
| ExpireTime |
string |
到期时间。 |
2123-07-05T16:00:00 |
| UnitNumLimit |
integer |
单元数量上限。 |
4 |
| ProxyVersion |
string |
数据库代理的版本。 |
4.3.1.0-xxxxxxxxx |
| DeployMode |
string |
||
| ServerNumLimit |
integer |
节点数量上限值 |
|
| AllowModifyServerNum |
boolean |
true：允许修改，且显示当前节点数量 false：不允许修改，且不显示当前节点数量 |
|
| SharedUnitNumLimit |
integer |
K8S 共享模式代理服务的单元数量上限 |
|
| ExclusiveUnitNumLimit |
integer |
K8S 独占模式代理服务的单元数量上限 |
示例
正常返回示例
JSON格式
{
"RequestId": "EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C",
"Data": {
"ProxyClusterId": "proxy-3t****zrieasg",
"ProxyMode": "shared",
"Zone": "cn-shanghai-e,cn-shanghai-f",
"UnitSpec": "4C8GB",
"UnitNum": 1,
"CurrentEndpointNum": 1,
"EndpointNumQuota": 3,
"CreateTime": "2023-07-05T08:23:10Z",
"Status": "ONLINE",
"ProxyServiceVersion": "1.0",
"ExpireTime": "2123-07-05T16:00:00",
"UnitNumLimit": 4,
"ProxyVersion": "4.3.1.0-xxxxxxxxx",
"DeployMode": "",
"ServerNumLimit": 0,
"AllowModifyServerNum": true,
"SharedUnitNumLimit": 0,
"ExclusiveUnitNumLimit": 0
}
}错误码
访问错误中心查看更多错误码。
变更历史
更多信息，参考变更详情。