すべてのプロダクト
Search

このプロダクト

    ApsaraDB for OceanBase (Deprecated):DescribeParameters

    ドキュメントセンター

    ApsaraDB for OceanBase (Deprecated):DescribeParameters

    最終更新日:Jun 26, 2026

    パラメーター情報のリストを照会します。

    今すぐお試しください

    この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

    テスト

    RAM 認証

    下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

    • アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。

    • API：アクションを具体的に実行するための API。

    • アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。

    • リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。

      • リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。

      • リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。

    • 条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。

    • 依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    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

    パラメーターの拒否される値の有効値。 フォーマットは、有効値を表す 2 つの文字列要素を持つ配列です。最初の要素は最小値、2 番目の要素は最大値です。

    string

    パラメーターの拒否される値の有効値。

    1s
    AcceptableValue

    array

    パラメーターの許容される値の有効値。

    string

    パラメーターの許容される値の有効値。

    2s
    Readonly

    boolean

    パラメーターが読み取り専用かどうかを示します。

    false
    Unit

    string

    現在のパラメーター値の単位。

    s

    例

    成功レスポンス

    JSONJSON

    {
  "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 ステータスコード

    エラーコード

    エラーメッセージ

    説明
    500 InternalError The request processing has failed due to some unknown error.

    完全なリストについては、「エラーコード」をご参照ください。

    変更履歴

    完全なリストについては、「変更履歴」をご参照ください。