Obtém as informações detalhadas de uma aplicação PolarDB especificada.
Descrição da operação
Esta API é usada para consultar todas as informações relacionadas de uma aplicação PolarDB específica, incluindo, mas não se limitando a, detalhes de componentes e endpoints.
Experimente agora
Testar
Autorização RAM
|
Ação |
Nível de acesso |
Tipo de recurso |
Chave de condição |
Ação dependente |
|
polardb:DescribeApplicationAttribute |
get |
*Application
|
Nenhuma | Nenhuma |
Sintaxe da solicitação
POST HTTP/1.1
Parâmetros da solicitação
|
Parâmetro |
Tipo |
Obrigatório |
Descrição |
Exemplo |
| ApplicationId |
string |
Sim |
O ID da aplicação. |
pa-************** |
Elementos de resposta
|
Elemento |
Tipo |
Descrição |
Exemplo |
|
object |
Esquema da resposta. |
||
| RequestId |
string |
O ID da solicitação. |
3E5CD764-FCCA-5C9C-838E-20E0DE84B2AF |
| ApplicationId |
string |
O ID da aplicação. |
pa-************** |
| DBClusterId |
string |
O ID da instância PolarDB da qual a aplicação depende. |
pc-************** |
| Architecture |
string |
A arquitetura de CPU. Valores válidos:
|
x86 |
| Description |
string |
A descrição da aplicação. |
myapp |
| SecurityGroups |
array<object> |
A lista de grupos de segurança no nível da aplicação. |
|
|
object |
O grupo de segurança no nível da aplicação. |
||
| SecurityGroupName |
string |
O nome do grupo de segurança. |
MyGroupName |
| SecurityGroupId |
string |
O ID do grupo de segurança. |
sg-************** |
| RegionId |
string |
O ID da região. |
cn-beijing |
| NetType |
string |
O tipo de rede. Valores válidos:
|
vpc |
| SecurityIPArrays |
array<object> |
A lista de listas de permissões no nível da aplicação. |
|
|
object |
A lista de permissões no nível da aplicação. |
||
| SecurityIPArrayTag |
string |
A tag do grupo de endereços IP. |
mytag |
| SecurityIPType |
string |
O tipo do endereço IP. |
ipv4 |
| SecurityIPList |
string |
Os endereços IP na lista de permissões, separados por vírgulas (,). |
127.0.0.1 |
| SecurityIPArrayName |
string |
O nome do grupo de endereços IP. Valor padrão: |
default |
| SecurityIPNetType |
string |
O tipo de rede dos endereços IP na lista de permissões. Valor padrão: |
mix |
| Status |
string |
O status da aplicação. Valores válidos:
|
Activated |
| LockMode |
string |
O modo de bloqueio. Valores válidos:
|
Unlock |
| ApplicationType |
string |
O tipo da aplicação. |
supabase |
| Version |
string |
A versão da aplicação. |
1.0.0 |
| UpgradeAvailable |
string |
Indica se uma atualização está disponível. |
false |
| MaintainStartTime |
string |
A hora de início da janela de manutenção. |
18:00Z |
| MaintainEndTime |
string |
A hora de término da janela de manutenção. |
19:00Z |
| PayType |
string |
O método de cobrança. |
Postpaid |
| Expired |
boolean |
Indica se a aplicação expirou. |
false |
| VPCId |
string |
O ID da VPC. |
vpc-******************* |
| VSwitchId |
string |
O ID do VSwitch. |
vsw-******************* |
| Components |
array<object> |
A lista de subcomponentes. |
|
|
array<object> |
As informações do subcomponente. |
||
| Status |
string |
O status do componente. Os valores válidos são os mesmos do status da aplicação. |
Activated |
| SecurityGroups |
array<object> |
A lista de grupos de segurança no nível do subcomponente. Se os grupos de segurança no nível do subcomponente forem iguais aos do nível da aplicação, este elemento de resposta será omitido. |
|
|
object |
O grupo de segurança no nível do subcomponente. |
||
| SecurityGroupName |
string |
O nome do grupo de segurança. |
MyGroupName |
| SecurityGroupId |
string |
O ID do grupo de segurança. |
sg-******************* |
| RegionId |
string |
O ID da região. |
cn-beijing |
| NetType |
string |
O tipo de rede. O valor é:
|
vpc |
| ComponentType |
string |
O tipo do subcomponente da aplicação. |
gateway |
| Topology |
object |
As informações de topologia do subcomponente da aplicação. |
|
| Parents |
array |
Os IDs ou tipos de componente dos nós pai para este componente filho. |
|
|
string |
O ID ou tipo de componente de um nó pai para este componente filho. |
pac-************** |
|
| Children |
array |
Os IDs ou tipos de componente dos nós filho para este componente filho. |
|
|
string |
O ID ou tipo de componente de um nó filho para este componente filho. |
pac-************** |
|
| Layer |
string |
A camada de topologia do componente filho. |
0 |
| SecurityIPArrays |
array<object> |
A lista de listas de permissões no nível do subcomponente. Se as listas de permissões no nível do subcomponente forem iguais às do nível da aplicação, este elemento de resposta será omitido. |
|
|
object |
A lista de permissões no nível do subcomponente. |
||
| SecurityIPArrayTag |
string |
A tag do grupo de endereços IP. |
mytag |
| SecurityIPType |
string |
O tipo de endereço IP. |
ipv4 |
| SecurityIPList |
string |
Os endereços IP na lista de permissões, separados por vírgulas. |
127.0.0.1 |
| SecurityIPArrayName |
string |
O nome do grupo de endereços IP. O valor padrão é |
default |
| SecurityIPNetType |
string |
O tipo de rede dos endereços IP na lista de permissões. O valor padrão é |
mix |
| ComponentClassDescription |
string |
A descrição da especificação do subcomponente da aplicação. |
2C4GB |
| ComponentId |
string |
O ID do subcomponente. |
pac-******************* |
| ComponentClass |
string |
A especificação do subcomponente da aplicação. |
polar.app.g2.medium |
| ComponentReplica |
integer |
O número de réplicas do subcomponente da aplicação. |
1 |
| ComponentMaxReplica |
integer |
O número máximo de réplicas do subcomponente da aplicação. |
1 |
| ComponentReplicaGroupName |
string |
O nome do grupo de réplicas do subcomponente da aplicação. |
default |
| Endpoints |
array<object> |
A lista de endpoints da aplicação. |
|
|
object |
O endpoint da aplicação. |
||
| Description |
string |
A descrição do endpoint. |
myendpoint |
| PortDescription |
string |
A descrição da porta. |
kong_http |
| EndpointId |
string |
O ID do endpoint. |
pa-************** |
| IP |
string |
O endereço IP. |
172.31.95.252 |
| Port |
string |
A porta. |
8080 |
| NetType |
string |
O tipo de endpoint. Valores válidos:
|
Private |
| Domain |
string |
||
| Storages |
array<object> |
As informações de recursos de armazenamento. |
|
|
object |
|||
| StoragePerformanceLevel |
string |
O nível de desempenho de armazenamento (PL). |
PL0 |
| StorageInstanceId |
string |
O ID da instância de armazenamento. |
pa-************** |
| StorageType |
string |
O tipo de armazenamento. |
essd |
| StorageCapacity |
string |
A capacidade de armazenamento. |
20Gi |
| CreationTime |
string |
A hora de criação. |
2025-03-25T09:37:10Z |
| ExpireTime |
string |
A hora de expiração. Este valor fica vazio quando o método de cobrança é Postpaid. |
2025-06-25T09:37:10Z |
| RegionId |
string |
O ID da região. |
cn-beijing |
| ZoneId |
string |
O ID da zona. |
cn-beijing-l |
| PolarFSInstanceId |
string |
O ID da instância do PolarFS Cold Storage ou High-performance Edition. |
pfs-************** |
| ServerlessType |
string |
O tipo serverless. Valores válidos:
|
2 |
| MemApplicationAttribute |
object |
Os atributos da aplicação Mem0. |
|
| GraphLlmModelName |
string |
O nome do modelo LLM de grafo. |
qwen3-max |
| LlmModelName |
string |
O nome do modelo LLM. |
qwen3-max |
| EmbedderModelName |
string |
O nome do modelo embedder. |
text-embedding-v4 |
| RerankerModelName |
string |
O nome do modelo reranker. |
qwen3-rerank |
| ProjectName |
string |
O nome do projeto, que corresponde ao esquema que armazena os dados do projeto no banco de dados. |
test-project-name |
| DbName |
string |
O nome do banco de dados. |
test-database-name |
| UserName |
string |
O nome de usuário. |
test-user |
| PolarClawSaaSApplicationAttribute |
object |
Os atributos da aplicação SaaS PolarClaw. |
|
| AuthCallbackURL |
string |
A URL de callback de autenticação. |
http://8.xxx.xxx.xxx.xxx/xxx |
| SupabaseClusterId |
string |
O ID do cluster Supabase. |
pa-************** |
| AuthProviders |
array |
||
|
string |
|||
| MinorVersion |
string |
O número da versão secundária. |
v2026.3.13-1#20260320 |
| LatestVersion |
string |
O número da versão mais recente. |
v2026.3.13-1#20260320 |
| IsLatestVersion |
boolean |
Indica se a versão atual é a versão mais recente. |
true |
| NatGatewayId |
string |
O ID do NAT Gateway. |
pc-xxx |
| SnatStatus |
string |
O status do SNAT. |
off |
| CanDisableSnat |
boolean |
Indica se o SNAT pode ser desativado. |
Exemplos
Resposta de sucesso
JSON formato
{
"RequestId": "3E5CD764-FCCA-5C9C-838E-20E0DE84B2AF",
"ApplicationId": "pa-**************",
"DBClusterId": "pc-**************",
"Architecture": "x86",
"Description": "myapp",
"SecurityGroups": [
{
"SecurityGroupName": "MyGroupName",
"SecurityGroupId": "sg-**************",
"RegionId": "cn-beijing",
"NetType": "vpc"
}
],
"SecurityIPArrays": [
{
"SecurityIPArrayTag": "mytag",
"SecurityIPType": "ipv4",
"SecurityIPList": "127.0.0.1",
"SecurityIPArrayName": "default",
"SecurityIPNetType": "mix"
}
],
"Status": "Activated",
"LockMode": "Unlock",
"ApplicationType": "supabase",
"Version": "1.0.0",
"UpgradeAvailable": "false",
"MaintainStartTime": "18:00Z",
"MaintainEndTime": "19:00Z",
"PayType": "Postpaid",
"Expired": false,
"VPCId": "vpc-*******************",
"VSwitchId": "vsw-*******************",
"Components": [
{
"Status": "Activated",
"SecurityGroups": [
{
"SecurityGroupName": "MyGroupName",
"SecurityGroupId": "sg-*******************\n",
"RegionId": "cn-beijing",
"NetType": "vpc"
}
],
"ComponentType": "gateway",
"Topology": {
"Parents": [
"pac-**************"
],
"Children": [
"pac-**************"
],
"Layer": "0"
},
"SecurityIPArrays": [
{
"SecurityIPArrayTag": "mytag",
"SecurityIPType": "ipv4",
"SecurityIPList": "127.0.0.1",
"SecurityIPArrayName": "default",
"SecurityIPNetType": "mix"
}
],
"ComponentClassDescription": "2C4GB",
"ComponentId": "pac-*******************",
"ComponentClass": "polar.app.g2.medium",
"ComponentReplica": 1,
"ComponentMaxReplica": 1,
"ComponentReplicaGroupName": "default"
}
],
"Endpoints": [
{
"Description": "myendpoint",
"PortDescription": "kong_http",
"EndpointId": "pa-**************",
"IP": "172.31.95.252",
"Port": "8080",
"NetType": "Private",
"Domain": ""
}
],
"Storages": [
{
"StoragePerformanceLevel": "PL0",
"StorageInstanceId": "pa-**************",
"StorageType": "essd",
"StorageCapacity": "20Gi"
}
],
"CreationTime": "2025-03-25T09:37:10Z",
"ExpireTime": "2025-06-25T09:37:10Z",
"RegionId": "cn-beijing",
"ZoneId": "cn-beijing-l",
"PolarFSInstanceId": "pfs-**************",
"ServerlessType": "2",
"MemApplicationAttribute": {
"GraphLlmModelName": "qwen3-max",
"LlmModelName": "qwen3-max\n",
"EmbedderModelName": "text-embedding-v4\n",
"RerankerModelName": "qwen3-rerank\n",
"ProjectName": " test-project-name\n",
"DbName": "test-database-name\n",
"UserName": "test-user\n"
},
"PolarClawSaaSApplicationAttribute": {
"AuthCallbackURL": "http://8.xxx.xxx.xxx.xxx/xxx",
"SupabaseClusterId": "pa-**************",
"AuthProviders": [
""
]
},
"MinorVersion": "v2026.3.13-1#20260320",
"LatestVersion": "v2026.3.13-1#20260320",
"IsLatestVersion": true,
"NatGatewayId": "pc-xxx",
"SnatStatus": "off",
"CanDisableSnat": false
}
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.