ListOrders - PolarDB: Central de Documentação do Alibaba Cloud

Consulta uma lista de pedidos.

Experimente agora

Experimente esta API no OpenAPI Explorer, sem necessidade de assinatura manual. Chamadas bem-sucedidas geram automaticamente código SDK correspondente aos seus parâmetros. Faça o download com segurança de credenciais integrada para uso local.

Testar

Autorização RAM

A tabela abaixo descreve a autorização necessária para chamar esta API. Você pode defini-la em uma política do Resource Access Management (RAM). As colunas da tabela estão detalhadas abaixo:

Ação: As ações que podem ser usadas no elemento Action das instruções de política de permissão do RAM para conceder permissões para executar a operação.
API: A API que você pode chamar para executar a ação.
Nível de acesso: O nível de acesso predefinido concedido para cada API. Valores válidos: create, list, get, update e delete.
Tipo de recurso: O tipo de recurso que suporta autorização para executar a ação. Indica se a ação suporta permissão em nível de recurso. O recurso especificado deve ser compatível com a ação. Caso contrário, a política será ineficaz.
- Para APIs com permissões em nível de recurso, os tipos de recursos obrigatórios são marcados com um asterisco (*). Especifique o Nome de Recurso Alibaba Cloud (ARN) correspondente no elemento Resource da política.
- Para APIs sem permissões em nível de recurso, é exibido como Todos os Recursos. Use um asterisco (*) no elemento Resource da política.
Chave de condição: As chaves de condição definidas pelo serviço. A chave permite controle granular, aplicando-se somente a ações ou a ações associadas a recursos específicos. Além das chaves de condição específicas do serviço, o Alibaba Cloud fornece um conjunto de chaves de condição comuns aplicáveis a todos os serviços compatíveis com RAM.
Ação dependente: As ações dependentes necessárias para executar a ação. Para concluir a ação, o usuário RAM ou a função RAM deve ter permissões para executar todas as ações dependentes.

Ação

Nível de acesso

Tipo de recurso

Chave de condição

Ação dependente

polardb:ListOrders

list

*All Resource

*

Nenhuma

Sintaxe da solicitação

POST  HTTP/1.1

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
RegionId	string	Não	O ID da região. Nota Chame a operação DescribeRegions para visualizar os detalhes das regiões.	cn-hangzhou
ProductCode	string	Não	O código do produto.	polardb
Category	string	Não	A edição do cluster. Valores válidos: Normal: Cluster Edition Basic: nó único Archive: X-Engine NormalMultimaster: Multi-master Cluster Edition SENormal: Standard Edition Nota A edição de nó único não é suportada em clusters PolarDB for PostgreSQL que executam PostgreSQL 11. A Standard Edition é suportada em clusters PolarDB for MySQL que executam MySQL 8.0 ou 5.7, e em clusters PolarDB for PostgreSQL que executam PostgreSQL 14. Clusters PolarDB for MySQL que executam MySQL 8.0 suportam X-Engine e a Multi-master Cluster Edition.	Normal
ResourceGroupId	string	Não	O ID do grupo de recursos.	rg-************
InstanceId	string	Não	O ID da instância atual.	pc-2zed3m89cw***
OrderStatus	string	Não	O status do pedido. pending: A tarefa está aguardando para iniciar. create: O pedido foi realizado e está sendo processado. fail: Falha ao criar a instância. cancel: O pedido foi cancelado. success: A instância foi criada.	success
PageSize	integer	Não	O número de entradas a serem retornadas em cada página. Valores válidos: 30 50 100 Valor padrão: 30.	30
PageNumber	integer	Não	O número da página.	1
MaxResults	integer	Não	O número máximo de entradas a serem retornadas para a solicitação atual. Valor padrão: 10.	10
NextToken	string	Não	Um token de paginação. Se os resultados da consulta não forem retornados em uma única chamada, este token será retornado. Use este token em uma chamada subsequente para recuperar os resultados restantes.	212db86sca4384811e0b5e8707e******

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Esquema da resposta.
MaxResults	integer	O número máximo de entradas retornadas para a solicitação atual. Valor padrão: 10.	10
NextToken	string	Um token de paginação. Se os resultados da consulta não forem retornados em uma única chamada, este token será retornado. Use este token em uma chamada subsequente para recuperar os resultados restantes.	212db86sca4384811e0b5e8707e******
OrderList	array<object>	A lista de pedidos.
	object	As informações sobre a instância do pedido.
AliUid	string	O ID da conta Alibaba Cloud.	1910740440664****
ChargeType	string	O método de cobrança da instância. Valores válidos: Postpaid: pay-as-you-go Prepaid: assinatura	Prepaid
CommodityCode	string	O código do produto. Valores válidos: polardb_sub: assinatura na China continental. polardb_sub_intl: assinatura em Hong Kong (China) e regiões fora da China. polardb_payg: pay-as-you-go na China continental. polardb_payg_intl: pay-as-you-go em Hong Kong (China) e regiões fora da China. polardb_sub_jushita: assinatura Jushita. polardb_payg_jushita: pay-as-you-go Jushita. polardb_sub_cainiao: assinatura Cainiao. polardb_payg_cainiao: pay-as-you-go Cainiao. Nota Se você usar uma conta Alibaba Cloud para o site da China, poderá visualizar apenas os códigos de produto para a China continental. Se você usar uma conta do site internacional da Alibaba Cloud, poderá visualizar apenas os códigos de produto para regiões fora da China continental. Se você usar uma conta Jushita, poderá visualizar apenas os códigos de produto para Jushita. Se você usar uma conta Cainiao, poderá visualizar apenas os códigos de produto para Cainiao.	polardb_payg_intl
CreatedTime	string	A hora em que o pedido foi criado.	2021-03-31T16:09:13
InstanceId	string	O ID do cluster.	pc-uf6k532gav*******
OrderId	string	O ID do pedido.	25808743077*****
OrderStatus	string	O status do pedido. pending: A tarefa está aguardando para iniciar. create: O pedido foi realizado e está sendo processado. fail: Falha ao criar a instância. cancel: O pedido foi cancelado. success: A instância foi criada.	success
OrderType	string	O tipo do pedido. Valores válidos: BUY: A instância foi adquirida. UPGRADE: A configuração da instância foi alterada. RENEW: A assinatura foi renovada. CONVERT: O método de cobrança foi alterado.	BUY
ProduceCode	string	O código do produto.	polardb
Region	string	As informações da região.	cn-hangzhou
PageNumber	integer	O número da página retornada. Valor padrão: 1.	1
PageSize	integer	O número de entradas retornadas por página. Valores válidos: 30 50 100 Valor padrão: 30.	30
RequestId	string	O ID da solicitação.	3AA69096-757C-4647-B36C-29EBC2******
TotalCount	integer	O número total de entradas.	7

Exemplos

Resposta de sucesso

JSON formato

{
  "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
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
403	OperationDenied.Product	The product code is not supported.	This operation is not supported for the product.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.