DescribeApplication - ENS: Central de Documentação do Alibaba Cloud

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

ens:DescribeApplication

get

*All Resource

*

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
AppId	string	Sim	O ID da aplicação. Você pode chamar a operação ListApplications para obter o ID da aplicação.	a2bac6f4-75dc-455e-8389-2dc8e47526d3
AppVersions	string	Não	O número da versão da aplicação. Separe múltiplos números de versão com vírgulas (,). Se você deseja consultar dados de todas as versões das aplicações, especifique All para este parâmetro. Por padrão, apenas dados de aplicações nas versões estáveis são consultados.	v1,v2
Level	string	Não	O nível de região pelo qual os recursos de borda da aplicação são coletados. O valor é do tipo enumeração. Valores válidos: National: China continental Big: área Middle: província Small: cidade RegionId: nó de borda Valor padrão: National. Valores válidos: Big : Small : National : RegionId : Middle :	National
OutDetailStatParams	string	Não	Especifica se devem ser retornadas outras informações sobre a aplicação, como estatísticas de instâncias de recursos e pods. O valor deve ser uma string JSON. Por padrão, todas as informações são retornadas.	{\"appInfo\":true,\"detailStat\": true, \"appVersionStat\": true, \"districtStat\":true ,\"instanceStat\": true, \"podCountStat\": true}
ResourceSelector	string	Não	A condição de filtragem de recursos.	[{\"regionCode\": \"cn-wuxi-telecom_unicom_cmcc-3\", \"ispCode\": \"telecom\", \"count\": 2 },{ \"regionCode\": \"cn-shanghai-cmcc\", \"count\": 4 }]

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
Application	string	As informações da aplicação retornadas.	{ "AppMetaData":{ "AppId":"b0b27670-87d5-4c40-9ea8-adeeec2986ce", "AppName":"asp-yz", "ClusterName":"poc", "AppStableVersion":"0825", "AppType":"Scheduler", "Description":"Daily test CPU environment", "CreateTime":"2020-08-25 16:36:16" }, "AppStatus":{ "Phase":"RUNNING", "StatusDescrip":"{\"status\":\"UPDATE_SUCCESS\",\"step\":\"DONE\",\"descrip\":\"delVersion success\",\"start_time\":\"2021-08-18 14:46:45\"}", "UpdateTime":"2021-08-18 14:46:45" }, "ResourceAttribute":{ "ResourceType":"Ens", "ResourceAgent":"Linux", "InstanceSpec":"ens.sn1.large", "SystemDiskSize":40, "DataDiskSize":0, "BandwithOut":10, "SchedulingStrategy":"Disperse", "AreaLevel":"RegionId", "IpType":"PublicIP" }, "WorkloadAttribute":[ { "Name":"andorid", "PodCount":7, "ServiceConfig":{ "PortsBindConfig":{ "NetServiceContainer":"aspserver-android", "Ports":[ { "Protocol":"TCP", "BindType":"PassThrough", "StartNodePorts":"5000-5000", "ContainerPorts":"5000-5000" }, { "Protocol":"UDP", "BindType":"PassThrough", "StartNodePorts":"4001-4010", "ContainerPorts":"4001-4010" } ] }, "ServiceContainerName":"android" } }, { "Name":"aic-manager", "PodCount":1, "ServiceConfig":null } ], "DetailStat":{ "Level":"Small", "InstanceTotalCount":1, "InstanceRunningCount":0, "PodCountStat":[ { "Name":"andorid", "RunningCount":7, "ProducedCount":7, "Devices":null }, { "Name":"aic-manager", "RunningCount":1, "ProducedCount":1, "Devices":null } ], "AppVersionStat":[ { "AppVersion":"08102", "Descrip":"GUI-based test 2", "CreateTime":"2021-08-10 11:20:04", "InstanceTotalCount":1, "InstanceRunningCount":0, "PodCountStat":[ { "Name":"andorid", "RunningCount":7, "ProducedCount":7, "Devices":null }, { "Name":"aic-manager", "RunningCount":1, "ProducedCount":1, "Devices":null } ], "DistrictStat":[ { "AreaCode":"310100", "AreaName":"East China,,", "RegionCode":"310100", "RegionName":"", "IspCode":"telecom", "RegionIds":[ "cn-shanghai-telecom-2" ], "InstanceTotalCount":1, "InstanceRunningCount":0, "PodCountStat":[ { "Name":"andorid", "RunningCount":7, "ProducedCount":7, "Devices":null }, { "Name":"aic-manager", "RunningCount":1, "ProducedCount":1, "Devices":null } ], "InstanceStat":[ { "InstanceId":"i-xxxxxxx", "PublicIps":[ { "PublicIp":"101.227.7.12", "Isp":"telecom" } ], "InternalIps":[ { "Ip":"10.0.1.4" } ], "RegionId":"cn-shanghai-telecom-2", "NcName":"", "InstanceStatus":"", "CreateTime":"2020-09-12 22:33:08", "PodCountStat":[ { "Name":"andorid", "RunningCount":7, "ProducedCount":7, "Devices":[ { "Name":"asp-yz-andorid-08102-zjzmcyaw-0", "Status":"Running", "Ports":null }, { "Name":"asp-yz-andorid-08102-zjzmcyaw-1", "Status":"Running", "Ports":null }, { "Name":"asp-yz-andorid-08102-zjzmcyaw-2", "Status":"Running", "Ports":null }, { "Name":"asp-yz-andorid-08102-zjzmcyaw-3", "Status":"Running", "Ports":null }, { "Name":"asp-yz-andorid-08102-zjzmcyaw-4", "Status":"Running", "Ports":null }, { "Name":"asp-yz-andorid-08102-zjzmcyaw-5", "Status":"Running", "Ports":null }, { "Name":"asp-yz-andorid-08102-zjzmcyaw-6", "Status":"Running", "Ports":null } ] }, { "Name":"aic-manager", "RunningCount":1, "ProducedCount":1, "Devices":[ { "Name":"asp-yz-aic-manager-08102-zjzmcyaw-0", "Status":"Running", "Ports":null } ] } ], "AppVersionDescrip":"" } ] } ] } ] } }
RequestId	string	O ID da solicitação.	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E

Exemplos

Resposta de sucesso

JSON formato

{
  "Application": "{\n    \"AppMetaData\":{\n        \"AppId\":\"b0b27670-87d5-4c40-9ea8-adeeec2986ce\",\n        \"AppName\":\"asp-yz\",\n        \"ClusterName\":\"poc\",\n        \"AppStableVersion\":\"0825\",\n        \"AppType\":\"Scheduler\",\n        \"Description\":\"Daily test CPU environment\",\n        \"CreateTime\":\"2020-08-25 16:36:16\"\n    },\n    \"AppStatus\":{\n        \"Phase\":\"RUNNING\",\n        \"StatusDescrip\":\"{\\\"status\\\":\\\"UPDATE_SUCCESS\\\",\\\"step\\\":\\\"DONE\\\",\\\"descrip\\\":\\\"delVersion success\\\",\\\"start_time\\\":\\\"2021-08-18 14:46:45\\\"}\",\n        \"UpdateTime\":\"2021-08-18 14:46:45\"\n    },\n    \"ResourceAttribute\":{\n        \"ResourceType\":\"Ens\",\n        \"ResourceAgent\":\"Linux\",\n        \"InstanceSpec\":\"ens.sn1.large\",\n        \"SystemDiskSize\":40,\n        \"DataDiskSize\":0,\n        \"BandwithOut\":10,\n        \"SchedulingStrategy\":\"Disperse\",\n        \"AreaLevel\":\"RegionId\",\n        \"IpType\":\"PublicIP\"\n    },\n    \"WorkloadAttribute\":[\n        {\n            \"Name\":\"andorid\",\n            \"PodCount\":7,\n            \"ServiceConfig\":{\n                \"PortsBindConfig\":{\n                    \"NetServiceContainer\":\"aspserver-android\",\n                    \"Ports\":[\n                        {\n                            \"Protocol\":\"TCP\",\n                            \"BindType\":\"PassThrough\",\n                            \"StartNodePorts\":\"5000-5000\",\n                            \"ContainerPorts\":\"5000-5000\"\n                        },\n                        {\n                            \"Protocol\":\"UDP\",\n                            \"BindType\":\"PassThrough\",\n                            \"StartNodePorts\":\"4001-4010\",\n                            \"ContainerPorts\":\"4001-4010\"\n                        }\n                    ]\n                },\n                \"ServiceContainerName\":\"android\"\n            }\n        },\n        {\n            \"Name\":\"aic-manager\",\n            \"PodCount\":1,\n            \"ServiceConfig\":null\n        }\n    ],\n    \"DetailStat\":{\n        \"Level\":\"Small\",\n        \"InstanceTotalCount\":1,\n        \"InstanceRunningCount\":0,\n        \"PodCountStat\":[\n            {\n                \"Name\":\"andorid\",\n                \"RunningCount\":7,\n                \"ProducedCount\":7,\n                \"Devices\":null\n            },\n            {\n                \"Name\":\"aic-manager\",\n                \"RunningCount\":1,\n                \"ProducedCount\":1,\n                \"Devices\":null\n            }\n        ],\n        \"AppVersionStat\":[\n            {\n                \"AppVersion\":\"08102\",\n                \"Descrip\":\"GUI-based test 2\",\n                \"CreateTime\":\"2021-08-10 11:20:04\",\n                \"InstanceTotalCount\":1,\n                \"InstanceRunningCount\":0,\n                \"PodCountStat\":[\n                    {\n                        \"Name\":\"andorid\",\n                        \"RunningCount\":7,\n                        \"ProducedCount\":7,\n                        \"Devices\":null\n                    },\n                    {\n                        \"Name\":\"aic-manager\",\n                        \"RunningCount\":1,\n                        \"ProducedCount\":1,\n                        \"Devices\":null\n                    }\n                ],\n                \"DistrictStat\":[\n                    {\n                        \"AreaCode\":\"310100\",\n                        \"AreaName\":\"East China,,\",\n                        \"RegionCode\":\"310100\",\n                        \"RegionName\":\"\",\n                        \"IspCode\":\"telecom\",\n                        \"RegionIds\":[\n                            \"cn-shanghai-telecom-2\"\n                        ],\n                        \"InstanceTotalCount\":1,\n                        \"InstanceRunningCount\":0,\n                        \"PodCountStat\":[\n                            {\n                                \"Name\":\"andorid\",\n                                \"RunningCount\":7,\n                                \"ProducedCount\":7,\n                                \"Devices\":null\n                            },\n                            {\n                                \"Name\":\"aic-manager\",\n                                \"RunningCount\":1,\n                                \"ProducedCount\":1,\n                                \"Devices\":null\n                            }\n                        ],\n                        \"InstanceStat\":[\n                            {\n                                \"InstanceId\":\"i-xxxxxxx\",\n                                \"PublicIps\":[\n                                    {\n                                        \"PublicIp\":\"101.227.7.12\",\n                                        \"Isp\":\"telecom\"\n                                    }\n                                ],\n                                \"InternalIps\":[\n                                    {\n                                        \"Ip\":\"10.0.1.4\"\n                                    }\n                                ],\n                                \"RegionId\":\"cn-shanghai-telecom-2\",\n                                \"NcName\":\"\",\n                                \"InstanceStatus\":\"\",\n                                \"CreateTime\":\"2020-09-12 22:33:08\",\n                                \"PodCountStat\":[\n                                    {\n                                        \"Name\":\"andorid\",\n                                        \"RunningCount\":7,\n                                        \"ProducedCount\":7,\n                                        \"Devices\":[\n                                            {\n                                                \"Name\":\"asp-yz-andorid-08102-zjzmcyaw-0\",\n                                                \"Status\":\"Running\",\n                                                \"Ports\":null\n                                            },\n                                            {\n                                                \"Name\":\"asp-yz-andorid-08102-zjzmcyaw-1\",\n                                                \"Status\":\"Running\",\n                                                \"Ports\":null\n                                            },\n                                            {\n                                                \"Name\":\"asp-yz-andorid-08102-zjzmcyaw-2\",\n                                                \"Status\":\"Running\",\n                                                \"Ports\":null\n                                            },\n                                            {\n                                                \"Name\":\"asp-yz-andorid-08102-zjzmcyaw-3\",\n                                                \"Status\":\"Running\",\n                                                \"Ports\":null\n                                            },\n                                            {\n                                                \"Name\":\"asp-yz-andorid-08102-zjzmcyaw-4\",\n                                                \"Status\":\"Running\",\n                                                \"Ports\":null\n                                            },\n                                            {\n                                                \"Name\":\"asp-yz-andorid-08102-zjzmcyaw-5\",\n                                                \"Status\":\"Running\",\n                                                \"Ports\":null\n                                            },\n                                            {\n                                                \"Name\":\"asp-yz-andorid-08102-zjzmcyaw-6\",\n                                                \"Status\":\"Running\",\n                                                \"Ports\":null\n                                            }\n                                        ]\n                                    },\n                                    {\n                                        \"Name\":\"aic-manager\",\n                                        \"RunningCount\":1,\n                                        \"ProducedCount\":1,\n                                        \"Devices\":[\n                                            {\n                                                \"Name\":\"asp-yz-aic-manager-08102-zjzmcyaw-0\",\n                                                \"Status\":\"Running\",\n                                                \"Ports\":null\n                                            }\n                                        ]\n                                    }\n                                ],\n                                \"AppVersionDescrip\":\"\"\n                            }\n                        ]\n                    }\n                ]\n            }\n        ]\n    }\n}",
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E"
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
400	MissingParameter	The input parameter that is mandatory for processing this request is not supplied.
400	NoPermission	Permission denied.
400	InvalidParameter.%s	The specified field %s invalid. Please check it again.
400	InvalidParameter	The errorMessage is %s. Please check it again.
400	ens.interface.error	An error occurred while calling the API.
400	CallInterface	Call Interface Happen Error.	An error occurred when you call the operation.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.