すべてのプロダクト
Search

このプロダクト

    Data Management:ListEffectiveOrders

    ドキュメントセンター

    Data Management:ListEffectiveOrders

    最終更新日:Mar 21, 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 ロールに付与する必要があります。

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    dms:ListEffectiveOrders

    list

    *All Resource

    *

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    Tid

    integer

    任意

    テナントの ID です。

    説明

    テナント ID を確認するには、Data Management (DMS) コンソールにログインし、右上隅のプロフィール画像にカーソルを合わせます。詳細については、「現在のテナントに関する情報の表示」をご参照ください。

    3***

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    応答のスキーマです。

    RequestId

    string

    リクエストの ID です。

    A8FE12AA-300D-5FDF-806F-C2CB99161F32
    Success

    boolean

    リクエストが成功したかどうかを示します。有効な値は以下のとおりです。

    • true：リクエストは成功しました。

    • false：リクエストは失敗しました。

    true
    ErrorMessage

    string

    リクエストが失敗した場合に返されるエラーメッセージです。

    UnknownError
    ErrorCode

    string

    リクエストが失敗した場合に返されるエラーコードです。

    UnknownError
    OrderSummary

    array<object>

    注文に関する情報です。

    array<object>

    CommodityCode

    string

    DMS の商品コードです。

    • dms_pre_public_cn：サブスクリプション課金方式で利用する DMS

    • dms_post_public_cn：従量課金方式で利用する DMS

    包年包月
    CommodityType

    string

    サービスの種類です。

    • VersionType：コントロールモードをサポートする DMS

    • SensitiveDataProtection：機微データ保護をサポートする DMS

    VersionType
    VersionType

    string

    DMS のコントロールモードです。有効な値は以下のとおりです。

    • stand：安定的な変更

    • safety：セキュリティコラボレーション

    safety
    TotalQuota

    integer

    すべての注文において、DMS を使用して管理可能なデータベースインスタンス数の合計です。

    12
    OrderList

    array<object>

    注文の詳細です。

    object

    注文です。

    OrderId

    string

    注文の ID です。

    2190037****
    BuyerId

    string

    注文を実行したユーザーの UID です。

    2698420314****
    InstanceId

    string

    購入済みサービスのインスタンス ID です。

    rm-bp1xd1v866****
    StartTime

    string

    インスタンスの開始時刻です。

    2022-10-24 00:00:00
    EndTime

    string

    インスタンスの有効期限切れ時刻です。

    2022-11-24 00:00:00
    InsNum

    string

    DMS を使用して管理可能な最大データベースインスタンス数です。

    7

    例

    成功レスポンス

    JSONJSON

    {
  "RequestId": "A8FE12AA-300D-5FDF-806F-C2CB99161F32",
  "Success": true,
  "ErrorMessage": "UnknownError",
  "ErrorCode": "UnknownError",
  "OrderSummary": [
    {
      "CommodityCode": "包年包月",
      "CommodityType": "VersionType",
      "VersionType": "safety",
      "TotalQuota": 12,
      "OrderList": [
        {
          "OrderId": "2190037****",
          "BuyerId": "2698420314****",
          "InstanceId": "rm-bp1xd1v866****",
          "StartTime": "2022-10-24 00:00:00",
          "EndTime": "2022-11-24 00:00:00",
          "InsNum": "7"
        }
      ]
    }
  ]
}

    エラーコード

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

    変更履歴

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