DescribeProxyService - 查询代理服务信息_云数据库 OceanBase 版(OceanBase)-阿里云帮助中心

查询 OceanBase 代理服务信息。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
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	long	单元数量。	1
CurrentEndpointNum	long	当前地址数。	1
EndpointNumQuota	long	地址数量配额。	3
CreateTime	string	创建时间。	2023-07-05T08:23:10Z
Status	string	代理状态。	ONLINE
ProxyServiceVersion	string	代理服务版本。	1.0
ExpireTime	string	到期时间。	2123-07-05T16:00:00
UnitNumLimit	long	单元数量上限。	4
ProxyVersion	string	数据库代理的版本。	4.3.1.0-xxxxxxxxx

示例

正常返回示例

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"
  }
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间	变更内容概要	操作

暂无变更历史