ListEffectiveOrders - Data Management - Alibaba Cloud Documentation Center

Queries valid orders.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
Tid	long	No	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

Parameter	Type	Description	Example
	object	Schema of Response
RequestId	string	The ID of the request.	A8FE12AA-300D-5FDF-806F-C2CB99161F32
Success	boolean	Indicates whether the request was successful. Valid values: true: The request was successful. false: The request failed.	true
ErrorMessage	string	The error message returned if the request failed.	UnknownError
ErrorCode	string	The error code returned if the request failed.	UnknownError
OrderSummary	object []	The information about orders.
CommodityCode	string	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
CommodityType	string	The type of the service. VersionType: DMS that supports control modes SensitiveDataProtection: DMS that supports sensitive data protection	VersionType
VersionType	string	The control mode of DMS. Valid values: stand: Stable Change safety: Security Collaboration	safety
TotalQuota	integer	The sum of the number of instances that you can use DMS to manage in all orders.	12
OrderList	object []	Details about the orders.
OrderId	string	The ID of the order.	2190037****
BuyerId	string	The UID of the user who placed the order.	2698420314****
InstanceId	string	The ID of the instance for the purchased service.	rm-bp1xd1v866****
StartTime	string	The time when the instance is started.	2022-10-24 00:00:00
EndTime	string	The time when the instance expires.	2022-11-24 00:00:00
InsNum	string	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 time	Summary of changes	Operation

No change history