Gunakan GetAggregateConfigRule untuk menguji detail aturan dalam grup akun - Cloud Config - Alibaba Cloud - Cloud Config

Mengkueri detail aturan tertentu dalam kelompok akun tertentu.

Deskripsi operasi

Topik ini menyediakan contoh tentang cara mengkueri detail aturan cr-7f7d626622af0041**** dalam kelompok akun ca-7f00626622af0041****.

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

config:GetAggregateConfigRule

get

*AggregateConfigRule.

acs:config:*:{#accountId}:aggregateconfigrule/{#ConfigRuleId}

None

Parameter permintaan

Parameter	Type	Required	Description	Example
ConfigRuleId	string	Yes	ID aturan. Untuk informasi tentang cara memperoleh ID aturan, lihat ListAggregateConfigRules.	cr-7f7d626622af0041****
AggregatorId	string	Yes	ID kelompok akun. Untuk informasi tentang cara memperoleh ID kelompok akun, lihat ListAggregators.	ca-7f00626622af0041****
Tag `deprecated`	array<object>	No	Tag. Parameter ini tidak digunakan lagi dan tidak berpengaruh.
	object	No	Tag Sumber daya. Parameter ini tidak digunakan lagi dan tidak berpengaruh. Maksimal 20 tag dapat ditambahkan.
Key	string	No	Kunci tag Sumber daya. Maksimal 20 kunci tag dapat ditambahkan.	key-1
Value	string	No	Nilai tag Sumber daya. Maksimal 20 nilai tag dapat ditambahkan.	value-1

Untuk informasi tentang parameter permintaan umum, lihat Parameter umum.

Elemen respons

Element	Type	Description	Example
	object	Tidak ada.
RequestId	string	ID permintaan.	811234F4-C3AB-4D15-B90B-F55016D1B5AA
ConfigRule	object	Daftar aturan.
RiskLevel	integer	Tingkat risiko aturan. Nilai valid: 1: risiko tinggi. 2: risiko menengah. 3: risiko rendah.	1
InputParameters	object	Informasi parameter aturan.	{"tag1Key":"ECS","tag1Value":"test"}
Source	object	Informasi sumber aturan.
SourceDetails	array<object>	Detail sumber aturan.
	object	Tidak ada.
MessageType	string	Mekanisme pemicu aturan. Nilai valid: ConfigurationItemChangeNotification: perubahan konfigurasi. ScheduledNotification: eksekusi berkala.	ConfigurationItemChangeNotification
EventSource	string	Sumber event. Catatan Saat ini, hanya event Konfigurasi Cloud yang didukung: aliyun.config.	aliyun.config
MaximumExecutionFrequency	string	Frekuensi eksekusi aturan. Nilai valid: One_Hour: 1 jam. Three_Hours: 3 jam. Six_Hours: 6 jam. Twelve_Hours: 12 jam. TwentyFour_Hours: 24 jam.	One_Hour
Owner	string	Pemilik sumber aturan. Nilai valid: CUSTOM_FC: aturan kustom. ALIYUN: templat aturan.	ALIYUN
Identifier	string	Pengenal aturan. Jika aturan berbasis templat aturan, parameter ini menentukan pengenal templat aturan. Jika aturan adalah aturan kustom, parameter ini menentukan ARN fungsi.	acs:fc:cn-hangzhou:100931896542****:services/ConfigService.LATEST/functions/specific-config
ConfigRuleState	string	Status berjalan aturan. Nilai valid: ACTIVE: aktif. DELETING: sedang dihapus. EVALUATING: sedang dievaluasi. INACTIVE: dinonaktifkan.	ACTIVE
MaximumExecutionFrequency	string	Frekuensi eksekusi aturan. Nilai valid: One_Hour: 1 jam. Three_Hours: 3 jam. Six_Hours: 6 jam. Twelve_Hours: 12 jam. TwentyFour_Hours: 24 jam.	One_Hour
ManagedRule	object	Detail templat aturan.
SourceDetails	array<object>	Detail sumber templat aturan.
	object	Detail sumber aturan.
MessageType	string	Mekanisme pemicu aturan. Nilai valid: ConfigurationItemChangeNotification: perubahan konfigurasi. ScheduledNotification: eksekusi berkala.	ConfigurationItemChangeNotification
EventSource	string	Sumber event. Catatan Saat ini, hanya event Konfigurasi Cloud yang didukung: aliyun.config.	aliyun.config
MaximumExecutionFrequency	string	Frekuensi eksekusi aturan. Nilai valid: One_Hour: 1 jam. Three_Hours: 3 jam. Six_Hours: 6 jam. Twelve_Hours: 12 jam. TwentyFour_Hours: 24 jam.	One_Hour
Description	string	Deskripsi templat aturan.	Disk ECS yang tidak dikunci karena tunggakan pembayaran atau alasan keamanan dianggap "compliant"
Labels	array	Daftar tag templat aturan.
	string	Tag templat aturan.	["RAM","USer"]
Identifier	string	Pengenal templat aturan.	ram-user-mfa-check
OptionalInputParameterDetails	object	Detail parameter opsional templat aturan.	{}
ManagedRuleName	string	Nama templat aturan.	MFA diaktifkan untuk pengguna RAM
CompulsoryInputParameterDetails	object	Detail parameter yang diperlukan templat aturan.	{}
ConfigRuleArn	string	ARN templat aturan.	acs:config::100931896542**:rule/cr-7f7d626622af0041**
Description	string	Deskripsi templat aturan.	Jika MFA diaktifkan untuk pengguna RAM, Sumber daya dianggap "compliant"
CreateBy	object	Informasi pembuat aturan.
CompliancePackId	string	ID paket kepatuhan.	cp-541e626622af008****
AggregatorName	string	Nama kelompok akun.	Test_Group
CompliancePackName	string	Nama paket kepatuhan.	OSS compliance baseline
CreatorName	string	Nama pembuat aturan.	Alice
CreatorType	string	Tipe pembuat aturan. Hanya `AGGREGATOR` (kelompok akun) yang didukung.	AGGREGATOR
CreatorId	string	ID akun pembuat aturan.	100931896542****
AggregatorId	string	ID kelompok akun.	ca-04b3fd170e340007****
ConfigRuleName	string	Nama aturan.	MFA diaktifkan untuk pengguna RAM
ConfigRuleEvaluationStatus	object	Status eksekusi aturan.
LastErrorCode	string	Kode kesalahan dari eksekusi aturan terbaru.	TimeOut
LastSuccessfulEvaluationTimestamp	integer	Stempel waktu UNIX akhir pemanggilan aturan berhasil terbaru. Unit: milidetik.	1624932227486
FirstActivatedTimestamp	integer	Stempel waktu UNIX saat aturan pertama kali diaktifkan. Nilai ini adalah Stempel waktu UNIX dalam milidetik.	1624932221993
FirstEvaluationStarted	boolean	Apakah aturan telah dievaluasi. Nilai valid: true: Aturan telah dievaluasi. false: Aturan belum dievaluasi.	true
LastSuccessfulInvocationTimestamp	integer	Stempel waktu UNIX mulai pemanggilan aturan berhasil terbaru. Unit: milidetik.	1624932227476
LastErrorMessage	string	Paket kesalahan dari eksekusi aturan terbaru.	time out
LastFailedEvaluationTimestamp	integer	Stempel waktu UNIX akhir pemanggilan aturan gagal terbaru. Unit: milidetik.	1614687022000
LastFailedInvocationTimestamp	integer	Stempel waktu UNIX mulai pemanggilan aturan gagal terbaru. Unit: milidetik.	1614687022000
ConfigRuleId	string	ID aturan.	cr-7f7d626622af0041****
ModifiedTimestamp	integer	Stempel waktu UNIX saat aturan terakhir diperbarui. Unit: milidetik.	1614687022000
CreateTimestamp	integer	Stempel waktu UNIX saat aturan dibuat. Unit: milidetik.	1604684022000
ResourceTypesScope	string	Tipe Sumber daya yang dievaluasi oleh aturan.	ACS::RAM::User
ExcludeRegionIdsScope	string	ID wilayah yang dikecualikan dari evaluasi aturan. Aturan tidak mengevaluasi Sumber daya di wilayah yang ditentukan. Pisahkan beberapa ID wilayah dengan koma (,).	cn-hangzhou
RegionIdsScope	string	ID wilayah sumber daya yang dievaluasi oleh aturan.	global
ExcludeResourceIdsScope	string	ID sumber daya yang dikecualikan dari evaluasi aturan.	23642660635687****
ResourceIdsScope	string	ID sumber daya yang diterapkan pada aturan. Pisahkan beberapa ID sumber daya dengan koma (,).	eip-8vbf3x310fn56ijfd****
ResourceGroupIdsScope	string	ID kelompok sumber daya yang dievaluasi oleh aturan.	rg-aekzdibsjjc****
ExcludeResourceGroupIdsScope	string	ID kelompok sumber daya yang dikecualikan dari evaluasi aturan. Aturan tidak mengevaluasi sumber daya di kelompok sumber daya yang ditentukan. Pisahkan beberapa ID kelompok sumber daya dengan koma (,).	rg-aekzdibsjjc****
TagKeyScope `deprecated`	string	[Deprecated] Gunakan bidang `TagsScope` sebagai gantinya. Kunci tag sumber daya yang dievaluasi oleh aturan.	RAM
TagValueScope `deprecated`	string	[Deprecated] Gunakan bidang `TagsScope` sebagai gantinya. Nilai tag sumber daya yang dievaluasi oleh aturan.	MFA
TagsScope	array<object>	Cakupan tag.
	object
TagKey	string	Kunci tag.	key-1
TagValue	string	Nilai tag.	value-1
ExcludeTagsScope	array<object>	Cakupan tag yang dikecualikan.
	object
TagKey	string	Kunci tag.	key-2
TagValue	string	Nilai tag.	value-2
ConfigRuleTriggerTypes	string	Mekanisme pemicu aturan. Nilai valid: ConfigurationItemChangeNotification: perubahan konfigurasi. ScheduledNotification: eksekusi berkala.	ConfigurationItemChangeNotification
TagKeyLogicScope	string	Bidang ini tidak dikembalikan untuk aturan yang dibuat menggunakan parameter `TagsScope`. Bidang ini digunakan untuk mengambil aturan yang dibuat menggunakan bidang `TagKeyScope` yang sudah tidak digunakan lagi (tidak direkomendasikan). Misalnya, jika parameter `TagKeyScope` diatur ke `ECS,OSS` dan parameter ini diatur ke `AND`, aturan hanya berlaku untuk sumber daya yang terikat pada tag `ECS` dan `OSS`. Nilai valid: AND: logika AND. OR: logika OR.	AND
FolderIdsScope	string	ID folder direktori sumber daya. Aturan hanya berlaku untuk sumber daya dalam akun anggota di bawah folder yang ditentukan.	fd-ZtHsRH****
ExcludeFolderIdsScope	string	ID folder direktori sumber daya yang dikecualikan dari evaluasi aturan. Aturan tidak mengevaluasi sumber daya dalam akun anggota di bawah folder yang ditentukan.	fd-pWmkqZ****
ExcludeAccountIdsScope	string	Akun anggota yang dikecualikan dari evaluasi aturan. Aturan tidak menjalankan evaluasi pada sumber daya dalam akun yang ditentukan.	120886317861****
ResourceNameScope	string	Nama sumber daya yang diterapkan pada aturan.	i-xxx
Compliance	object	Statistik kepatuhan aturan.
ComplianceType	string	Hasil kepatuhan. Nilai valid: COMPLIANT: patuh. NON_COMPLIANT: tidak patuh. NOT_APPLICABLE: tidak berlaku. INSUFFICIENT_DATA: data tidak mencukupi.	NON_COMPLIANT
Count	integer	Jumlah sumber daya yang dievaluasi yang sesuai dengan hasil kepatuhan.	3
AccountId	integer	ID akun Alibaba Cloud tempat aturan berada.	120886317861****
ExtendContent	string	Konten tambahan. Saat ini, parameter ini hanya digunakan untuk mengatur pengatur waktu pemicu untuk pemicu periodik 24 jam.	{"fixedHour":"12"}
Tags	array<object>	Tag sumber daya.
	object	Tag sumber daya.
TagKey	string	Kunci tag.	key-1
TagValue	string	Nilai tag.	value-1
AccountIdsScope	string	ID akun anggota yang menjadi cakupan aturan. Aturan hanya berlaku untuk sumber daya dalam akun anggota yang ditentukan. Pisahkan beberapa ID akun anggota dengan koma (,).	120886317861****

Contoh

Respons sukses

JSONformat

{
  "RequestId": "811234F4-C3AB-4D15-B90B-F55016D1B5AA",
  "ConfigRule": {
    "RiskLevel": 1,
    "InputParameters": {
      "tag1Key": "ECS",
      "tag1Value": "test"
    },
    "Source": {
      "SourceDetails": [
        {
          "MessageType": "ConfigurationItemChangeNotification",
          "EventSource": "aliyun.config",
          "MaximumExecutionFrequency": "One_Hour"
        }
      ],
      "Owner": "ALIYUN",
      "Identifier": "acs:fc:cn-hangzhou:100931896542****:services/ConfigService.LATEST/functions/specific-config"
    },
    "ConfigRuleState": "ACTIVE",
    "MaximumExecutionFrequency": "One_Hour",
    "ManagedRule": {
      "SourceDetails": [
        {
          "MessageType": "ConfigurationItemChangeNotification",
          "EventSource": "aliyun.config",
          "MaximumExecutionFrequency": "One_Hour"
        }
      ],
      "Description": "ECS磁盘未因欠费或安全等原因而被锁定，视为“合规”。",
      "Labels": [
        "[\"RAM\",\"USer\"]"
      ],
      "Identifier": "ram-user-mfa-check",
      "OptionalInputParameterDetails": {},
      "ManagedRuleName": "RAM用户开启MFA",
      "CompulsoryInputParameterDetails": {}
    },
    "ConfigRuleArn": "acs:config::100931896542****:rule/cr-7f7d626622af0041****",
    "Description": "RAM用户开启MFA，视为“合规”。",
    "CreateBy": {
      "CompliancePackId": "cp-541e626622af008****",
      "AggregatorName": "Test_Group",
      "CompliancePackName": "OSS合规基线",
      "CreatorName": "Alice",
      "CreatorType": "AGGREGATOR",
      "CreatorId": "100931896542****",
      "AggregatorId": "ca-04b3fd170e340007****"
    },
    "ConfigRuleName": "RAM用户开启MFA",
    "ConfigRuleEvaluationStatus": {
      "LastErrorCode": "TimeOut",
      "LastSuccessfulEvaluationTimestamp": 1624932227486,
      "FirstActivatedTimestamp": 1624932221993,
      "FirstEvaluationStarted": true,
      "LastSuccessfulInvocationTimestamp": 1624932227476,
      "LastErrorMessage": "time out",
      "LastFailedEvaluationTimestamp": 1614687022000,
      "LastFailedInvocationTimestamp": 1614687022000
    },
    "ConfigRuleId": "cr-7f7d626622af0041****",
    "ModifiedTimestamp": 1614687022000,
    "CreateTimestamp": 1604684022000,
    "ResourceTypesScope": "ACS::RAM::User",
    "ExcludeRegionIdsScope": "cn-hangzhou",
    "RegionIdsScope": "global",
    "ExcludeResourceIdsScope": "23642660635687****",
    "ResourceIdsScope": "eip-8vbf3x310fn56ijfd****\n",
    "ResourceGroupIdsScope": "rg-aekzdibsjjc****",
    "ExcludeResourceGroupIdsScope": "rg-aekzdibsjjc****",
    "TagKeyScope": "RAM",
    "TagValueScope": "MFA",
    "TagsScope": [
      {
        "TagKey": "key-1",
        "TagValue": "value-1"
      }
    ],
    "ExcludeTagsScope": [
      {
        "TagKey": "key-2",
        "TagValue": "value-2"
      }
    ],
    "ConfigRuleTriggerTypes": "ConfigurationItemChangeNotification",
    "TagKeyLogicScope": "AND",
    "FolderIdsScope": "fd-ZtHsRH****",
    "ExcludeFolderIdsScope": "fd-pWmkqZ****",
    "ExcludeAccountIdsScope": "120886317861****",
    "ResourceNameScope": "i-xxx",
    "Compliance": {
      "ComplianceType": "NON_COMPLIANT",
      "Count": 3
    },
    "AccountId": 0,
    "ExtendContent": "{\"fixedHour\":\"12\"}",
    "Tags": [
      {
        "TagKey": "key-1",
        "TagValue": "value-1"
      }
    ],
    "AccountIdsScope": "120886317861****\n"
  }
}

Kode kesalahan

HTTP status code	Error code	Error message
400	ConfigRuleNotExists	The ConfigRule does not exist.
400	NoPermission	You are not authorized to perform this operation.
400	Invalid.AggregatorId.Value	The specified AggregatorId is invalid.
404	AccountNotExisted	Your account does not exist.
503	ServiceUnavailable	The request has failed due to a temporary failure of the server.

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.