Referensi API GetApplicationGroup - Layanan Orkestrasi CloudOps - Alibaba Cloud - CloudOps Orchestration Service

Mengambil detail kelompok aplikasi. Layanan manajemen aplikasi hanya tersedia di wilayah China (Hangzhou). Gunakan Titik akhir Hangzhou.

Coba sekarang

Coba API ini di OpenAPI Explorer tanpa perlu penandatanganan manual. Panggilan yang berhasil akan secara otomatis menghasilkan contoh kode SDK sesuai dengan parameter Anda. Unduh kode tersebut dengan kredensial bawaan yang aman untuk penggunaan lokal.

Test

RAM authorization

Tabel berikut menjelaskan otorisasi yang diperlukan untuk memanggil API ini. Anda dapat menentukannya dalam kebijakan Resource Access Management (RAM). Kolom pada tabel dijelaskan sebagai berikut:

Action: Aksi yang dapat digunakan dalam elemen Action pada pernyataan kebijakan izin RAM untuk memberikan izin guna melakukan operasi tersebut.
API: API yang dapat Anda panggil untuk melakukan aksi tersebut.
Access level: Tingkat akses yang telah ditentukan untuk setiap API. Nilai yang valid: create, list, get, update, dan delete.
Resource type: Jenis resource yang mendukung otorisasi untuk melakukan aksi tersebut. Ini menunjukkan apakah aksi tersebut mendukung izin tingkat resource. Resource yang ditentukan harus kompatibel dengan aksi tersebut. Jika tidak, kebijakan tersebut tidak akan berlaku.
- Untuk API dengan izin tingkat resource, jenis resource yang diperlukan ditandai dengan tanda bintang (*). Tentukan Nama Sumber Daya Alibaba Cloud (ARN) yang sesuai dalam elemen Resource pada kebijakan.
- Untuk API tanpa izin tingkat resource, ditampilkan sebagai All Resources. Gunakan tanda bintang (*) dalam elemen Resource pada kebijakan.
Condition key: Kunci kondisi yang didefinisikan oleh layanan. Kunci ini memungkinkan kontrol granular, berlaku baik hanya untuk aksi maupun untuk aksi yang terkait dengan resource tertentu. Selain kunci kondisi spesifik layanan, Alibaba Cloud menyediakan serangkaian common condition keys yang berlaku di semua layanan yang didukung RAM.
Dependent action: Aksi dependen yang diperlukan untuk menjalankan aksi tersebut. Untuk menyelesaikan aksi tersebut, pengguna RAM atau role RAM harus memiliki izin untuk melakukan semua aksi dependen.

Action

Access level

Resource type

Condition key

Dependent action

oos:GetApplicationGroup

get

*ApplicationGroup.

acs:oos:{#regionId}:{#AccountId}:application/{#applicationName}/applicationgroup/{#applicationGroupName}

oos:TLSVersion

None

Parameter permintaan

Parameter	Type	Required	Description	Example
RegionId	string	No	ID wilayah. Saat ini, hanya cn-hangzhou yang didukung.	cn-hangzhou
Name	string	Yes	Nama kelompok aplikasi.	MyApplicationGroup
ApplicationName	string	Yes	Nama aplikasi.	MyApplication
ShowMonitorURL	boolean	No	Apakah akan mengembalikan URL Pemantauan aplikasi.	true

Elemen respons

Element	Type	Description	Example
	object
ApplicationGroup	object	Detail kelompok aplikasi.
ApplicationName	string	Nama aplikasi.	MyApplication
ApplicationSource	string	Sumber aplikasi.	{"Platform":"github","RepoName":"xxx/springboot-ecs-sourcecode-demo","Owner":"xxx","Branch":"main","CommitHash":"8559ff3xxxxxxxxxf06c6fe","CommitMessage":"Init computenest project"}
CmsGroupId	string	ID kelompok CloudMonitor.	12345678
CreateDate	string	Waktu ketika kelompok aplikasi dibuat, dalam format ISO 8601 UTC.	2021-09-07T10:28:25Z
DeployOutputs	string	Output hasil Penerapan.	{ "Outputs": [ { "Description": "No description given", "OutputKey": "InstanceIds" } ], "StackId": "6ef4b860-f6e7-4145-8d22-f4a2a32363e1" }
DeployParameters	string	Informasi konfigurasi kelompok aplikasi.	{ "TemplateURL": "https://ros-template.oss-cn-zhangjiakou.aliyuncs.com/App_Management_Existing_Vpc_Ecs_Instance.json", "Parameters": { "ZoneId": "cn-hangzhou-k", "ProjectName": "test", "SystemDiskSize": 40, "InstanceChargeType": "PostPaid", "SecurityGroupId": "sg-bp1a4374akk63jl8tddy", "VSwitchId": "vsw-bp1fcvc3zn0jrag86rrlm", "SystemDiskCategory": "cloud_essd", "InstancePassword": "******", "InternetChargeType": "PayByTraffic", "InstanceCount": 1, "InternetMaxBandwidthOut": 0, "VpcId": "vpc-bp1i99boyas8i8m9t3skp", "EcsImageId": "centos_8_5_x64_20G_alibase_20211228.vhd", "DataDiskSize": 100, "EcsInstanceType": "ecs.s6-c1m4.small", "DataDiskCategory": "cloud_efficiency", "EnvironmentCommandId": "c-hz028fc3g031gcg" } }
DeployRegionId	string	ID wilayah Penerapan.	cn-hangzhou
DeployedRevisionIds	string	Daftar ID revisi yang diterapkan. Hanya 10 revisi yang paling baru diterapkan yang ditampilkan.	["rev-f575b688015442d28d26","rev-b9876a39cf84490db638","rev-782fc7a0c0974d89b1eb"]
Description	string	Deskripsi kelompok aplikasi.	ApplicationGroup
ErrorDetail	string	Detail error dari kegagalan build.	ERROR: failed to build: executing lifecycle: failed with status code: 51
ErrorType	string	Tipe error dari kegagalan build.	Build
ExecutionId	string	ID eksekusi.	exec-f5dee943869c436a9f57
ImportTagKey	string	Kunci tag.	k1
ImportTagValue	string	Nilai tag.	v1
MonitorMetadata	string	Metadata Pemantauan.	[{"CmsProject":"workspace1","CmsApplicationName":"default"}]
MonitorURL	string	URL Pemantauan.	http//xxx.com
Name	string	Nama kelompok aplikasi.	MyApplicationGroup
OperationMetadata	string	Konfigurasi O&M terkelola.	{\"PrometheusConfigMap\":{\"template1\":{\"EnablePrometheus\":false}}}
Progress	string	Progres pembuatan instans aplikasi.	100
Status	string	Status kelompok aplikasi.	Created
StatusReason	string	Detail status kelompok aplikasi.	Stack CREATE completed successfully
UpdateDate	string	Waktu terakhir pembaruan kelompok aplikasi, dalam format ISO 8601 UTC.	2021-09-07T10:28:25Z
RequestId	string	ID permintaan.	92EA60ED-544D-55E9-93D9-237BE9976C0D

Contoh

Respons sukses

JSONformat

{
  "ApplicationGroup": {
    "ApplicationName": "MyApplication",
    "ApplicationSource": "{\"Platform\":\"github\",\"RepoName\":\"xxx/springboot-ecs-sourcecode-demo\",\"Owner\":\"xxx\",\"Branch\":\"main\",\"CommitHash\":\"8559ff3xxxxxxxxxf06c6fe\",\"CommitMessage\":\"Init computenest project\"}",
    "CmsGroupId": "12345678",
    "CreateDate": "2021-09-07T10:28:25Z",
    "DeployOutputs": "{       \"Outputs\": [         {           \"Description\": \"No description given\",           \"OutputKey\": \"InstanceIds\"         }       ],       \"StackId\": \"6ef4b860-f6e7-4145-8d22-f4a2a32363e1\"     }",
    "DeployParameters": "{       \"TemplateURL\": \"https://ros-template.oss-cn-zhangjiakou.aliyuncs.com/App_Management_Existing_Vpc_Ecs_Instance.json\",       \"Parameters\": {         \"ZoneId\": \"cn-hangzhou-k\",         \"ProjectName\": \"test\",         \"SystemDiskSize\": 40,         \"InstanceChargeType\": \"PostPaid\",         \"SecurityGroupId\": \"sg-bp1a4374akk63jl8tddy\",         \"VSwitchId\": \"vsw-bp1fcvc3zn0jrag86rrlm\",         \"SystemDiskCategory\": \"cloud_essd\",         \"InstancePassword\": \"******\",         \"InternetChargeType\": \"PayByTraffic\",         \"InstanceCount\": 1,         \"InternetMaxBandwidthOut\": 0,         \"VpcId\": \"vpc-bp1i99boyas8i8m9t3skp\",         \"EcsImageId\": \"centos_8_5_x64_20G_alibase_20211228.vhd\",         \"DataDiskSize\": 100,         \"EcsInstanceType\": \"ecs.s6-c1m4.small\",         \"DataDiskCategory\": \"cloud_efficiency\",         \"EnvironmentCommandId\": \"c-hz028fc3g031gcg\"       }\n}",
    "DeployRegionId": "cn-hangzhou",
    "DeployedRevisionIds": "[\"rev-f575b688015442d28d26\",\"rev-b9876a39cf84490db638\",\"rev-782fc7a0c0974d89b1eb\"]",
    "Description": "ApplicationGroup",
    "ErrorDetail": "ERROR: failed to build: executing lifecycle: failed with status code: 51",
    "ErrorType": "Build",
    "ExecutionId": "exec-f5dee943869c436a9f57",
    "ImportTagKey": "k1",
    "ImportTagValue": "v1",
    "MonitorMetadata": "[{\"CmsProject\":\"workspace1\",\"CmsApplicationName\":\"default\"}]",
    "MonitorURL": "http//xxx.com",
    "Name": "MyApplicationGroup",
    "OperationMetadata": "{\\\"PrometheusConfigMap\\\":{\\\"template1\\\":{\\\"EnablePrometheus\\\":false}}}",
    "Progress": "100",
    "Status": "Created",
    "StatusReason": "Stack CREATE completed successfully",
    "UpdateDate": "2021-09-07T10:28:25Z"
  },
  "RequestId": "92EA60ED-544D-55E9-93D9-237BE9976C0D"
}

Kode kesalahan

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.