CreateTemplateScratch - Resource Orchestration Service - Centro de documentación de Alibaba Cloud

Crea un escenario de plantilla.

Descripción de la operación

Límites

Solo tipos de recursos específicos admiten la función de escenarios de recursos. Para obtener más información, consulte Tipos de recursos que admiten escenarios.

Descripción

Resource Orchestration Service (ROS) proporciona la función de escenarios de recursos. Puede seleccionar un alcance de recursos en la interfaz de usuario y realizar operaciones como la replicación o gestión de un grupo de recursos, lo que ayuda a simplificar la administración de recursos. Para obtener más información sobre los escenarios de recursos, consulte Visión general.

Escenario de replicación de recursos

Si desea replicar una colección de recursos y las dependencias entre ellos, puede crear un escenario de replicación de recursos. Este tipo de escenario le permite replicar todos los recursos existentes dentro del alcance especificado y generar una colección de recursos que tienen la misma arquitectura que los recursos existentes. Para obtener más información, consulte Escenario de replicación de recursos.

Escenario de perfilado de recursos

Si las relaciones entre los recursos que desea crear son complejas, puede crear un escenario de perfilado de recursos para obtener una vista previa de la arquitectura general de recursos o de la arquitectura a partir de un recurso específico. Esto ayuda a simplificar la administración de recursos. Para obtener más información, consulte Escenario de detección de recursos.

Escenario de gestión de recursos

Si necesita importar una colección de recursos existentes a una nueva pila de recursos para su gestión unificada, puede crear un escenario de gestión de recursos. Para obtener más información, consulte Escenario de gestión de recursos.

Escenario de migración de recursos

Si desea migrar una colección de recursos y las dependencias entre ellos, puede crear un escenario de migración de recursos. Cuando migra los recursos, ROS genera una pila. Puede ver el progreso de la migración en la pestaña Pilas de la página de detalles del escenario. Después de migrar los recursos, puede eliminar los recursos de origen. Para obtener más información, consulte Escenario de migración de recursos.

Este tema proporciona un ejemplo de cómo crear un escenario de replicación de recursos en la región China (Hangzhou) para replicar una nube privada virtual (VPC) con el ID vpc-bp1m6fww66xbntjyc****.

Pruébelo ahora

Pruebe esta API en OpenAPI Explorer sin necesidad de firma manual. Las llamadas exitosas generan automáticamente código SDK acorde a sus parámetros. Descárguelo con seguridad de credenciales integrada para uso local.

Test

Autorización de RAM

La siguiente tabla describe la autorización necesaria para invocar esta API. Puede definirla en una directiva de Resource Access Management (RAM). A continuación, se detallan las columnas de la tabla:

Action: Estas acciones se utilizan en el elemento Action de las declaraciones de directivas de permisos de RAM para otorgar permisos que permitan realizar la operación.
API: La API que debe invocarse para llevar a cabo la acción.
Nivel de acceso: Nivel de acceso predefinido que se concede para cada API. Valores válidos: create, list, get, update y delete.
Tipo de recurso: Tipo de recurso que admite autorización para ejecutar la acción. Indica si la acción es compatible con permisos a nivel de recurso. El recurso especificado debe ser compatible con la acción; de lo contrario, la directiva no surtirá efecto.
- En las API con permisos a nivel de recurso, los tipos de recursos obligatorios se marcan con un asterisco (*). Especifique el Alibaba Cloud Resource Name (ARN) correspondiente en el elemento Resource de la directiva.
- Para las API sin permisos a nivel de recurso, se muestra All Resources. Utilice un asterisco (*) en el elemento Resource de la directiva.
Clave de condición: Claves de condición definidas por el servicio. Permiten un control granular y se aplican ya sea solo a acciones o a acciones asociadas con recursos específicos. Además de las claves de condición específicas del servicio, Alibaba Cloud proporciona un conjunto de common condition keys aplicables a todos los servicios compatibles con RAM.
Acción dependiente: Acciones dependientes necesarias para ejecutar la acción principal. Para completar la operación, el usuario de RAM o el rol de RAM debe contar con permisos para realizar todas las acciones dependientes.

Action

Nivel de acceso

Tipo de recurso

Clave de condición

Acción dependiente

ros:CreateTemplateScratch

create

*TemplateScratch

acs:ros:{#regionId}:{#accountId}:templatescratch/*

Ninguna

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
RegionId	string	Sí	El ID de región del escenario de recursos. Puede llamar a DescribeRegions para consultar la lista de regiones más reciente.	cn-hangzhou
TemplateScratchType	string	Sí	El tipo de escenario de recursos. Valores válidos: ArchitectureReplication: replicación de recursos ArchitectureDetection: perfilado de recursos ResourceImport: gestión de recursos ResourceMigration: migración de recursos Nota Cuando especifica diferentes valores para el parámetro TemplateScratchType, los parámetros opcionales en la descripción complementaria de los parámetros de solicitud también son diferentes. Para obtener más información, consulte la sección Descripción complementaria de los parámetros de solicitud a continuación.	ArchitectureReplication
Description	string	No	La descripción del escenario de recursos.	Copiar recursos de VPC
SourceResources	array<object>	No	Los recursos de origen. Cuando establece TemplateScratchType en ArchitectureDetection, puede especificar SourceResources para detectar los datos de arquitectura de todos los recursos asociados con los recursos de origen especificados. Por ejemplo, si especifica un ID de instancia CLB, el sistema detectará e identificará sus recursos asociados, como instancias ECS, vSwitches y VPCs. Si TemplateScratchType se establece en ArchitectureDetection, puede especificar hasta 20 recursos de origen. En otros casos, se admiten hasta 200 recursos de origen.
	object	No	El recurso de origen.
ResourceId	string	Sí	El ID del recurso.	vpc-bp1m6fww66xbntjyc****
ResourceType	string	Sí	El tipo de recurso.	ALIYUN::ECS::VPC
RegionId	string	No	El ID de región del recurso. Puede llamar a DescribeRegions para consultar la lista de regiones más reciente. Nota Este parámetro solo surte efecto cuando TemplateScratchType se establece en ArchitectureDetection. El ID de región de un recurso global es `global`. Por ejemplo, ALIYUN::CDN::Domain es un recurso global y su ID de región es `global`.	cn-beijing
RelatedResourceTypeFilter	array	No	Los filtros de tipo de recurso relacionado.
	string	No	El filtro de tipo de recurso relacionado.	ALIYUN::ECS::VPC
SourceTag	object	No	Las etiquetas de origen.
ResourceTags	object	Sí	Las etiquetas de origen que consisten en pares clave-valor. Si desea especificar solo una clave de etiqueta, establezca el valor de la etiqueta en una cadena vacía, por ejemplo: `{"TagKey": ""}`. Puede agregar hasta 10 etiquetas de origen. Si establece TemplateScratchType en ArchitectureDetection, puede agregar hasta 5 etiquetas de origen.	{"a": "b"}
ResourceTypeFilter	array	No	El filtro de tipos de recursos.
	string	No	El filtro para tipos de recursos. Si se especifica una lista de tipos de recursos, solo se escanearán los recursos de los tipos especificados que contengan las etiquetas indicadas. Si no se especifica, se escanearán todos los recursos que contengan las etiquetas indicadas. Puede especificar hasta 20 tipos de recursos.	ALIYUN::ECS::VPC
SourceResourceGroup	object	No	El grupo de recursos de origen.
ResourceGroupId	string	Sí	El ID del grupo de recursos de origen.	rg-acfmzawhxxc****
ResourceTypeFilter	array	No	Los tipos de recursos para filtrar recursos.
	string	No	El filtro para tipos de recursos. Si se especifica una lista de tipos de recursos, solo se escanearán los recursos de los tipos especificados que contengan las etiquetas indicadas. Si no se especifica, se escanearán todos los recursos que contengan las etiquetas indicadas. Puede especificar hasta 20 tipos de recursos.	ALIYUN::ECS::VPC
PreferenceParameters	array<object>	No	Parámetros de configuración para el escenario de recursos.
	object	No
ParameterKey	string	Sí	La clave del parámetro. Para obtener más información sobre los valores válidos, consulte la sección Descripción complementaria de los parámetros de solicitud en este tema. Nota PreferenceParameters es opcional. Si especifica PreferenceParameters, debe especificar ParameterKey y ParameterValue. Debe establecer ParameterKey en DeletionPolicy cuando TemplateScratchType se establece en ResourceImport.	DeletionPolicy
ParameterValue	string	Sí	Valor del parámetro. El valor es una asignación a ParameterKey. Para obtener más información sobre los valores válidos, consulte la sección Descripción complementaria de los parámetros de solicitud en este tema. Nota PreferenceParameters es opcional. Si especifica PreferenceParameters, debe especificar ParameterKey y ParameterValue.	Retain
LogicalIdStrategy	string	No	Estrategia de generación de ID lógico. Valores válidos: LongTypePrefixAndIndexSuffix: prefijo de tipo largo + sufijo de tipo índice LongTypePrefixAndHashSuffix: prefijo de tipo largo + sufijo de tipo hash ShortTypePrefixAndHashSuffix: prefijo de tipo corto + sufijo de tipo hash Nota Valor predeterminado: LongTypePrefixAndIndexSuffix. Si TemplateScratchType se establece en ArchitectureDetection, el valor predeterminado es LongTypePrefixAndHashSuffix.	LongTypePrefixAndIndexSuffix
ClientToken	string	No	Garantiza la idempotencia de la solicitud. Este valor debe ser generado por el cliente y debe ser único a nivel global. No debe tener más de 64 caracteres de longitud y puede contener letras, dígitos, guiones (-) y guiones bajos (_). Para obtener más información, consulte Cómo garantizar la idempotencia.	123e4567-e89b-12d3-a456-42665544****
ExecutionMode	string	No	El modo de ejecución. Valores válidos: Async (predeterminado): modo asíncrono Sync: modo síncrono Nota Si el alcance de los recursos es grande, la ejecución síncrona tarda mucho tiempo. Se recomienda especificar ClientToken para evitar problemas de tiempo de espera.	Sync
Tags	array<object>	No	Las etiquetas del escenario de recursos.
	object	No
Key	string	Sí	La clave de la etiqueta N que desea agregar al escenario de recursos. Nota Tags es opcional. Si especifica Tags, debe especificar Tags.N.Key.	usage
Value	string	No	El valor de la etiqueta N que desea agregar al escenario de recursos.	test
ResourceGroupId	string	No	El ID del grupo de recursos al que desea asignar la política de instantáneas. Si deja este parámetro vacío, el escenario de recursos se agrega al grupo de recursos predeterminado.	rg-acfmxazb4ph6aiy****

Notas adicionales sobre los parámetros de solicitud

Para obtener más información, consulte Parámetros comunes.

Cuando especifica diferentes valores para el parámetro TemplateScratchType, los valores válidos de ParameterKey y ParameterValue también difieren.

Escenario de replicación de recursos

La siguiente tabla describe los valores válidos de ParameterKey y ParameterValue cuando establece TemplateScratchType en ArchitectureReplication.

ParameterKey	ParameterValue
DeletionPolicy	La política de eliminación de recursos. Valores válidos: Retain: conserva los recursos cuando elimina la pila a la que se replicaron los recursos. Delete: elimina los recursos de forma predeterminada cuando elimina la pila a la que se replicaron los recursos. Si conserva recursos específicos cuando aparece el cuadro de diálogo Eliminar pila, los recursos se conservan.
RegionId	El ID de la región de destino a la que desea replicar recursos. Si no especifica una región de destino, se utiliza la región actual de forma predeterminada. Ejemplo: cn-shanghai.
ZoneId	El ID de la zona de destino a la que desea replicar recursos. Si replica recursos en la misma región y no especifica una zona de destino, se utiliza la zona de los recursos de origen para los recursos replicados. Si replica recursos entre regiones y no especifica una zona de destino, el sistema filtra las zonas admitidas por todos los recursos. Ejemplo: cn-shanghai-b.
VpcId	El ID de la VPC de destino a la que desea replicar recursos. Si replica recursos en la misma región y no especifica una VPC de destino, se utiliza la VPC de los recursos de origen para los recursos replicados. Si replica recursos entre regiones y no especifica una VPC de destino, el sistema crea automáticamente una VPC en la región de destino. Ejemplo: vpc-bp1hye0s8b69xokfu****.
VSwitchId	El ID del vSwitch de destino al que desea replicar recursos. Si replica recursos en la misma región y no especifica un vSwitch de destino, se utiliza el vSwitch de los recursos de origen para los recursos replicados. Si replica recursos entre regiones y no especifica un vSwitch de destino, el sistema crea automáticamente un vSwitch en la región de destino. Ejemplo: vsw-bp11ufkwqwggtm1cj****.
NamePrefix	El prefijo del nombre del recurso. De forma predeterminada, el nombre de un recurso no contiene un prefijo. El prefijo debe tener entre 2 y 32 caracteres de longitud.
DisableNameUnique	Especifica si se debe deshabilitar la aplicación automática de la unicidad de nombres. De forma predeterminada, está habilitada. Para los recursos que tienen esta función habilitada, como el recurso Bucket, se agregan automáticamente códigos aleatorios de ocho caracteres a los nombres de los recursos para garantizar la unicidad de los nombres de los recursos replicados.
InstanceDataReplication	Especifica si se deben replicar los datos de la instancia ECS. Valor predeterminado: false. Valores válidos:* true: replica los datos de la instancia ECS. Si replica los datos en la misma región, se crea una imagen personalizada para la instancia de origen y se crean nuevas instancias basadas en la imagen personalizada. Si replica los datos entre regiones, se crea una imagen personalizada para la instancia de origen y se replica en la región de destino. Se crean nuevas instancias basadas en la imagen personalizada.

false: no replica los datos de la instancia ECS. | | InstancePeriod | La duración de la suscripción de la instancia ECS de destino por suscripción. De forma predeterminada, se utiliza la duración de la suscripción de la instancia de origen. | | InstancePeriodUnit | La unidad de la duración de la suscripción de la instancia ECS de destino por suscripción. De forma predeterminada, se utiliza la unidad de duración de la suscripción de la instancia de origen. Valores válidos:* Week
Month
Year | | InstanceAmount | El número de instancias ECS que se van a replicar. Este parámetro solo surte efecto cuando el recurso de origen es una única instancia ECS. | | RamAttachedPolicyReplication | Especifica si se debe replicar la política de RAM asociada con usuarios de RAM, grupos de usuarios y roles. Valor predeterminado: false. Valores válidos:* true
false | | AlbLoadBalancerEdition | La edición de la instancia ALB. Las funciones y las reglas de facturación varían según la edición. Valores válidos:* Basic: Edición básica
Standard: Edición estándar
StandardWithWaf: Edición con Web Application Firewall (WAF) habilitadoEjemplo: Standard. | | AlbAddressType | El tipo de dirección de la instancia ALB. Valores válidos:* Internet: La instancia ALB tiene una dirección IP pública. El nombre de dominio del Sistema de Nombres de Dominio (DNS) se resuelve a la dirección IP pública. Por lo tanto, se puede acceder a la instancia ALB a través de Internet.
Intranet: La instancia ALB solo tiene una dirección IP privada. El nombre de dominio DNS se resuelve a la dirección IP privada. Por lo tanto, solo se puede acceder a la instancia ALB dentro de la VPC donde se despliega la instancia ALB.Ejemplo: Internet. | | AlbAddressIpVersion | La versión de IP. Valores válidos:* IPv4: IPv4
DualStack: pila dobleEjemplo: IPv4. | | AlbZoneMappings | Las asignaciones entre zonas y vSwitches. Puede especificar como máximo 10 zonas. Si la región seleccionada admite dos o más zonas, seleccione al menos dos zonas para garantizar la alta disponibilidad de su servicio. El valor es una cadena JSON que tiene la misma estructura que el parámetro ZoneMappings en la operación CreateLoadBalancer de ALB. Ejemplo: [{"ZoneId": "cn-bejing-g": "VSwitchId": "vsw-gersdf****"}, {"ZoneId": "cn-bejing-f": "VSwitchId": "vsw-fersdf****"}] | | SlbListenerProtocols | El protocolo de listener de una instancia CLB. Especifica los protocolos de listener que se incluirán en la replicación. Puede establecer uno o más protocolos, separados por comas. De forma predeterminada, no se aplica ninguna restricción. Valores válidos:* tcp
udp
http
httpsEjemplo: tcp,udp. |

Nota

Cuando establece ParameterKey en InstanceDataReplication y ParameterValue en true, detenga la instancia de origen antes de replicar los recursos para garantizar la coherencia de los datos.

Escenario de perfilado de recursos

La siguiente tabla describe los valores válidos de ParameterKey y ParameterValue cuando establece TemplateScratchType en ArchitectureDetection.

ParameterKey	ParameterValue
RegionIds	Uno o más ID de región. Separe varios ID de región con comas (,). Se admite la región global `global`. Si no especifica una región, se utiliza la región del escenario.

Escenario de gestión de recursos

La siguiente tabla describe los valores válidos de ParameterKey y ParameterValue cuando establece TemplateScratchType en ResourceImport.

Nota

Para un escenario de gestión de recursos, debe establecer ParameterKey en DeletionPolicy.

ParameterKey	ParameterValue
DeletionPolicy	La política de eliminación de recursos. Valores válidos: Retain: conserva los recursos cuando elimina la pila que utiliza para gestionar los recursos. Delete: elimina los recursos de forma predeterminada cuando elimina la pila que utiliza para gestionar los recursos. Si conserva recursos específicos cuando aparece el cuadro de diálogo Eliminar pila, los recursos se conservan.
SlbListenerProtocols	El protocolo de listener de una instancia CLB. Especifica los protocolos de listener que se incluirán en la gestión. Puede establecer uno o más protocolos, separados por comas. De forma predeterminada, no se aplica ninguna restricción. Valores válidos: Valores válidos:* tcp

udp
http
httpsEjemplo: tcp,udp. |

Escenario de migración de recursos

La siguiente tabla describe los valores válidos de ParameterKey y ParameterValue cuando establece TemplateScratchType en ResourceMigration.

ParameterKey	ParameterValue
RegionId	El ID de la región de destino a la que desea migrar recursos. Si no especifica una región de destino, se utiliza la región actual de forma predeterminada. Ejemplo: cn-shanghai.
ZoneId	El ID de la zona de destino a la que desea migrar recursos. Si replica recursos en la misma región y no especifica una zona de destino, se utiliza la zona de los recursos de origen para los recursos replicados. Si replica recursos entre regiones y no especifica una zona de destino, el sistema filtra las zonas admitidas por todos los recursos. Ejemplo: cn-shanghai-b.
VpcId	El ID de la VPC de destino a la que desea migrar recursos. Si replica recursos en la misma región y no especifica una VPC de destino, se utiliza la VPC de los recursos de origen para los recursos replicados. Si replica recursos entre regiones y no especifica una VPC de destino, el sistema crea automáticamente una VPC en la región de destino. Ejemplo: vpc-bp1hye0s8b69xokfu****.
VSwitchId	El ID del vSwitch de destino al que desea migrar recursos. Si replica recursos en la misma región y no especifica un vSwitch de destino, se utiliza el vSwitch de los recursos de origen para los recursos replicados. Si replica recursos entre regiones y no especifica un vSwitch de destino, el sistema crea automáticamente un vSwitch en la región de destino. Ejemplo: vsw-bp11ufkwqwggtm1cj****.
InstanceDataReplication	Especifica si se deben migrar los datos de la instancia ECS. Valores válidos: true: migra los datos de la instancia ECS. Si migra los datos en la misma región, se crea una imagen personalizada para la instancia de origen y se crean nuevas instancias basadas en la imagen personalizada. Si migra los datos entre regiones, se crea una imagen personalizada para la instancia de origen y se replica en la región de destino. Se crean nuevas instancias basadas en la imagen personalizada. false: no migra los datos de la instancia ECS.

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object
RequestId	string	El ID de la solicitud.	84980977-22F0-5421-B30D-B201311D5DCF
TemplateScratchId	string	El ID del escenario de recursos.	ts-7f7a704cf71c49a6****

Ejemplos

Respuesta exitosa

JSON Formato

{
  "RequestId": "84980977-22F0-5421-B30D-B201311D5DCF",
  "TemplateScratchId": "ts-7f7a704cf71c49a6****"
}

Códigos de error

Consulte Códigos de error para ver la lista completa.

Notas de la versión

Consulte Notas de la versión para ver la lista completa.