ListEffectiveOrders -

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters


Parameter	Type	Required	Example	Description
Action	String	Yes	ListEffectiveOrders	The operation that you want to perform. Set the value to ListEffectiveOrders.
Tid	Long	No	3***	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.

Response parameters


Parameter	Type	Example	Description
RequestId	String	A8FE12AA-300D-5FDF-806F-C2CB99161F32	The ID of the request.
Success	Boolean	true	Indicates whether the request was successful. Valid values: true: The request was successful. false: The request failed.
ErrorMessage	String	UnknownError	The error message returned if the request failed.
ErrorCode	String	UnknownError	The error code returned if the request failed.
OrderSummary	Array of OrderSummary		Information about the orders.
CommodityCode	String	dms_pre_public_intl	The commodity code of DMS. Valid values: dms_pre_public_intl: DMS that uses the subscription billing method dms_post_public_intl: DMS that uses the pay-as-you-go billing method
CommodityType	String	VersionType	The type of the service. VersionType: DMS that supports control modes SensitiveDataProtection: DMS that supports sensitive data protection
VersionType	String	safety	The control mode of DMS. Valid values: stand: Stable Change safety: Security Collaboration
TotalQuota	Integer	12	The sum of the number of instances that you can use DMS to manage in all orders.
OrderList	Array of OrderList		Details about the orders.
OrderId	String	2190037****	The ID of the order.
BuyerId	String	2698420314****	The ID of the user who made the purchase.
InstanceId	String	rm-bp1xd1v866****	The ID of the instance for the purchased service.
StartTime	String	2022-10-24 00:00:00	The time when the instance is started.
EndTime	String	2022-11-24 00:00:00	The time when the instance expires.
InsNum	String	7	The maximum number of database instances that you can use DMS to manage.

Examples

Sample requests

http(s)://dms-enterprise.aliyuncs.com/?Action=ListEffectiveOrders
&Tid=3***
&Common request parameters

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<ListEffectiveOrdersResponse>
    <RequestId>A8FE12AA-300D-5FDF-806F-C2CB99161F32</RequestId>
    <Success>true</Success>
    <OrderSummary>
        <CommodityCode>dms_pre_public_intl</CommodityCode>
        <CommodityType>VersionType</CommodityType>
        <VersionType>safety</VersionType>
        <TotalQuota>12</TotalQuota>
        <OrderList>
            <OrderId>2190037****</OrderId>
            <BuyerId>2698420314****</BuyerId>
            <InstanceId>rm-bp1xd1v866****</InstanceId>
            <StartTime>2022-10-24 00:00:00</StartTime>
            <EndTime>2022-11-24 00:00:00</EndTime>
            <InsNum>7</InsNum>
        </OrderList>
    </OrderSummary>
</ListEffectiveOrdersResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "A8FE12AA-300D-5FDF-806F-C2CB99161F32",
  "Success" : true,
  "OrderSummary" : [ {
    "CommodityCode" : "dms_pre_public_intl",
    "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, see Service error codes.