All Products
Search
Document Center

ApsaraDB for OceanBase:DescribeProxyService

Last Updated:Nov 14, 2025

You can call this operation to query proxy service information of OceanBase Database.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • For mandatory resource types, indicate with a prefix of * .
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
oceanbase:DescribeProxyServiceget
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
InstanceIdstringYes

The ID of the OceanBase cluster.

ob317v4uif****

Response parameters

ParameterTypeDescriptionExample
object

The return result of the request.

RequestIdstring

The ID of the request.

EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C
Dataobject

The data list.

ProxyClusterIdstring

The ID of the proxy cluster.

proxy-3t****zrieasg
ProxyModestring

The proxy mode.

shared
Zonestring

The zone.

cn-shanghai-e,cn-shanghai-f
UnitSpecstring

Thsa config.

4C8GB
UnitNumlong

The number of resource units in the tenant.

1
CurrentEndpointNumlong

The current number of endpoints.

1
EndpointNumQuotalong

The endpoint quota.

3
CreateTimestring

The time when the proxy cluster was created.

2023-07-05T08:23:10Z
Statusstring

The status of the proxy service.

ONLINE
ProxyServiceVersionstring

The version of the proxy service.

1.0
ExpireTimestring

The expiration time.

2123-07-05T16:00:00
UnitNumLimitlong

The maximum number of units.

4
ProxyVersionstring

The version of the database proxy.

4.3.1.0-xxxxxxxxx
DeployModestring

Deployment mode.

share
ServerNumLimitlong

The maximum number of nodes.

0
AllowModifyServerNumboolean

Indicates whether the number of nodes can be changed. Valid values: true and false. The current number of nodes is displayed if the number of nodes can be changed, and is not displayed if otherwise.

true
SharedUnitNumLimitlong

The maximum number of units of the proxy service in Kubernetes in shared mode.

0
ExclusiveUnitNumLimitlong

The maximum number of units of the proxy service in Kubernetes in exclusive mode.

0

Examples

Sample success responses

JSONformat

{
  "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,
    "ExpireTime": "2123-07-05T16:00:00",
    "UnitNumLimit": 4,
    "ProxyVersion": "4.3.1.0-xxxxxxxxx",
    "DeployMode": "share",
    "ServerNumLimit": 0,
    "AllowModifyServerNum": true,
    "SharedUnitNumLimit": 0,
    "ExclusiveUnitNumLimit": 0
  }
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2025-08-05The response structure of the API has changedView Change Details