查詢 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
}
}錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊，參考變更詳情。