查看參數信息列表。
調試
您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息，可以在RAM權限策略語句的Action元素中使用，用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下：
- 操作：是指具體的權限點。
- 訪問級別：是指每個操作的訪問級別，取值為寫入（Write）、讀取（Read）或列出（List）。
- 資源類型：是指操作中支持授權的資源類型。具體說明如下：
- 對于必選的資源類型，用背景高亮的方式表示。
- 對于不支持資源級授權的操作，用
全部資源表示。
- 條件關鍵字：是指云產品自身定義的條件關鍵字。
- 關聯操作：是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限，操作才能成功。
| 操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
|---|---|---|---|---|
| oceanbase:DescribeParameters | get | *全部資源 * |
| 無 |
請求參數
| 名稱 | 類型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| InstanceId | string | 是 | OceanBase 集群 ID。 | ob317v4uif**** |
| Dimension | string | 是 | 參數類型。 當前支持集群（CLUSTER）和租戶（TENANT）。 | TENANT |
| DimensionValue | string | 否 | 參數類型的資源標識。 | ob2mr3oae0**** |
返回參數
示例
正常返回示例
JSON格式
{
"RequestId": "EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C",
"Parameters": [
{
"Description": "弱讀允許的最大時間延遲時間",
"ValueType": "CAPACITY",
"CurrentValue": "600",
"NeedReboot": false,
"Name": "connect_timeout",
"DefaultValue": "600s",
"RejectedValue": [
"1s"
],
"AcceptableValue": [
"2s"
],
"Readonly": false,
"Unit": "s"
}
]
}錯誤碼
| HTTP status code | 錯誤碼 | 錯誤信息 | 描述 |
|---|---|---|---|
| 500 | InternalError | The request processing has failed due to some unknown error. | 內部錯誤 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
| 變更時間 | 變更內容概要 | 操作 |
|---|---|---|
| 2023-08-21 | OpenAPI 錯誤碼發生變更、OpenAPI 返回結構發生變更 | 查看變更詳情 |
| 2023-05-17 | OpenAPI 錯誤碼發生變更、OpenAPI 返回結構發生變更 | 查看變更詳情 |