All Products
Search

This Product

    PolarDB:ListOrders

    Document Center

    PolarDB:ListOrders

    Last Updated:Sep 24, 2026

    Queries 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

    polardb:ListOrders

    list

    *All Resource

    *

    		 None None

    Request syntax

    POST  HTTP/1.1

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    RegionId

    string

    No

    The region ID.

    Note

    You can call the DescribeRegions operation to query region information.

    cn-hangzhou
    ProductCode

    string

    No

    The product code.

    polardb
    Category

    string

    No

    The product edition. Valid values:

    • Normal: Cluster Edition.

    • Basic: Single Node Edition.

    • Archive: X-Engine (Warm Data).

    • NormalMultimaster: Multi-master Cluster Edition.

    • SENormal: Standard Edition.

    Note

    • PolarDB for PostgreSQL 11 does not support Single Node Edition.

    • PolarDB for MySQL 8.0, PolarDB for MySQL 5.7, and PolarDB for PostgreSQL 14 support Standard Edition.

    • PolarDB for MySQL 8.0 supports X-Engine (Warm Data) and Multi-master Cluster Edition.

    Normal
    ResourceGroupId

    string

    No

    The resource group ID.

    rg-************
    InstanceId

    string

    No

    The instance ID.

    pc-2zed3m89cw***
    OrderStatus

    string

    No

    The order status. Valid values:

    • pending: The task is waiting to start.

    • create: The order has been placed and entered the production process.

    • fail: Production failed.

    • cancel: The order is canceled.

    • success: Production succeeded.

    success
    PageSize

    integer

    No

    The number of entries per page. Valid values:

    • 30

    • 50

    • 100

    Default value: 30.

    30
    PageNumber

    integer

    No

    The page number.

    1
    MaxResults

    integer

    No

    The maximum number of entries to return. Default value: 10.

    10
    NextToken

    string

    No

    The pagination token that is used to retrieve more results. If a single request does not return all results, this parameter is returned. You can pass the returned token in a subsequent request to continue retrieving results.

    212db86sca4384811e0b5e8707e******

    Response elements

    Element

    Type

    Description

    Example

    object

    Schema of Response

    MaxResults

    integer

    The maximum number of entries to return. Default value: 10.

    10
    NextToken

    string

    The pagination token that is used to retrieve more results. If a single request does not return all results, this parameter is returned. You can pass the returned token in a subsequent request to continue retrieving results.

    212db86sca4384811e0b5e8707e******
    OrderList

    array<object>

    The order list.

    object

    The order instance information.

    AliUid

    string

    The Alibaba Cloud account ID.

    1910740440664****
    ChargeType

    string

    The billing method of the instance. Valid values:

    • Postpaid: pay-as-you-go.

    • Prepaid: subscription.

    Prepaid
    CommodityCode

    string

    The commodity code. Valid values:

    • polardb_sub: subscription in the Chinese mainland.

    • polardb_sub_intl: subscription in Hong Kong (China) and outside China.

    • polardb_payg: pay-as-you-go in the Chinese mainland.

    • polardb_payg_intl: pay-as-you-go in Hong Kong (China) and outside China.

    • polardb_sub_jushita: Jushita subscription.

    • polardb_payg_jushita: Jushita pay-as-you-go.

    • polardb_sub_cainiao: Cainiao subscription.

    • polardb_payg_cainiao: Cainiao pay-as-you-go.

    Note

    • If you use an Alibaba Cloud China Website account, you can view only the commodity codes for the Chinese mainland.

    • If you use an Alibaba Cloud International Website account, you can view only the commodity codes for international regions.

    • If you use a Jushita account, you can view only the commodity codes for Jushita.

    • If you use a Cainiao account, you can view only the commodity codes for Cainiao.

    polardb_payg_intl
    CreatedTime

    string

    The creation time.

    The time is in the YYYY-MM-DDTHH:mm:ss format.

    2021-03-31T16:09:13
    InstanceId

    string

    The cluster ID of the instance.

    pc-uf6k532gav*******
    OrderId

    string

    The order ID.

    25808743077*****
    OrderStatus

    string

    The order status. Valid values:

    • pending: The task is waiting to start.

    • create: The order has been placed and entered the production process.

    • fail: Production failed.

    • cancel: The order is canceled.

    • success: Production succeeded.

    success
    OrderType

    string

    The order type. Valid values:

    • BUY: new purchase.

    • UPGRADE: configuration change.

    • RENEW: renewal.

    • CONVERT: billing method conversion.

    BUY
    ProduceCode

    string

    The product code.

    polardb
    Region

    string

    The region information.

    cn-hangzhou
    PageNumber

    integer

    The page number. Default value: 1.

    1
    PageSize

    integer

    The number of entries per page. Valid values:

    • 30

    • 50

    • 100

    Default value: 30.

    30
    RequestId

    string

    The request ID.

    3AA69096-757C-4647-B36C-29EBC2******
    TotalCount

    integer

    The total number of entries.

    7

    Examples

    Success response

    JSON format

    {
  "MaxResults": 10,
  "NextToken": "212db86sca4384811e0b5e8707e******",
  "OrderList": [
    {
      "AliUid": "1910740440664****",
      "ChargeType": "Prepaid",
      "CommodityCode": "polardb_payg_intl",
      "CreatedTime": "2021-03-31T16:09:13",
      "InstanceId": "pc-uf6k532gav*******",
      "OrderId": "25808743077*****",
      "OrderStatus": "success",
      "OrderType": "BUY",
      "ProduceCode": "polardb",
      "Region": "cn-hangzhou"
    }
  ],
  "PageNumber": 1,
  "PageSize": 30,
  "RequestId": "3AA69096-757C-4647-B36C-29EBC2******",
  "TotalCount": 7
}

    Error codes

    HTTP status code

    Error code

    Error message

    Description
    403 OperationDenied.Product The product code is not supported. This operation is not supported for the product.

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.