properti dan atribut sintaks ALIYUN::ROS::ResourceCleaner - Resource Orchestration Service - Alibaba Cloud - Resource Orchestration Service

ALIYUN::ROS::ResourceCleaner membuat pembersih resource yang memindai dan membersihkan resource.

Jenis resource yang didukung

Catatan

ROS terus menambahkan dukungan untuk lebih banyak jenis resource. Anda dapat memanggil operasi GetFeatureDetails untuk mendapatkan daftar jenis resource yang didukung.

Layanan Alibaba Cloud	Jenis resource
ACM	ACM:Namespace
ACTIONTRAIL	ACTIONTRAIL:Trail
ALB	ALB:Acl ALB:HealthCheckTemplate ALB:LoadBalancer ALB:SecurityPolicy ALB:ServerGroup




ApiGateway	ApiGateway:App ApiGateway:Group ApiGateway:Instance ApiGateway:LogConfig ApiGateway:Plugin ApiGateway:Signature ApiGateway:TrafficControl






ARMS	ARMS:AlertContact ARMS:AlertContactGroup ARMS:RetcodeApp


ASM	ASM:ServiceMesh
CAS	CAS:Certificate
CDDC	CDDC:DedicatedHostGroup
CDN	CDN:Domain
ClickHouse	ClickHouse:DBCluster
CloudPhone	CloudPhone:InstanceGroup
CMS	CMS:Contact CMS:ContactGroup CMS:MetricRuleTemplate CMS:MonitorGroup CMS:SiteMonitor




CS	CS:Cluster
CR	CR:Instance
DATAHUB	DATAHUB:Project
DCDN	DCDN:Domain
DFS	DFS:AccessGroup DFS:FileSystem
DFS	DFS:AccessGroup DFS:FileSystem
DirectMail	DirectMail:Domain DirectMail:Ipfilter
DirectMail	DirectMail:Domain DirectMail:Ipfilter
DNS	DNS:Domain DNS:DomainGroup
DNS	DNS:Domain DNS:DomainGroup
DRDS	DRDS:DrdsInstance
ECI	ECI:ContainerGroup ECI:ImageCache
ECI	ECI:ContainerGroup ECI:ImageCache
ECS	ECS:AutoProvisioningGroup ECS:AutoSnapshotPolicy ECS:Command ECS:CustomImage ECS:DedicatedHost ECS:DeploymentSet ECS:Disk ECS:HpcCluster ECS:Instance ECS:LaunchTemplate ECS:NetworkInterface ECS:PrefixList ECS:SSHKeyPair ECS:SecurityGroup ECS:Snapshot
VPC	VPC:AnycastEIP VPC:CommonBandwidthPackage VPC:DhcpOptionsSet VPC:EIP VPC:EipSegment VPC:FlowLog VPC:HaVip VPC:Ipv6Gateway VPC:NatGateway VPC:NetworkAcl VPC:RouteTable VPC:VPC VPC:VSwitch
RAM	RAM:Group RAM:ManagedPolicy RAM:Role RAM:SAMLProvider RAM:User
RDS	RDS:DBInstance
ROS	ROS:Template
SLB	SLB:AccessControl SLB:Certificate SLB:LoadBalancer
ENS	ENS:Instance
ESS	ESS:AlarmTask ESS:ScalingGroup ESS:ScheduledTask
ECI	ECI:ContainerGroup ECI:ImageCache
FNF	FNF:Flow
GPDB	GPDB:DBInstance
KMS	KMS:Key KMS:Secret
KAFKA	KAFKA:Instance
MONGODB	MONGODB:Instance
Memcache	Memcache:Instance
MSE	MSE:Cluster MSE:Gateway
MNS	MNS:Topic MNS:Queue
REDIS	REDIS:Instance
SLS	SLS:Project
FC	FC:Service
NAS	NAS:AccessGroup NAS:FileSystem
NLB	NLB:LoadBalancer NLB:ServerGroup
OTS	OTS:Instance
OSS	OSS:Bucket
OOS	OOS:Execution OOS:Template OOS:PatchBaseline OOS:Parameter OOS:SecretParameter
POLARDB	POLARDB:DBCluster
PrivateLink	PrivateLink:VpcEndpoint PrivateLink:VpcEndpointService
DRDS	DRDS:DrdsInstance
ROCKETMQ	ROCKETMQ:Instance
ADB	ADB:DBCluster
EDAS	EDAS:Application EDAS:Cluster
EMR	EMR:Cluster
ElasticSearch	ElasticSearch:Instance
HBR	HBR:DBVault
PVTZ	PVTZ:Zone
SAE	SAE:Application SAE:Namespace
SAE	SAE:Application SAE:Namespace
SAG	SAG:ACL SAG:Qos
TSDB	TSDB:HiTSDBInstance
WAF	WAF:Domain

Sintaksis

{
  "Type": "ALIYUN::ROS::ResourceCleaner",
  "Properties": {
    "Action": String,
    "ResourceFilters": List,
    "Resources": List,
    "Mode": String,
    "FailureOption": String,
    "CleanUpRetryCount": Integer,
    "CleanUpTimeout": Number,
    "ExcludedResources": List,
    "CleanUpAlgorithm": String,
    "ResourceTypeOrder": List,
    "DisabledSideEffects": List
  }
}

Properti

Nama Properti	Tipe	Wajib	Boleh diperbarui	Deskripsi	Batasan
Action	String	Ya	Ya	Aksi yang dilakukan oleh pembersih resource.	Nilai valid: Scan: Memindai resource yang perlu dibersihkan. CleanUp: Membersihkan resource yang telah dipindai. Pemindaian harus dilakukan terlebih dahulu. Nilai ini hanya dapat ditentukan saat pembaruan, bukan saat membuat pembersih resource. Scan+CleanUp: Memindai resource lalu membersihkannya. ScanWhenCreatingAndUpdating+CleanUpWhenDeleting: Memindai resource saat pembersih resource dibuat atau diperbarui, dan membersihkan resource saat pembersih resource dihapus.
ResourceFilters	List	Tidak	Ya	Filter resource yang digunakan oleh pembersih resource untuk memindai resource yang perlu dibersihkan.	Daftar dapat berisi hingga 100 filter. Anda dapat menentukan ResourceFilters atau Resources, tetapi tidak keduanya sekaligus. Jika daftar filter resource diubah selama pembaruan, pembersih resource akan memindai ulang resource. Jika Action diatur ke CleanUp, operasi akan gagal. Filter memiliki dua efek: Allow dan Deny. Mekanismenya sebagai berikut (angka yang lebih kecil menunjukkan prioritas lebih tinggi): Resource yang sesuai dengan filter Deny apa pun tidak akan dibersihkan. Hanya resource yang sesuai dengan setidaknya satu filter Allow yang akan dibersihkan. Untuk informasi selengkapnya, lihat properti ResourceFilters.
Resources	List	Tidak	Ya	Resource yang akan dibersihkan.	Daftar dapat berisi 1 hingga 1.000 resource. Anda dapat menentukan ResourceFilters atau Resources, tetapi tidak keduanya sekaligus. Untuk informasi selengkapnya, lihat properti Resources.
Mode	String	Tidak	Ya	Mode eksekusi pembersih resource.	Nilai valid: Strict: Kegagalan apa pun dalam pemindaian atau pembersihan resource menyebabkan pembersih resource gagal. Loose (default): Sebagian besar kegagalan pemindaian dan pembersihan ditoleransi. Kegagalan pemindaian dicatat di ScanErrors dan ResourceDetails. Kegagalan pembersihan dicatat di ResourceDetails.
FailureOption	String	Tidak	Ya	Perilaku untuk resource dependen ketika pembersihan resource gagal.	Nilai valid: Normal (default): Kegagalan pembersihan resource tidak memengaruhi resource dependen. Fast: Kegagalan pembersihan resource menyebabkan resource dependen gagal. Catatan Dependensi ini adalah dependensi penghapusan, bukan dependensi pembuatan.
CleanUpRetryCount	Integer	Tidak	Ya	Jumlah maksimum percobaan ulang pembersihan.	Nilai valid: 1 hingga 6. Nilai default adalah 1, artinya tidak ada percobaan ulang. Percobaan ulang dipicu jika salah satu kondisi berikut terpenuhi: Pembersihan resource gagal. Pembersihan melebihi timeout.
CleanUpTimeout	Number	Tidak	Ya	Periode timeout untuk pembersihan resource.	Nilai valid: 60 hingga 14400. Unit: detik. Nilai default: 3600.
ExcludedResources	List	Tidak	Ya	Resource yang dikecualikan dari pembersihan.	Daftar dapat berisi 1 hingga 1.000 resource. Setiap item hanya dapat mengecualikan satu resource. Jika suatu item ambigu dan mengarah ke beberapa resource, operasi akan gagal. Tentukan lebih banyak bidang untuk menghilangkan ambiguitas. Untuk informasi selengkapnya, lihat properti ExcludedResources.
CleanUpAlgorithm	String	Tidak	Ya	Algoritma pembersihan resource.	Nilai valid: ResourceDependency (default): Resource dibersihkan berdasarkan dependensinya. ResourceTypeOrder: Resource dibersihkan sesuai urutan jenis resource. Anda dapat menggunakan properti ResourceTypeOrder untuk menentukan urutannya. Jika Anda tidak menentukan properti ini, sistem akan menggunakan urutan default. Urutan default mencakup semua jenis resource yang didukung.
ResourceTypeOrder	List	Tidak	Ya	Urutan pembersihan berdasarkan jenis resource.	Jumlah item dalam daftar harus berkisar antara 1 hingga 1.000. Parameter ini hanya berlaku jika CleanUpAlgorithm diatur ke ResourceTypeOrder. Resource dengan jenis yang tidak ditentukan dalam daftar tidak akan dipindai atau dibersihkan. Untuk informasi tentang jenis resource yang valid, lihat Jenis resource yang didukung.
DisabledSideEffects	List	Tidak	Ya	Efek samping yang dinonaktifkan selama pembersihan.	Daftar dapat berisi 1 hingga 50 item. Setiap item dapat terdiri dari huruf, angka, dan karakter wildcard. Panjang setiap item adalah 1 hingga 100 karakter. Hanya karakter wildcard `*` dan `?` yang didukung. Pembersihan beberapa jenis resource dapat menimbulkan efek samping. Anda dapat memanggil operasi GetFeatureDetails untuk menanyakannya.

Sintaksis ResourceFilters

"ResourceFilters": [
  {
    "IncludeDeletionProtection": Boolean,
    "ResourceTypePatterns": List,
    "ResourceIds": List,
    "RegionIds": List,
    "ResourceGroupIds": List,
    "Effect": String,
    "ResourceNamePatterns": List,
    "Tags": List
  }
]

Properti ResourceFilters

Nama properti	Tipe	Wajib	Boleh diperbarui	Deskripsi	Batasan
IncludeDeletionProtection	Boolean	Tidak	Ya	Menentukan apakah akan menyertakan resource yang memiliki perlindungan penghapusan aktif.	Nilai valid: false: Resource dengan perlindungan penghapusan aktif tidak lolos filter ini. true (default): Resource dengan perlindungan penghapusan aktif lolos filter ini.
ResourceTypePatterns	List	Tidak	Ya	Daftar pola untuk jenis resource yang difilter. Untuk informasi tentang jenis resource, lihat Jenis resource yang didukung.	Daftar dapat berisi 1 hingga 100 pola. Resource lolos filter ini jika jenisnya sesuai dengan pola mana pun dalam daftar. Hanya karakter wildcard `*` dan `?` yang didukung. Setiap pola dalam daftar harus dalam format `Service:Type` dan panjangnya 3 hingga 100 karakter. `Service` dapat terdiri dari huruf dan karakter wildcard. `Type` dapat terdiri dari huruf, angka, dan karakter wildcard.
ResourceIds	List	Tidak	Ya	Daftar ID resource untuk difilter.	Daftar dapat berisi 1 hingga 100 ID. Resource lolos filter ini jika ID-nya sesuai dengan ID mana pun dalam daftar. Panjang item daftar dapat 1 hingga 256 karakter.
RegionIds	List	Tidak	Ya	Daftar wilayah untuk difilter.	Panjang daftar harus 1 hingga 100. Resource lolos filter ini jika wilayahnya sesuai dengan wilayah mana pun dalam daftar. Panjang item daftar harus 1 hingga 64 karakter.
ResourceGroupIds	List	Tidak	Ya	Daftar kelompok sumber daya untuk difilter.	Panjang daftar berkisar dari 1 hingga 100. Resource lolos filter ini jika termasuk dalam kelompok sumber daya mana pun dalam daftar. Panjang item daftar harus 1 hingga 256 karakter.
Effect	String	Tidak	Ya	Efek filter.	Nilai valid: Deny: Resource yang lolos semua kondisi filter dikecualikan dari pembersihan. Allow: Resource yang sesuai semua kondisi filter akan dibersihkan. Catatan Jika resource lolos filter ini tetapi juga lolos filter Deny, resource tersebut tetap tidak dibersihkan.
ResourceNamePatterns	List	Tidak	Ya	Pola nama resource untuk difilter.	Daftar dapat berisi 1 hingga 100 pola. Resource lolos filter ini jika namanya sesuai dengan pola mana pun dalam daftar. Hanya karakter wildcard `*` dan `?` yang didukung. Nama resource hanya mendukung huruf, angka, karakter Tionghoa, spasi, `_`, `-`, dan karakter pencocokan kabur. Panjang item daftar dapat berkisar dari 1 hingga 100.
Tags	List	Tidak	Ya	Tag untuk difilter. Tag kustom dan tag sistem didukung.	Daftar harus berisi 1 hingga 100 item. Aturan pencocokan: Jika Anda menentukan kunci tag dan nilai tag, resource yang kunci dan nilainya sesuai akan difilter. Catatan Jika kunci tag memiliki beberapa nilai dalam filter, resource cocok jika nilai tagnya merupakan salah satu nilai tersebut. Jika filter hanya menentukan kunci tag, resource cocok jika memiliki kunci tag tersebut. Resource lolos filter tag hanya jika cocok dengan kondisi filter untuk semua kunci tag yang ditentukan. Untuk informasi selengkapnya, lihat properti Tags.

Sintaksis Tags

"Tags": [
  {
    "Value": String,
    "Key": String
  }
]

Properti Tags

Nama properti	Tipe	Wajib	Boleh diperbarui	Deskripsi	Batasan
Value	String	Tidak	Ya	Nilai tag.	Panjang: 0 hingga 256 karakter. Catatan Menghilangkan nilai ini berbeda dengan menentukan string kosong.
Key	String	Ya	Ya	Kunci tag.	Panjang: 1 hingga 256 karakter.

Sintaksis Resources

"Resources": [
  {
    "ResourceId": String,
    "ResourceType": String,
    "RegionId": String
  }
]

Properti Resources

Nama Properti	Tipe	Wajib	Boleh diperbarui	Deskripsi	Batasan
ResourceId	String	Ya	Ya	ID resource yang akan dibersihkan.	Panjang: 1 hingga 256 karakter.
ResourceType	String	Ya	Ya	Jenis resource yang akan dibersihkan.	Untuk informasi selengkapnya, lihat Jenis resource yang didukung.
RegionId	String	Ya	Ya	ID wilayah resource yang akan dibersihkan.	Panjang: 1 hingga 64 karakter.

Sintaksis ExcludedResources

"ExcludedResources": [
  {
    "ResourceId": String,
    "ResourceType": String,
    "RegionId": String
  }
]

Properti ExcludedResources

Nama properti	Tipe	Wajib	Boleh diperbarui	Deskripsi	Batasan
ResourceId	String	Ya	Ya	ID resource yang akan dikecualikan.	Panjang: 1 hingga 256 karakter.
ResourceType	String	Tidak	Ya	Jenis resource yang akan dikecualikan.	Untuk informasi selengkapnya, lihat Jenis resource yang didukung.
RegionId	String	Tidak	Ya	ID wilayah resource yang akan dikecualikan.	Panjang: 1 hingga 64 karakter.

Nilai kembalian

Fn::GetAtt

ResourceDetails: Detail resource yang akan dibersihkan. Nilainya berupa daftar kamus dengan bidang-bidang berikut:

Bidang	Tipe	Deskripsi
ResourceType	String	Jenis resource.
RegionId	String	ID wilayah resource.
ResourceId	String	ID resource.
ResourceName	String	Nama resource.
CleanupType	String	Jenis pembersihan sumber daya. Nilai yang valid: Normal: Resource dapat dihapus secara normal. DeleteWithInstance: Resource dihapus bersama resource tempat ia berada. Jika resource induknya difilter atau dikecualikan, penghapusan mungkin gagal. Lihat CleanupTypeReasons untuk detailnya. UnableToDelete: Resource tidak dapat dihapus. Lihat CleanupTypeReasons untuk detailnya.
CleanupTypeReasons	List	Daftar alasan untuk jenis pembersihan resource.
ResourceStatus	String	Status resource. Nilai valid: Deleting: Resource sedang dihapus. Failure: Penghapusan resource gagal. Success: Resource berhasil dihapus. Skipped: Penghapusan resource dilewati. Pending: Resource menunggu penghapusan.
ResourceStatusReason	String	Alasan status resource.
Dependencies	List	Dependensi penghapusan resource. Nilainya berupa daftar kamus dengan bidang-bidang berikut: ResourceType: Jenis resource dependen. RegionId: ID wilayah resource dependen. ResourceId: ID resource dependen.

ResourcePartialDetails: Versi sederhana dari ResourceDetails yang hanya mencakup bidang ResourceType, RegionId, ResourceId, ResourceName, ResourceStatus, dan ResourceStatusReason.
NoCleanupResourceDetails: Detail resource yang dipindai tetapi tidak dibersihkan. Formatnya sama dengan ResourceDetails.
NoCleanupResourcePartialDetails: Versi sederhana dari NoCleanupResourceDetails yang hanya mencakup bidang ResourceType, RegionId, ResourceId, ResourceName, ResourceStatus, dan ResourceStatusReason.

ResourceSummary: Ringkasan resource yang akan dibersihkan. Nilainya berupa daftar kamus dengan bidang-bidang berikut:

Bidang	Tipe	Deskripsi
ResourceType	String	Jenis resource.
DeletingCount	Integer	Jumlah resource yang sedang dihapus.
SuccessCount	Integer	Jumlah resource yang berhasil dihapus.
FailureCount	Integer	Jumlah resource yang gagal dihapus.
SkippedCount	Integer	Jumlah resource yang penghapusannya dilewati.
PendingCount	Integer	Jumlah resource yang menunggu penghapusan.
OtherCount	Integer	Jumlah resource dalam status lainnya.
TotalCount	Integer	Jumlah total resource.

ScanErrors: Error yang terjadi selama pemindaian. Parameter ini dikembalikan hanya jika Mode diatur ke Loose. Nilainya berupa daftar kamus dengan bidang-bidang berikut:

Bidang	Tipe	Deskripsi
ResourceType	String	Jenis resource.
RegionId	String	ID wilayah.
ErrorMessage	String	Pesan error untuk pemindaian wilayah dan jenis resource tertentu.

CleanResult: Hasil pembersihan keseluruhan. Nilai valid:
- Success: Semua resource berhasil dibersihkan.
- ResourceFailure: Pembersihan beberapa resource gagal.
- Timeout: Pembersihan melebihi waktu yang ditentukan.
- CheckFailure: Pemeriksaan awal pembersihan gagal.
- UnknownFailure: Terjadi error yang tidak diketahui.
- UserCancelled: Operasi dibatalkan oleh pengguna.
- None: Tidak ada pembersihan yang dipicu.

Contoh

Format YAML

ROSTemplateFormatVersion: '2015-09-01'
Parameters: {}
Resources:
  ResourceCleaner:
    Type: ALIYUN::ROS::ResourceCleaner
    Properties:
      FailureOption: Normal
      Action: Scan
      ResourceFilters:
        - ResourceIds:
            - i-bp1h09ipy0atb4kq****
      CleanUpRetryCount: 1
      CleanUpTimeout: 3600
      ExcludedResources:
        - ResourceId: i-bp1h09ipy0atb4kq****
          ResourceType: ECS:Instance
Outputs: {}

Format JSON

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
  },
  "Resources": {
    "ResourceCleaner": {
      "Type": "ALIYUN::ROS::ResourceCleaner",
      "Properties": {
        "FailureOption": "Normal",
        "Action": "Scan",
        "ResourceFilters": [
          {
            "ResourceIds": [
              "i-bp1h09ipy0atb4kq****"
            ]
          }
        ],
        "CleanUpRetryCount": 1,
        "CleanUpTimeout": 3600,
        "ExcludedResources": [
          {
            "ResourceId": "i-bp1h09ipy0atb4kq****",
            "ResourceType": "ECS:Instance"
          }
        ]
      }
    }
  },
  "Outputs": {
  }
}