ListEffectiveOrders - Query valid DMS orders - Data Management

Lists valid DMS orders.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

dms:ListEffectiveOrders

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
Tid	integer	No	Tenant ID. Note To find the tenant ID, hover over your profile picture in the upper-right corner of the DMS console. View information about the current tenant.	3***

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	Request ID.	A8FE12AA-300D-5FDF-806F-C2CB99161F32
Success	boolean	Whether the request was successful. Valid values: true: The request was successful. false: The request failed.	true
ErrorMessage	string	Error message returned on failure.	UnknownError
ErrorCode	string	Error code returned on failure.	UnknownError
OrderSummary	array<object>	Order summary.
	array<object>
CommodityCode	string	Commodity code of the DMS edition. dms_pre_public_cn: DMS with subscription billing dms_post_public_cn: DMS with pay-as-you-go billing	Subscription
CommodityType	string	Service type. VersionType: DMS with control modes SensitiveDataProtection: DMS with sensitive data protection	VersionType
VersionType	string	Control mode of DMS. Valid values: stand: Stable Change safety: Security Collaboration	safety
TotalQuota	integer	Total number of manageable instances across all orders.	12
OrderList	array<object>	Order details.
	object	The order.
OrderId	string	Order ID.	2190037****
BuyerId	string	UID of the buyer.	2698420314****
InstanceId	string	Instance ID of the purchased service.	rm-bp1xd1v866****
StartTime	string	Start time of the instance.	2022-10-24 00:00:00
EndTime	string	Expiration time of the instance.	2022-11-24 00:00:00
InsNum	string	Maximum number of database instances manageable through DMS.	7

Examples

Success response

JSON format

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

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.