DescribeRestoreOrder - PolarDB - Alibaba Cloud Documentation Center

Queries the order details of the current restoration purchase.

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

drds:DescribeRestoreOrder

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
DrdsInstanceId	string	Yes	The instance ID.	drds************
PreferredBackupTime	string	No	The backup time.	2019-09-16 15:12:53
BackupMode	string	No	The backup mode. Valid values: logic: logical backup phy: physical backup.	phy
BackupLevel	string	No	The backup level. Valid values: db: database level instance: instance level.	db
BackupDbNames	string	No	The name of the database involved in the backup.	drds_flashback
BackupId	string	No	The backup ID.	1918df27-4563-11e9-8403-af4fbe******

Response elements

Element	Type	Description	Example
	object
Success	boolean	Indicates whether the API request is successful.	true
RequestId	string	The request ID.	0AD2DE5D-B86B-40B5-9678-487D37******
RestoreOrderDO	object	The returned data object.
DrdsOrderDOList	object
DrdsOrderDOList	array<object>	The information of the restored order.
	object
VpcId	string	The ID of the VPC network.	vpc-*******************
Network	string	The network type. Valid values: Classic : Classic Network vpc: VPC	vpc
VSwtichId	string	The ID of the vSwitch in the VPC.	vsw-*******************
InstSpec	string	The instance type of the instance.	4C8G * 2
AzoneId	string	The ID of the zone for which to query resources.	cn-hangzhou-e
RegionId	string	The region ID of the instance.	cn-hangzhou
RdsOrderDOList	object
RdsOrderDOList	array<object>	The information of the restored RDS order.
	object
Network	string	The network type. Valid values: - Classic : Classic Network vpc: VPC	VPC
Version	string	The version of the operating system.	5.6
InstanceClass	string	The instance type of the instance.	rds.mysql.s2.large
DbInstanceStorage	string	The capacity of disk.	10240
Num	integer	The number of streams that were returned.	1
Engine	string	The storage engine of the instance.	MYSQL
AzoneId	string	The zone ID of the node.	cn-hangzhou-g
RegionId	string	The region ID of the instance.	cn-hangzhou
PolarOrderDOList	object
PolarOrderDOList	array<object>	The ID of the restored apsaradb for PolarDB cluster.
	object
Network	string	The network type. Valid values: Classic: Classic Network vpc: VPC	VPC
Version	string	The version of the operating system.	5.6
InstanceClass	string	The type of the instance.	polar.mysql.x4.large
DbInstanceStorage	string	The capacity of disk.	10240
Num	integer	The number of streams that were returned.	1
Engine	string	The storage engine of PolarDB.	POLARDB
AzoneId	string	The zone ID of the node.	cn-hangzhou-g
RegionId	string	The region ID of the instance.	cn-hangzhou

Examples

Success response

JSON format

{
  "Success": true,
  "RequestId": "0AD2DE5D-B86B-40B5-9678-487D37******",
  "RestoreOrderDO": {
    "DrdsOrderDOList": {
      "DrdsOrderDOList": [
        {
          "VpcId": "vpc-*******************",
          "Network": "vpc",
          "VSwtichId": "vsw-*******************",
          "InstSpec": "4C8G * 2",
          "AzoneId": "cn-hangzhou-e",
          "RegionId": "cn-hangzhou"
        }
      ]
    },
    "RdsOrderDOList": {
      "RdsOrderDOList": [
        {
          "Network": "VPC",
          "Version": "5.6",
          "InstanceClass": "rds.mysql.s2.large",
          "DbInstanceStorage": "10240",
          "Num": 1,
          "Engine": "MYSQL",
          "AzoneId": "cn-hangzhou-g",
          "RegionId": "cn-hangzhou"
        }
      ]
    },
    "PolarOrderDOList": {
      "PolarOrderDOList": [
        {
          "Network": "VPC",
          "Version": "5.6",
          "InstanceClass": "polar.mysql.x4.large",
          "DbInstanceStorage": "10240",
          "Num": 1,
          "Engine": "POLARDB",
          "AzoneId": "cn-hangzhou-g",
          "RegionId": "cn-hangzhou"
        }
      ]
    }
  }
}

Error codes

HTTP status code	Error code	Error message	Description
500	InternalError	The request processing has failed due to some unknown error.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.