ALIYUN::ROS::ResourceCleaner - Resource Orchestration Service - Centro de documentación de Alibaba Cloud

ALIYUN::ROS::ResourceCleaner crea un limpiador de recursos que busca y elimina recursos.

Tipos de recursos compatibles

Nota

ROS agrega continuamente compatibilidad con más tipos de recursos. Puede llamar a la operación GetFeatureDetails para obtener la lista de tipos de recursos compatibles.

Servicio de 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

Sintaxis

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

Propiedades

Nombre de propiedad	Tipo	Obligatorio	Actualización permitida	Descripción	Restricciones
Action	String	Sí	Sí	La acción que ejecuta el limpiador de recursos.	Valores válidos: Scan: Busca recursos para eliminarlos. CleanUp: Elimina los recursos encontrados en la búsqueda. Debe realizarse una búsqueda primero. Este valor solo se puede especificar durante una actualización, no al crear un limpiador de recursos. Scan+CleanUp: Busca recursos y luego los elimina. ScanWhenCreatingAndUpdating+CleanUpWhenDeleting: Busca recursos cuando se crea o actualiza el limpiador de recursos, y los elimina cuando se borra dicho limpiador.
ResourceFilters	List	No	Sí	Los filtros de recursos que utiliza el limpiador para buscar los recursos que deben eliminarse.	La lista puede contener hasta 100 filtros. Puede especificar ResourceFilters o Resources, pero no ambos. Si la lista de filtros de recursos cambia durante una actualización, el limpiador vuelve a buscar los recursos. Si Action está configurado como CleanUp, la operación falla. Los filtros tienen dos efectos: Allow y Deny. Funcionan de la siguiente manera (un número menor indica mayor prioridad): Los recursos que coinciden con algún filtro Deny no se eliminan. Solo se eliminan los recursos que coinciden con como mínimo un filtro Allow. Para obtener más información, consulte ResourceFilters properties.
Resources	List	No	Sí	Los recursos que se van a eliminar.	La lista puede contener de 1 a 1,000 recursos. Puede especificar ResourceFilters o Resources, pero no ambos. Para obtener más información, consulte Resources properties.
Mode	String	No	Sí	El modo de ejecución del limpiador de recursos.	Valores válidos: Strict: Cualquier error en la búsqueda o eliminación de recursos provoca que el limpiador falle. Loose (predeterminado): Se toleran la mayoría de los errores de búsqueda y eliminación. Los errores de búsqueda se registran en ScanErrors y ResourceDetails. Los errores de eliminación se registran en ResourceDetails.
FailureOption	String	No	Sí	El comportamiento de los recursos dependientes cuando falla la eliminación de un recurso.	Valores válidos: Normal (predeterminado): Un fallo en la eliminación de un recurso no afecta a los recursos dependientes. Fast: Un fallo en la eliminación de un recurso provoca que fallen los recursos dependientes. Nota La dependencia es de eliminación, no de creación.
CleanUpRetryCount	Integer	No	Sí	El número máximo de reintentos de eliminación.	Valores válidos: 1 a 6. El valor predeterminado es 1, lo que significa que no hay reintentos. Se activa un reintento si se cumple alguna de las siguientes condiciones: Falla la eliminación de un recurso. Se agota el tiempo de espera de la eliminación.
CleanUpTimeout	Number	No	Sí	El período de tiempo de espera para la eliminación de recursos.	Valores válidos: 60 a 14400. Unidad: segundos. Valor predeterminado: 3600.
ExcludedResources	List	No	Sí	Los recursos que se excluirán de la eliminación.	La lista puede contener de 1 a 1,000 recursos. Cada elemento solo puede excluir un recurso. Si un elemento es ambiguo y apunta a varios recursos, la operación falla. Especifique más campos para eliminar la ambigüedad. Para obtener más información, consulte ExcludedResources properties.
CleanUpAlgorithm	String	No	Sí	El algoritmo de eliminación de recursos.	Valores válidos: ResourceDependency (predeterminado): Los recursos se eliminan según sus dependencias. ResourceTypeOrder: Los recursos se eliminan según el orden de los tipos de recurso. Puede usar la propiedad ResourceTypeOrder para especificar el orden. Si no especifica esta propiedad, se utiliza el orden predeterminado del sistema. El orden predeterminado incluye todos los tipos de recursos compatibles.
ResourceTypeOrder	List	No	Sí	El orden de eliminación de los tipos de recurso.	El número de elementos en la lista debe estar entre 1 y 1,000. Este parámetro solo surte efecto cuando CleanUpAlgorithm se establece en ResourceTypeOrder. Los recursos de tipos no especificados en la lista no se buscan ni se eliminan. Para obtener información sobre los tipos de recursos válidos, consulte Supported resource types.
DisabledSideEffects	List	No	Sí	Los efectos secundarios que se deshabilitarán durante la eliminación.	La lista puede contener de 1 a 50 elementos. Cada elemento puede consistir en letras, dígitos y caracteres comodín. La longitud de cada elemento es de 1 a 100 caracteres. Solo se admiten los caracteres comodín `*` y `?`. La eliminación de algunos tipos de recursos puede tener efectos secundarios. Puede llamar a la operación GetFeatureDetails para consultarlos.

Sintaxis de ResourceFilters

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

Propiedades de ResourceFilters

Nombre de propiedad	Tipo	Obligatorio	Actualización permitida	Descripción	Restricciones
IncludeDeletionProtection	Boolean	No	Sí	Especifica si se incluyen recursos que tienen habilitada la protección contra eliminación.	Valores válidos: false: Los recursos con protección contra eliminación habilitada no pasan este filtro. true (predeterminado): Los recursos con protección contra eliminación habilitada pasan este filtro.
ResourceTypePatterns	List	No	Sí	Una lista de patrones para filtrar tipos de recursos. Para obtener información sobre los tipos de recursos, consulte Supported resource types.	La lista puede contener de 1 a 100 patrones. Un recurso pasa este filtro si su tipo coincide con algún patrón de la lista. Solo se admiten los caracteres comodín `*` y `?`. Cada patrón de la lista debe tener el formato `Service:Type` y una longitud de 3 a 100 caracteres. `Service` puede consistir en letras y caracteres comodín. `Type` puede consistir en letras, dígitos y caracteres comodín.
ResourceIds	List	No	Sí	Una lista de ID de recursos para filtrar.	La lista puede contener de 1 a 100 ID. Un recurso pasa este filtro si su ID coincide con algún ID de la lista. Un elemento de la lista puede tener de 1 a 256 caracteres de longitud.
RegionIds	List	No	Sí	Una lista de regiones para filtrar.	La longitud de la lista debe ser de 1 a 100. Un recurso pasa este filtro si su región coincide con alguna región de la lista. Un elemento de la lista debe tener de 1 a 64 caracteres de longitud.
ResourceGroupIds	List	No	Sí	Una lista de resource groups para filtrar.	La longitud de la lista varía de 1 a 100. Un recurso pasa este filtro si pertenece a algún resource group de la lista. La longitud de un elemento de la lista debe ser de 1 a 256 caracteres.
Effect	String	No	Sí	El efecto del filtro.	Valores válidos: Deny: Los recursos que cumplen todas las condiciones del filtro se excluyen de la eliminación. Allow: Los recursos que cumplen todas las condiciones del filtro se eliminan. Nota Si un recurso pasa este filtro pero también pasa un filtro Deny, aun así no se elimina.
ResourceNamePatterns	List	No	Sí	Los patrones de nombre de recurso para filtrar.	La lista puede contener de 1 a 100 patrones. Un recurso pasa este filtro si su nombre coincide con algún patrón de la lista. Solo se admiten los caracteres comodín `*` y `?`. Los nombres de recursos solo admiten letras, números, caracteres chinos, espacios, `_`, `-` y caracteres de coincidencia difusa. La longitud de un elemento de la lista puede variar de 1 a 100.
Tags	List	No	Sí	Las etiquetas para filtrar. Se admiten tanto etiquetas personalizadas como etiquetas del sistema.	La lista debe contener de 1 a 100 elementos. Reglas de coincidencia: Si especifica tanto una clave de etiqueta como un valor de etiqueta, se filtran los recursos cuya clave y valor de etiqueta coincidan. Nota Si una clave de etiqueta tiene varios valores en el filtro, un recurso coincide si su valor de etiqueta es cualquiera de esos valores. Si un filtro solo especifica una clave de etiqueta, un recurso coincide si tiene esa clave de etiqueta. Un recurso pasa el filtro de etiquetas solo si coincide con las condiciones del filtro para todas las claves de etiqueta especificadas. Para obtener más información, consulte Tags properties.

Sintaxis de Tags

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

Propiedades de Tags

Nombre de propiedad	Tipo	Obligatorio	Actualización permitida	Descripción	Restricciones
Value	String	No	Sí	El valor de la etiqueta.	Longitud: 0 a 256 caracteres. Nota Omitir este valor es diferente a especificar una cadena vacía.
Key	String	Sí	Sí	La clave de la etiqueta.	Longitud: 1 a 256 caracteres.

Sintaxis de Resources

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

Propiedades de Resources

Nombre de propiedad	Tipo	Obligatorio	Actualización permitida	Descripción	Restricciones
ResourceId	String	Sí	Sí	El ID del recurso que se va a eliminar.	Longitud: 1 a 256 caracteres.
ResourceType	String	Sí	Sí	El tipo del recurso que se va a eliminar.	Para obtener más información, consulte Supported resource types.
RegionId	String	Sí	Sí	El ID de región del recurso que se va a eliminar.	Longitud: 1 a 64 caracteres.

Sintaxis de ExcludedResources

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

Propiedades de ExcludedResources

Nombre de propiedad	Tipo	Obligatorio	Actualización permitida	Descripción	Restricciones
ResourceId	String	Sí	Sí	El ID del recurso que se va a excluir.	Longitud: 1 a 256 caracteres.
ResourceType	String	No	Sí	El tipo del recurso que se va a excluir.	Para obtener más información, consulte Supported resource types.
RegionId	String	No	Sí	El ID de región del recurso que se va a excluir.	Longitud: 1 a 64 caracteres.

Valores de retorno

Fn::GetAtt

ResourceDetails: Los detalles de los recursos que se van a eliminar. El valor es una lista de diccionarios con los siguientes campos:

Campo	Tipo	Descripción
ResourceType	String	El tipo de recurso.
RegionId	String	El ID de región del recurso.
ResourceId	String	El ID del recurso.
ResourceName	String	El nombre del recurso.
CleanupType	String	El tipo de eliminación del recurso. Valores válidos: Normal: El recurso se puede eliminar normalmente. DeleteWithInstance: El recurso se elimina junto con el recurso al que pertenece. Si el recurso al que pertenece se filtra o excluye, la eliminación puede fallar. Consulte CleanupTypeReasons para obtener más detalles. UnableToDelete: El recurso no se puede eliminar. Consulte CleanupTypeReasons para obtener más detalles.
CleanupTypeReasons	List	Una lista de razones para el tipo de eliminación del recurso.
ResourceStatus	String	El estado del recurso. Valores válidos: Deleting: El recurso se está eliminando. Failure: No se pudo eliminar el recurso. Success: El recurso se eliminó. Skipped: Se omitió la eliminación del recurso. Pending: El recurso está pendiente de eliminación.
ResourceStatusReason	String	La razón del estado del recurso.
Dependencies	List	Las dependencias de eliminación del recurso. El valor es una lista de diccionarios con los siguientes campos: ResourceType: El tipo de recurso del recurso dependiente. RegionId: El ID de región del recurso dependiente. ResourceId: El ID del recurso dependiente.

ResourcePartialDetails: Una versión simplificada de ResourceDetails que solo incluye los campos ResourceType, RegionId, ResourceId, ResourceName, ResourceStatus y ResourceStatusReason.
NoCleanupResourceDetails: Los detalles de los recursos que se buscaron pero no se eliminaron. El formato es el mismo que ResourceDetails.
NoCleanupResourcePartialDetails: Una versión simplificada de NoCleanupResourceDetails que solo incluye los campos ResourceType, RegionId, ResourceId, ResourceName, ResourceStatus y ResourceStatusReason.

ResourceSummary: Un resumen de los recursos que se van a eliminar. El valor es una lista de diccionarios con los siguientes campos:

Campo	Tipo	Descripción
ResourceType	String	El tipo de recurso.
DeletingCount	Integer	El número de recursos que se están eliminando.
SuccessCount	Integer	El número de recursos eliminados.
FailureCount	Integer	El número de recursos cuya eliminación falló.
SkippedCount	Integer	El número de recursos cuya eliminación se omitió.
PendingCount	Integer	El número de recursos pendientes de eliminación.
OtherCount	Integer	El número de recursos en otros estados.
TotalCount	Integer	El número total de recursos.

ScanErrors: Los errores que ocurrieron durante la búsqueda. Este parámetro solo se devuelve cuando Mode se establece en Loose. El valor es una lista de diccionarios con los siguientes campos:

Campo	Tipo	Descripción
ResourceType	String	El tipo de recurso.
RegionId	String	El ID de región.
ErrorMessage	String	El mensaje de error para la búsqueda de la región y el tipo de recurso especificados.

CleanResult: El resultado general de la eliminación. Valores válidos:
- Success: Todos los recursos se eliminaron.
- ResourceFailure: Falló la eliminación de algunos recursos.
- Timeout: Se agotó el tiempo de espera de la eliminación.
- CheckFailure: Falló la verificación previa a la eliminación.
- UnknownFailure: Ocurrió un error desconocido.
- UserCancelled: El usuario canceló la operación.
- None: No se activó ninguna eliminación.

Ejemplos

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