DescribeApplication を使用したアプリケーション詳細の查询 - ENS

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。
API：アクションを具体的に実行するための API。
アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。
リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。
- リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。
- リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。
条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。
依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

ens:DescribeApplication

get

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
AppId	string	必須	アプリケーションの ID。ListApplications 操作を呼び出して、アプリケーション ID を取得できます。	a2bac6f4-75dc-455e-8389-2dc8e47526d3
AppVersions	string	任意	アプリケーションのバージョン番号。複数のバージョン番号はコンマ (,) で区切ります。すべてのバージョンのアプリケーションのデータをクエリする場合は、このパラメーターに「All」を指定します。デフォルトでは、安定バージョンのアプリケーションのデータのみがクエリされます。	v1,v2
Level	string	任意	アプリケーションのエッジリソースが収集されるリージョンレベル。値は列挙型です。有効な値: National: 中国本土 Big: エリア Middle: 省 Small: 市 RegionId: エッジノードデフォルト値: National。列挙値: Big : Small : National : RegionId : Middle :	National
OutDetailStatParams	string	任意	リソースインスタンスや Pod の統計など、アプリケーションに関するその他の情報を返すかどうかを指定します。値は JSON 文字列である必要があります。デフォルトでは、すべての情報が返されます。	{\"appInfo\":true,\"detailStat\": true, \"appVersionStat\": true, \"districtStat\":true ,\"instanceStat\": true, \"podCountStat\": true}
ResourceSelector	string	任意	リソースフィルタリング条件。	[{\"regionCode\": \"cn-wuxi-telecom_unicom_cmcc-3\", \"ispCode\": \"telecom\", \"count\": 2 },{ \"regionCode\": \"cn-shanghai-cmcc\", \"count\": 4 }]

レスポンスフィールド

フィールド	型	説明	例
	object
Application	string	返されたアプリケーション情報。	{ "AppMetaData":{ "AppId":"b0b27670-87d5-4c40-9ea8-adeeec2986ce", "AppName":"asp-yz", "ClusterName":"poc", "AppStableVersion":"0825", "AppType":"Scheduler", "Description":"日常测试CPU环境", "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":"白屏化测试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":"华东,,", "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	リクエストの ID。	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E

例

成功レスポンス

JSONJSON

{
  "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\":\"日常测试CPU环境\",\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\":\"白屏化测试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\":\"华东,,\",\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"
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
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.

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。