DescribeParameters

查看參數資訊列表。

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

oceanbase:DescribeParameters

get

*All Resource

*

無

請求參數

名稱	類型	必填	描述	樣本值
InstanceId	string	是	OceanBase 叢集 ID。	ob317v4uif****
Dimension	string	是	參數類型。當前支援叢集（CLUSTER）和租戶（TENANT）。	TENANT
DimensionValue	string	否	參數類型的資源標識。如果為叢集參數可以不填，若為租戶的參數，則傳入租戶的 TenantId。	ob2mr3oae0****

返回參數

名稱	類型	描述	樣本值
	object	請求的返回結果。
RequestId	string	請求 ID。	EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C
Parameters	array<object>	參數列表資訊。
	object	請求的返回結果。
Description	string	參數的描述資訊。	弱读允许的最大时间延迟时间
ValueType	string	參數取值的類型。其支援： ENUM: 數值列舉。 RANGE: 數值範圍。 TIME: 時間。 STRING：字串。 ENUM_MULTIPLE：數值列舉多選。 CAPACITY：儲存容量值（K，M，G）。	CAPACITY
CurrentValue	string	參數的當前取值。	600
NeedReboot	boolean	修改此參數是否需要重啟。 true：需要重啟。 false：不需要重啟。	false
Name	string	參數名稱。	connect_timeout
DefaultValue	string	參數的預設取值。	600s
RejectedValue	array	參數的不允許取值範圍。其格式為具備兩個字串元素的陣列類型，表示一個範圍值，第一個元素為最小值，第二個元素為最大值。
	string	參數的不允許取值範圍。	1s
AcceptableValue	array	參數的可接受取值範圍。
	string	參數的可接受取值範圍。	2s
Readonly	boolean	參數是否唯讀。	false
Unit	string	當前參數值單位。	s

樣本

正常返回樣本

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.

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。