ALIYUN::ROS::ResourceCleaner - Resource Orchestration Service: Central de Documentação do Alibaba Cloud

O ALIYUN::ROS::ResourceCleaner cria um limpador de recursos que verifica e limpa recursos.

Tipos de recursos suportados

Nota

O ROS adiciona continuamente suporte a mais tipos de recursos. Chame a operação GetFeatureDetails para obter a lista de tipos de recursos suportados.

Serviço Alibaba Cloud	Tipo de recurso
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

Sintaxe

{
  "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
  }
}

Propriedades

Nome da propriedade	Tipo	Obrigatório	Atualização permitida	Descrição	Restrições
Action	String	Sim	Sim	A ação que o limpador de recursos executa.	Valores válidos: Scan: Verifica os recursos a serem limpos. CleanUp: Limpa os recursos verificados. É necessário executar uma verificação antes. Especifique este valor apenas durante uma atualização, não na criação do limpador de recursos. Scan+CleanUp: Verifica os recursos e, em seguida, realiza a limpeza. ScanWhenCreatingAndUpdating+CleanUpWhenDeleting: Verifica os recursos quando o limpador é criado ou atualizado e limpa os recursos quando o limpador é excluído.
ResourceFilters	List	Não	Sim	Os filtros de recursos usados pelo limpador para identificar os recursos que precisam ser limpos.	A lista pode conter até 100 filtros. Especifique ResourceFilters ou Resources, mas não ambos. Se a lista de filtros for alterada durante uma atualização, o limpador verificará os recursos novamente. Se Action estiver definido como CleanUp, a operação falhará. Os filtros têm dois efeitos: Allow e Deny. Eles funcionam da seguinte forma (um número menor indica maior prioridade): Recursos correspondentes a qualquer filtro Deny não são limpos. Apenas recursos correspondentes a pelo menos um filtro Allow são limpos. Para mais informações, consulte Propriedades de ResourceFilters.
Resources	List	Não	Sim	Os recursos a serem limpos.	A lista pode conter de 1 a 1.000 recursos. Especifique ResourceFilters ou Resources, mas não ambos. Para mais informações, consulte Propriedades de Resources.
Mode	String	Não	Sim	O modo de execução do limpador de recursos.	Valores válidos: Strict: Qualquer falha na verificação ou limpeza de recursos causa a falha do limpador. Loose (padrão): A maioria das falhas de verificação e limpeza é tolerada. Falhas de verificação são registradas em ScanErrors e ResourceDetails. Falhas de limpeza são registradas em ResourceDetails.
FailureOption	String	Não	Sim	O comportamento para recursos dependentes quando a limpeza de um recurso falha.	Valores válidos: Normal (padrão): Uma falha na limpeza de recursos não afeta os recursos dependentes. Fast: Uma falha na limpeza de recursos causa a falha dos recursos dependentes. Nota A dependência é uma dependência de exclusão, não de criação.
CleanUpRetryCount	Integer	Não	Sim	O número máximo de tentativas de limpeza.	Valores válidos: 1 a 6. O valor padrão é 1, o que significa nenhuma nova tentativa. Uma nova tentativa é acionada se uma das seguintes condições for atendida: Falha na limpeza de um recurso. Tempo limite da limpeza excedido.
CleanUpTimeout	Number	Não	Sim	O período de tempo limite para a limpeza de recursos.	Valores válidos: 60 a 14400. Unidade: segundos. Valor padrão: 3600.
ExcludedResources	List	Não	Sim	Os recursos a serem excluídos da limpeza.	A lista pode conter de 1 a 1.000 recursos. Cada item pode excluir apenas um recurso. Se um item for ambíguo e apontar para vários recursos, a operação falhará. Especifique mais campos para remover a ambiguidade. Para mais informações, consulte Propriedades de ExcludedResources.
CleanUpAlgorithm	String	Não	Sim	O algoritmo de limpeza de recursos.	Valores válidos: ResourceDependency (padrão): Os recursos são limpos com base em suas dependências. ResourceTypeOrder: Os recursos são limpos na ordem dos tipos de recurso. Use a propriedade ResourceTypeOrder para especificar a ordem. Caso contrário, a ordem padrão do sistema será usada. A ordem padrão inclui todos os tipos de recursos suportados.
ResourceTypeOrder	List	Não	Sim	A ordem de limpeza dos tipos de recurso.	O número de itens na lista deve estar no intervalo de 1 a 1.000. Este parâmetro entra em vigor apenas quando CleanUpAlgorithm está definido como ResourceTypeOrder. Recursos de tipos não especificados na lista não são verificados nem limpos. Para informações sobre tipos de recursos válidos, consulte Tipos de recursos suportados.
DisabledSideEffects	List	Não	Sim	Os efeitos colaterais a serem desativados durante a limpeza.	A lista pode conter de 1 a 50 itens. Cada item pode consistir em letras, dígitos e caracteres curinga. O comprimento de cada item é de 1 a 100 caracteres. Apenas os caracteres curinga `*` e `?` são suportados. A limpeza de alguns tipos de recursos pode ter efeitos colaterais. Chame a operação GetFeatureDetails para consultá-los.

Sintaxe de ResourceFilters

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

Propriedades de ResourceFilters

Nome da propriedade	Tipo	Obrigatório	Atualização permitida	Descrição	Restrições
IncludeDeletionProtection	Boolean	Não	Sim	Especifica se devem ser incluídos recursos com proteção contra exclusão ativada.	Valores válidos: false: Recursos com proteção contra exclusão ativada não passam neste filtro. true (padrão): Recursos com proteção contra exclusão ativada passam neste filtro.
ResourceTypePatterns	List	Não	Sim	Uma lista de padrões para tipos de recursos a serem filtrados. Para informações sobre tipos de recursos, consulte Tipos de recursos suportados.	A lista pode conter de 1 a 100 padrões. Um recurso passa neste filtro se seu tipo corresponder a qualquer padrão na lista. Apenas os caracteres curinga `*` e `?` são suportados. Cada padrão na lista deve estar no formato `Service:Type` e ter de 3 a 100 caracteres de comprimento. `Service` pode consistir em letras e caracteres curinga. `Type` pode consistir em letras, dígitos e caracteres curinga.
ResourceIds	List	Não	Sim	Uma lista de IDs de recursos a serem filtrados.	A lista pode conter de 1 a 100 IDs. Um recurso passa neste filtro se seu ID corresponder a qualquer ID na lista. Um item da lista pode ter de 1 a 256 caracteres.
RegionIds	List	Não	Sim	Uma lista de regiões a serem filtradas.	O comprimento da lista deve ser de 1 a 100. Um recurso passa neste filtro se sua região corresponder a qualquer região na lista. Um item da lista deve ter de 1 a 64 caracteres de comprimento.
ResourceGroupIds	List	Não	Sim	Uma lista de grupos de recursos a serem filtrados.	O comprimento da lista varia de 1 a 100. Um recurso passa neste filtro se pertencer a qualquer grupo de recursos na lista. O comprimento de um item da lista deve ser de 1 a 256 caracteres.
Effect	String	Não	Sim	O efeito do filtro.	Valores válidos: Deny: Recursos que passam em todas as condições do filtro são excluídos da limpeza. Allow: Recursos que correspondem a todas as condições do filtro são limpos. Nota Se um recurso passar neste filtro, mas também passar em um filtro Deny, ele ainda não será limpo.
ResourceNamePatterns	List	Não	Sim	Os padrões de nome de recurso para filtragem.	A lista pode conter de 1 a 100 padrões. Um recurso passa neste filtro se seu nome corresponder a qualquer padrão na lista. Apenas os caracteres curinga `*` e `?` são suportados. Os nomes de recursos suportam apenas letras, números, caracteres chineses, espaços, `_`, `-` e caracteres de correspondência difusa. O comprimento de um item da lista pode variar de 1 a 100.
Tags	List	Não	Sim	As tags para filtragem. Tanto tags personalizadas quanto tags de sistema são suportadas.	A lista deve conter de 1 a 100 itens. Regras de correspondência: Se você especificar tanto uma chave de tag quanto um valor de tag, os recursos cuja chave e valor correspondam serão filtrados. Nota Se uma chave de tag tiver vários valores no filtro, um recurso corresponderá se seu valor de tag for qualquer um desses valores. Se um filtro especificar apenas uma chave de tag, um recurso corresponderá se tiver essa chave de tag. Um recurso passa no filtro de tags apenas se corresponder às condições do filtro para todas as chaves de tag especificadas. Para mais informações, consulte Propriedades de Tags.

Sintaxe de Tags

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

Propriedades de Tags

Nome da propriedade	Tipo	Obrigatório	Atualização permitida	Descrição	Restrições
Value	String	Não	Sim	O valor da tag.	Comprimento: 0 a 256 caracteres. Nota Omitir este valor é diferente de especificar uma string vazia.
Key	String	Sim	Sim	A chave da tag.	Comprimento: 1 a 256 caracteres.

Sintaxe de Resources

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

Propriedades de Resources

Nome da propriedade	Tipo	Obrigatório	Atualização permitida	Descrição	Restrições
ResourceId	String	Sim	Sim	O ID do recurso a ser limpo.	Comprimento: 1 a 256 caracteres.
ResourceType	String	Sim	Sim	O tipo do recurso a ser limpo.	Para mais informações, consulte Tipos de recursos suportados.
RegionId	String	Sim	Sim	O ID da região do recurso a ser limpo.	Comprimento: 1 a 64 caracteres.

Sintaxe de ExcludedResources

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

Propriedades de ExcludedResources

Nome da propriedade	Tipo	Obrigatório	Atualização permitida	Descrição	Restrições
ResourceId	String	Sim	Sim	O ID do recurso a ser excluído.	Comprimento: 1 a 256 caracteres.
ResourceType	String	Não	Sim	O tipo do recurso a ser excluído.	Para mais informações, consulte Tipos de recursos suportados.
RegionId	String	Não	Sim	O ID da região do recurso a ser excluído.	Comprimento: 1 a 64 caracteres.

Valores de retorno

Fn::GetAtt

ResourceDetails: Os detalhes dos recursos a serem limpos. O valor é uma lista de dicionários com os seguintes campos:

Campo	Tipo	Descrição
ResourceType	String	O tipo do recurso.
RegionId	String	O ID da região do recurso.
ResourceId	String	O ID do recurso.
ResourceName	String	O nome do recurso.
CleanupType	String	O tipo de limpeza do recurso. Valores válidos: Normal: O recurso pode ser excluído normalmente. DeleteWithInstance: O recurso é excluído junto com o recurso ao qual pertence. Se o recurso ao qual pertence for filtrado ou excluído, a exclusão poderá falhar. Consulte CleanupTypeReasons para obter detalhes. UnableToDelete: O recurso não pode ser excluído. Consulte CleanupTypeReasons para obter detalhes.
CleanupTypeReasons	List	Uma lista de motivos para o tipo de limpeza do recurso.
ResourceStatus	String	O status do recurso. Valores válidos: Deleting: O recurso está sendo excluído. Failure: Falha ao excluir o recurso. Success: O recurso foi excluído. Skipped: A exclusão do recurso foi ignorada. Pending: O recurso está pendente de exclusão.
ResourceStatusReason	String	O motivo do status do recurso.
Dependencies	List	As dependências de exclusão do recurso. O valor é uma lista de dicionários com os seguintes campos: ResourceType: O tipo de recurso do recurso dependente. RegionId: O ID da região do recurso dependente. ResourceId: O ID do recurso dependente.

ResourcePartialDetails: Uma versão simplificada de ResourceDetails que inclui apenas os campos ResourceType, RegionId, ResourceId, ResourceName, ResourceStatus e ResourceStatusReason.
NoCleanupResourceDetails: Os detalhes dos recursos verificados, mas não limpos. O formato é o mesmo de ResourceDetails.
NoCleanupResourcePartialDetails: Uma versão simplificada de NoCleanupResourceDetails que inclui apenas os campos ResourceType, RegionId, ResourceId, ResourceName, ResourceStatus e ResourceStatusReason.

ResourceSummary: Um resumo dos recursos a serem limpos. O valor é uma lista de dicionários com os seguintes campos:

Campo	Tipo	Descrição
ResourceType	String	O tipo do recurso.
DeletingCount	Integer	O número de recursos sendo excluídos.
SuccessCount	Integer	O número de recursos excluídos.
FailureCount	Integer	O número de recursos cuja exclusão falhou.
SkippedCount	Integer	O número de recursos cuja exclusão foi ignorada.
PendingCount	Integer	O número de recursos pendentes de exclusão.
OtherCount	Integer	O número de recursos em outros estados.
TotalCount	Integer	O número total de recursos.

ScanErrors: Os erros ocorridos durante a verificação. Este parâmetro é retornado apenas quando Mode está definido como Loose. O valor é uma lista de dicionários com os seguintes campos:

Campo	Tipo	Descrição
ResourceType	String	O tipo do recurso.
RegionId	String	O ID da região.
ErrorMessage	String	A mensagem de erro para a verificação da região e tipo de recurso especificados.

CleanResult: O resultado geral da limpeza. Valores válidos:
- Success: Todos os recursos foram limpos.
- ResourceFailure: A limpeza de alguns recursos falhou.
- Timeout: A limpeza excedeu o tempo limite.
- CheckFailure: A pré-verificação da limpeza falhou.
- UnknownFailure: Ocorreu um erro desconhecido.
- UserCancelled: A operação foi cancelada pelo usuário.
- None: Nenhuma limpeza foi acionada.

Exemplos

YAML format

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: {}

JSON format

{
  "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": {
  }
}