ListOrders - 查询订单列表

查询订单

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

polardb:ListOrders

list

*全部资源

*

请求语法

POST  HTTP/1.1

请求参数

名称

类型

必填

描述

示例值

RegionId

string

地域 ID。

说明

可通过接口 DescribeRegions 查看地域信息详情。

cn-hangzhou

ProductCode

string

产品代码。

polardb

Category

string

产品系列,取值范围如下:

  • Normal:集群版

  • Basic:单节点

  • Archive:高压缩引擎(X-Engine)

  • NormalMultimaster:多主架构集群版

  • SENormal:标准版

说明
  • PolarDB PostgreSQL 版 PostgreSQL 11 版本不支持单节点。

  • PolarDB MySQL 版 8.0 版本、5.7 版本,PolarDB PostgreSQL 版 PostgreSQL 14 版本支持标准版。

  • PolarDB MySQL 版 8.0 版本,支持高压缩引擎(X-Engine)和多主架构集群版。

Normal

ResourceGroupId

string

资源组 ID。

rg-************

InstanceId

string

当前实例 ID。

pc-2zed3m89cw***

OrderStatus

string

订单状态。

  • processing:处理中。

  • failure:失败。

  • completed:处理完成。

  • unpaid:待支付。

  • refunded:已退款。

completed

PageSize

integer

每页记录数,取值范围如下:

  • 30

  • 50

  • 100

默认值为 30。

30

PageNumber

integer

页码。

1

MaxResults

integer

本次读取的最大数据量,默认值为 10。

10

NextToken

string

用来返回更多结果。如果一次查询没有返回全部结果,则会返回该参数。您可以在后续查询中传入前一次返回的 token 继续查询。

212db86sca4384811e0b5e8707e******

返回参数

名称

类型

描述

示例值

object

Schema of Response

MaxResults

integer

本次读取的最大数据量,默认值为 10。

10

NextToken

string

用来返回更多结果。如果一次查询没有返回全部结果,则会返回该参数。您可以在后续查询中传入前一次返回的 token 继续查询。

212db86sca4384811e0b5e8707e******

OrderList

array<object>

订单列表。

object

返回的订单实例信息。

AliUid

string

阿里云账号 ID。

1910740440664****

ChargeType

string

实例的付费类型。取值:

  • Postpaid:后付费(按量付费)

  • Prepaid:预付费(包年包月)

Prepaid

CommodityCode

string

商品 Code。取值范围如下:

  • polardb_sub:中国内地包年包月。

  • polardb_sub_intl:中国香港及海外包年包月。

  • polardb_payg:中国内地按量付费。

  • polardb_payg_intl:中国香港及海外按量付费。

  • polardb_sub_jushita:聚石塔包年包月。

  • polardb_payg_jushita:聚石塔按量付费。

  • polardb_sub_cainiao:菜鸟包年包月。

  • polardb_payg_cainiao:菜鸟按量付费。

说明
  • 如果您使用的是阿里云国内站账号,只能查看国内的商品 Code。

  • 如果您使用的是阿里云国际站账号,只能查看国际的商品 Code。

  • 如果您使用的是聚石塔账号,只能查看聚石塔的商品 Code。

  • 如果您使用的是菜鸟账号,只能查看菜鸟的商品 Code。

polardb_payg_intl

CreatedTime

string

创建时间。

2021-03-31T16:09:13

InstanceId

string

实例集群 ID。

pc-uf6k532gav*******

OrderId

string

订单 ID。

25808743077*****

OrderStatus

string

订单状态。

  • processing:处理中。

  • failure:失败。

  • completed:处理完成。

  • unpaid:待支付。

  • refunded:已退款。

completed

OrderType

string

订单类型。取值范围如下:

  • BUY:新购。

  • UPGRADE:变更配置。

  • RENEW:续费。

  • CONVERT:转换付费类型。

BUY

ProduceCode

string

产品代码。

polardb

Region

string

地域信息

cn-hangzhou

PageNumber

integer

查询页码,默认值为 1。

1

PageSize

integer

每页记录数,取值范围如下:

  • 30

  • 50

  • 100

默认值为 30。

30

RequestId

string

请求 id。

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

TotalCount

integer

列表条目数。

7

示例

正常返回示例

JSON格式

{
  "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": "completed",
      "OrderType": "BUY",
      "ProduceCode": "polardb",
      "Region": "cn-hangzhou"
    }
  ],
  "PageNumber": 1,
  "PageSize": 30,
  "RequestId": "3AA69096-757C-4647-B36C-29EBC2******",
  "TotalCount": 7
}

错误码

HTTP status code

错误码

错误信息

描述

403 OperationDenied.Product The product code is not supported. 该商品暂不支持此操作。

访问错误中心查看更多错误码。

变更历史

更多信息,参考变更详情