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

Obtém a lista de aplicações para todas as instâncias do PolarDB em uma região especificada.

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:DescribeApplications

get

*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	Sim	O ID da região.	cn-beijing
ApplicationIds	string	Não	Uma lista de IDs de aplicações. Se especificados, esta operação retorna informações apenas sobre as aplicações especificadas.	pa-**************
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. Valor padrão: 1.	1
DBClusterId	string	Não	O ID da instância do PolarDB. Se especificado, esta operação retorna informações apenas sobre as aplicações associadas a esta instância.	pc-**************
ApplicationTypes	string	Não
Tag	array<object>	Não	A list of tags. A tag is a key-value pair.
	object	Não
Key	string	Não	The key of the tag.	testKey
Value	string	Não	The value of the tag.	testValue

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	O corpo da resposta.
RequestId	string	O ID da solicitação.	3E5CD764-FCCA-5C9C-838E-20E0DE84B2AF
TotalRecordCount	integer	O número total de registros.	1
PageRecordCount	integer	O número de registros na página atual.	1
PageNumber	integer	O número da página.	1
Items	object	Contém as aplicações retornadas.
Applications	array<object>	Uma lista de aplicações.
	array<object>	Detalhes de uma aplicação.
Status	string	The application status. Valid values: `Creating`: The application is being created. `Activated`: The application is running. `Maintaining`: The application is under maintenance. `ClassChanging`: The instance type is being changed. `Migrating`: The application is being migrated. `MinorVersionUpgrading`: The minor version is being upgraded. `NetCreating`: An endpoint is being created. `NetDeleting`: An endpoint is being deleted. `NetModifying`: An endpoint is being modified. `Restarting`: The application is being restarted. `Locking`: The application is being locked. `Locked`: The application is locked. `Unlocking`: The application is being unlocked. `Deleting`: The application is being deleted.	Activated
Description	string	The application description.	myapp
EngineVersion	string	The engine version.	1.0.0
ZoneId	string	The ID of the availability zone.	cn-hangzhou-b
Expired	string	Indicates whether the application has expired.	false
PayType	string	The billing method. This parameter is empty if the application is free of charge.	Postpaid
PolarFSInstanceId	string	The ID of the associated PolarFS instance.	pcs-**************
Endpoints	object	Contains the application's endpoints.
endpoint	array<object>	A list of application endpoints.
	object	The details of an application endpoint.
IP	string	The IP address.	192.168.0.3
Port	string	The port.	8080
NetType	string	The network type. Valid values: `Private`: VPC address `Public`: public address	Public
ApplicationType	string	The application type.	supabase
CreationTime	string	The creation time.	2025-03-25T09:37:10Z
RegionId	string	The ID of the region.	cn-hangzhou
ApplicationId	string	The application ID.	pa-**************
ExpireTime	string	The expiration time.	2025-06-25T09:37:10Z
DBClusterId	string	The cluster ID.	pc-xxxxxx
Tags	object	The application tags.
Tag	array<object>	A list of tags.
	object	The details of a tag, which is a key-value pair.
Key	string	The tag key.	testKey
Value	string	The tag value.	testValue

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "3E5CD764-FCCA-5C9C-838E-20E0DE84B2AF",
  "TotalRecordCount": 1,
  "PageRecordCount": 1,
  "PageNumber": 1,
  "Items": {
    "Applications": [
      {
        "Status": "Activated",
        "Description": "myapp",
        "EngineVersion": "1.0.0",
        "ZoneId": "cn-hangzhou-b",
        "Expired": "false",
        "PayType": "Postpaid",
        "PolarFSInstanceId": "pcs-**************\n",
        "Endpoints": {
          "endpoint": [
            {
              "IP": "192.168.0.3",
              "Port": "8080",
              "NetType": "Public"
            }
          ]
        },
        "ApplicationType": "supabase",
        "CreationTime": "2025-03-25T09:37:10Z",
        "RegionId": "cn-hangzhou",
        "ApplicationId": "pa-**************",
        "ExpireTime": "2025-06-25T09:37:10Z",
        "DBClusterId": "pc-xxxxxx",
        "Tags": {
          "Tag": [
            {
              "Key": "testKey",
              "Value": "testValue"
            }
          ]
        }
      }
    ]
  }
}

Códigos de erro

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.