GetStackGroup - Resource Orchestration Service - Alibaba Cloud Documentation Center

Mengkueri detail Grup tumpukan berdasarkan nama di suatu wilayah.

Deskripsi operasi

Topik ini menyediakan contoh untuk mengkueri informasi Grup tumpukan yang ada bernama MyStackGroup yang menggunakan model izin yang dikelola sendiri di wilayah China (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

ros:GetStackGroup

get

*StackGroup.

acs:ros:{#regionId}:{#accountId}:stackgroup/{#StackGroupName}

None

Parameter permintaan

Parameter	Type	Required	Description	Example
RegionId	string	Yes	ID wilayah Grup tumpukan. Anda dapat memanggil operasi DescribeRegions untuk mengkueri daftar wilayah terbaru.	cn-hangzhou
StackGroupName	string	No	Nama Grup tumpukan. Nama harus unik dalam suatu wilayah. Panjang nama dapat mencapai 255 karakter, dan harus dimulai dengan angka atau huruf. Nama dapat berisi angka, huruf, tanda hubung (-), dan garis bawah (_). Catatan Anda hanya perlu menentukan salah satu parameter StackGroupName atau StackGroupId.	MyStackGroup
StackGroupId	string	No	ID Grup tumpukan. Catatan Anda hanya perlu menentukan salah satu parameter StackGroupName atau StackGroupId.	fd0ddef9-9540-4b42-a464-94f77835****

Untuk informasi lebih lanjut mengenai parameter permintaan umum, lihat Parameter umum.

Elemen respons

Element	Type	Description	Example
	object
RequestId	string	ID permintaan.	14A07460-EBE7-47CA-9757-12CC4761D47A
StackGroup	object	Detail Grup tumpukan.
StackGroupId	string	ID Grup tumpukan.	fd0ddef9-9540-4b42-a464-94f77835****
Status	string	Status Grup tumpukan. Nilai valid: ACTIVE: Aktif. DELETED: Dihapus.	ACTIVE
AdministrationRoleName	string	Nama peran administrator RAM yang diambil alih oleh Resource Orchestration Service (ROS) saat Anda membuat Grup tumpukan yang menggunakan model izin yang dikelola sendiri. Jika Anda tidak menentukan parameter ini, nilai default AliyunROSStackGroupAdministrationRole akan dikembalikan.	AliyunROSStackGroupAdministrationRole
Parameters	array<object>	Parameter Grup tumpukan.
	object
ParameterKey	string	Nama parameter.	Amount
ParameterValue	string	Nilai parameter.	12
Description	string	Deskripsi Grup tumpukan.	StackGroup Description
StackGroupName	string	Nama Grup tumpukan.	MyStackGroup
ExecutionRoleName	string	Nama peran eksekusi RAM yang diambil alih oleh peran administrator (AliyunROSStackGroupAdministrationRole) saat Anda membuat Grup tumpukan yang menggunakan model izin yang dikelola sendiri. Jika Anda tidak menentukan parameter ini, nilai default AliyunROSStackGroupExecutionRole akan dikembalikan.	AliyunROSStackGroupExecutionRole
TemplateBody	string	Struktur isi Templat. Catatan Parameter respons ini tidak direkomendasikan. Gunakan TemplateContent sebagai gantinya.	{"ROSTemplateFormatVersion": "2015-09-01"}
StackGroupDriftDetectionDetail	object	Detail Pendeteksian drift terakhir yang berhasil untuk Grup tumpukan.
DriftDetectionTime	string	Pengatur waktu saat Pendeteksian drift dilakukan pada Grup tumpukan. Pengatur waktu dalam format YYYY-MM-DDThh:mm:ss.	2020-02-27T07:47:47
TotalStackInstancesCount	integer	Jumlah total Instans tumpukan.	2
FailedStackInstancesCount	integer	Jumlah Instans tumpukan yang gagal dalam Pendeteksian drift.	0
DriftDetectionStatus	string	Status Pendeteksian drift Grup tumpukan. Nilai valid: COMPLETED: Pendeteksian drift selesai, dan semua Instans tumpukan telah berhasil menyelesaikan Pendeteksian drift. FAILED: Pendeteksian drift selesai, dan jumlah Instans tumpukan yang gagal dalam Pendeteksian drift melebihi ambang batas yang ditentukan. PARTIAL_SUCCESS: Pendeteksian drift selesai, dan beberapa Instans tumpukan gagal dalam Pendeteksian drift, tetapi jumlah Instans yang gagal tidak melebihi ambang batas. IN_PROGRESS: Pendeteksian drift sedang berlangsung. STOPPED: Pendeteksian drift dibatalkan oleh pengguna.	COMPLETED
StackGroupDriftStatus	string	Status deviasi Grup tumpukan. Nilai valid: DRIFTED: Setidaknya satu Instans tumpukan telah mengalami deviasi. NOT_CHECKED: Tidak ada Pendeteksian drift yang berhasil dilakukan pada Grup tumpukan. IN_SYNC: Semua Instans tumpukan berada dalam keadaan sinkron.	DRIFTED
InProgressStackInstancesCount	integer	Jumlah Instans tumpukan yang sedang menjalani Pendeteksian drift.	0
InSyncStackInstancesCount	integer	Jumlah Instans tumpukan yang berada dalam keadaan sinkron.	1
CancelledStackInstancesCount	integer	Jumlah Instans tumpukan yang Pendeteksian drift-nya dibatalkan.	0
DriftedStackInstancesCount	integer	Jumlah Instans tumpukan yang telah mengalami deviasi.	1
ResourceGroupId	string	ID kelompok sumber daya. Nilai ini bergantung pada ID kelompok sumber daya yang ditentukan saat Grup tumpukan dibuat.	rg-acfmxazb4ph6aiy****
PermissionModel	string	Model izin. Nilai valid: SELF_MANAGED: Model izin yang dikelola sendiri. SERVICE_MANAGED: Model izin yang dikelola layanan. Catatan Untuk informasi lebih lanjut mengenai model izin Grup tumpukan, lihat Ikhtisar.	SELF_MANAGED
AutoDeployment	object	Pengaturan penerapan otomatis. Catatan Parameter ini hanya dikembalikan ketika PermissionModel diatur ke SERVICE_MANAGED.
Enabled	boolean	Apakah akan mengaktifkan Penerapan otomatis. Nilai valid: true: Mengaktifkan Penerapan otomatis. Setelah Penerapan otomatis diaktifkan, jika akun anggota ditambahkan ke folder target, Grup tumpukan secara otomatis menerapkan Instans tumpukan ke wilayah yang ditentukan pada akun baru. Jika akun dihapus dari folder target, Grup tumpukan menghapus Instans tumpukan dari wilayah yang ditentukan pada akun tersebut. false: Menonaktifkan Penerapan otomatis. Setelah Penerapan otomatis dinonaktifkan, Instans tumpukan tidak berubah ketika akun anggota di folder target berubah.	true
RetainStacksOnAccountRemoval	boolean	Apakah akan mempertahankan stack di akun anggota ketika akun anggota dihapus dari folder target. Nilai valid: true: Mempertahankan stack. false: Menghapus stack. Catatan Parameter ini hanya dikembalikan ketika Enabled diatur ke true.	true
RdFolderIds	array	Daftar ID folder target di direktori sumber daya. Instans tumpukan diterapkan ke semua akun di dalam folder. Catatan Parameter ini hanya dikembalikan ketika PermissionModel diatur ke SERVICE_MANAGED.
	string	Daftar ID folder target di direktori sumber daya. Instans tumpukan diterapkan ke semua akun di dalam folder. Catatan Parameter ini hanya dikembalikan ketika PermissionModel diatur ke SERVICE_MANAGED.	["fd-4PvlVLOL8v"]
TemplateContent	string	Struktur isi templat dalam format JSON. Untuk informasi lebih lanjut, lihat Sintaks templat.	{ "ROSTemplateFormatVersion": "2015-09-01" }
CreateTime	string	Pengatur waktu saat Grup tumpukan dibuat. Pengatur waktu dalam format YYYY-MM-DDThh:mm:ss.	2024-06-14T02:13:50
UpdateTime	string	Pengatur waktu saat Grup tumpukan diperbarui. Pengatur waktu dalam format YYYY-MM-DDThh:mm:ss.	2024-06-15T02:01:00

Contoh

Respons sukses

JSONformat

{
  "RequestId": "14A07460-EBE7-47CA-9757-12CC4761D47A",
  "StackGroup": {
    "StackGroupId": "fd0ddef9-9540-4b42-a464-94f77835****",
    "Status": "ACTIVE",
    "AdministrationRoleName": "AliyunROSStackGroupAdministrationRole",
    "Parameters": [
      {
        "ParameterKey": "Amount",
        "ParameterValue": "12"
      }
    ],
    "Description": "StackGroup Description",
    "StackGroupName": "MyStackGroup",
    "ExecutionRoleName": "AliyunROSStackGroupExecutionRole",
    "TemplateBody": "{\"ROSTemplateFormatVersion\": \"2015-09-01\"}",
    "StackGroupDriftDetectionDetail": {
      "DriftDetectionTime": "2020-02-27T07:47:47",
      "TotalStackInstancesCount": 2,
      "FailedStackInstancesCount": 0,
      "DriftDetectionStatus": "COMPLETED",
      "StackGroupDriftStatus": "DRIFTED",
      "InProgressStackInstancesCount": 0,
      "InSyncStackInstancesCount": 1,
      "CancelledStackInstancesCount": 0,
      "DriftedStackInstancesCount": 1
    },
    "ResourceGroupId": "rg-acfmxazb4ph6aiy****",
    "PermissionModel": "SELF_MANAGED",
    "AutoDeployment": {
      "Enabled": true,
      "RetainStacksOnAccountRemoval": true
    },
    "RdFolderIds": [
      "[\"fd-4PvlVLOL8v\"]"
    ],
    "TemplateContent": "{\n      \"ROSTemplateFormatVersion\": \"2015-09-01\"\n}",
    "CreateTime": "2024-06-14T02:13:50",
    "UpdateTime": "2024-06-15T02:01:00"
  }
}

Kode kesalahan

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.