All Products
Search
Document Center

Data Management:ListEffectiveOrders

最終更新日:Oct 21, 2024

Queries valid orders.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
TidlongNo

The ID of the tenant.

Note : To view the ID of the tenant, go to the Data Management (DMS) console and move the pointer over the profile picture in the upper-right corner. For more information, see View information about the current tenant.
3***

Response parameters

ParameterTypeDescriptionExample
object

Schema of Response

RequestIdstring

The ID of the request.

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

Indicates whether the request was successful. Valid values:

  • true: The request was successful.
  • false: The request failed.
true
ErrorMessagestring

The error message returned if the request failed.

UnknownError
ErrorCodestring

The error code returned if the request failed.

UnknownError
OrderSummaryarray<object>

The information about orders.

OrderSummaryobject
CommodityCodestring

The commodity code of DMS.

  • dms_pre_public_cn: DMS that uses the subscription billing method
  • dms_post_public_cn: DMS that uses the pay-as-you-go billing method
dms_pre_public_cn
CommodityTypestring

The type of the service.

  • VersionType: DMS that supports control modes
  • SensitiveDataProtection: DMS that supports sensitive data protection
VersionType
VersionTypestring

The control mode of DMS. Valid values:

  • stand: Stable Change
  • safety: Security Collaboration
safety
TotalQuotainteger

The sum of the number of instances that you can use DMS to manage in all orders.

12
OrderListarray<object>

Details about the orders.

OrderListobject

The order.

OrderIdstring

The ID of the order.

2190037****
BuyerIdstring

The UID of the user who placed the order.

2698420314****
InstanceIdstring

The ID of the instance for the purchased service.

rm-bp1xd1v866****
StartTimestring

The time when the instance is started.

2022-10-24 00:00:00
EndTimestring

The time when the instance expires.

2022-11-24 00:00:00
InsNumstring

The maximum number of database instances that you can use DMS to manage.

7

Examples

Sample success responses

JSONformat

{
  "RequestId": "A8FE12AA-300D-5FDF-806F-C2CB99161F32",
  "Success": true,
  "ErrorMessage": "UnknownError",
  "ErrorCode": "UnknownError",
  "OrderSummary": [
    {
      "CommodityCode": "dms_pre_public_cn\n",
      "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"
        }
      ]
    }
  ]
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
No change history