すべてのプロダクト
Search

このプロダクト

    ApsaraDB for OceanBase (Deprecated):DescribeTenantEncryption

    ドキュメントセンター

    ApsaraDB for OceanBase (Deprecated):DescribeTenantEncryption

    最終更新日:May 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:DescribeTenantEncryption

    get

    *All Resource

    *

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    InstanceId

    string

    必須

    OceanBase クラスターの ID。

    ob317v4uif****
    TenantId

    string

    任意

    テナントの ID。

    t4louaeei****
    TenantName

    string

    任意

    テナントの名前です。
    英字またはアンダースコア (_) で始まり、長さが 2〜20 文字で、大文字、小文字、数字、アンダースコア (_) を使用できる必要があります。sys には設定できません。

    forMySQLTenant
    PageNumber

    integer

    任意

    返されるページの番号。

    • ページは 1 から始まります。

    • デフォルト値：1

    1
    PageSize

    integer

    任意

    各ページで返される行数。

    • 最大値：100

    • デフォルト値：10

    10

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    リクエストの結果。

    RequestId

    string

    リクエストの ID。

    EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C
    TotalCount

    integer

    返されるエントリの総数。このパラメーターはページングクエリで有効です。

    8
    TenantEncryptions

    array<object>

    暗号化をサポートするシナリオの配列。

    object

    暗号化をサポートするシナリオに関する情報。

    TenantId

    string

    テナントの ID。

    t4louaeei****
    TenantMode

    string

    テナントの互換モード。有効な値は次のとおりです：

    • Oracle

    • MySQL

    MySQL
    TenantName

    string

    テナントの名前。

    forMySQLTenant
    EnableEncryption

    boolean

    暗号化が有効かどうかを示します。有効な値は次のとおりです：

    • true

    • false

    false
    TenantStatus

    string

    テナントのステータス。

    ONLINE
    Status

    string

    テナントの暗号化ステータス。

    OPEN
    EncryptionType

    string

    暗号化タイプ。

    INTERNAL
    EncryptionKeyId

    string

    Key Management Service (KMS) で作成された暗号化キーの ID。

    xxx

    例

    成功レスポンス

    JSONJSON

    {
  "RequestId": "EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C",
  "TotalCount": 8,
  "TenantEncryptions": [
    {
      "TenantId": "t4louaeei****",
      "TenantMode": "MySQL",
      "TenantName": "forMySQLTenant",
      "EnableEncryption": false,
      "TenantStatus": "ONLINE",
      "Status": "OPEN",
      "EncryptionType": "INTERNAL",
      "EncryptionKeyId": "xxx"
    }
  ]
}

    エラーコード

    HTTP ステータスコード

    エラーコード

    エラーメッセージ

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

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

    変更履歴

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