GetTemplate - - Centro de documentación de Alibaba Cloud

Consulta los detalles de una plantilla. Por ejemplo, puede llamar a esta operación para consultar la pila, el grupo de pilas y el conjunto de cambios definidos en una plantilla personalizada.

En este ejemplo, se consultan los detalles de una plantilla cuyo ID es 5ecd1e10-b0e9-4389-a565-e4c15efc**** y cuyo ID de región es cn-hangzhou.

Depuración

OpenAPI Explorer calcula automáticamente el valor de la firma. Para su comodidad, le recomendamos que llame a esta operación en OpenAPI Explorer. OpenAPI Explorer genera dinámicamente el código de muestra de la operación para diferentes SDK.

Parámetros de solicitud

Parámetro	Tipo	Obligatorio	Ejemplo	Descripción
Action	String	Sí	GetTemplate	La operación que desea ejecutar. Establezca el valor en GetTemplate.
StackId	String	No	4a6c9851-3b0f-4f5f-b4ca-a14bf691****	El ID de la pila. Nota Debe especificar solo uno de los siguientes parámetros: StackId, ChangeSetId, StackGroupName y TemplateId.
RegionId	String	Sí	cn-hangzhou	El ID de la región a la que pertenece la pila o el grupo de pilas definido en la plantilla. Puede llamar a la operación DescribeRegions para consultar la lista de regiones más reciente.
ChangeSetId	String	No	1f6521a4-05af-4975-afe9-bc4b45ad****	El ID del conjunto de cambios. Nota Debe especificar solo uno de los siguientes parámetros: StackId, ChangeSetId, StackGroupName y TemplateId.
TemplateId	String	No	5ecd1e10-b0e9-4389-a565-e4c15efc****	El ID de la plantilla. Este parámetro se aplica a plantillas compartidas y privadas. Si la plantilla es compartida, el valor del parámetro TemplateId coincide con el valor del parámetro TemplateARN. Puede usar el ID de la plantilla para consultar una plantilla compartida. Nota Debe especificar solo uno de los siguientes parámetros: StackId, ChangeSetId, StackGroupName y TemplateId.
TemplateVersion	String	No	v1	La versión de la plantilla. Este parámetro solo surte efecto cuando se especifica el parámetro TemplateId. Si la plantilla es compartida, solo puede especificar este parámetro si establece el parámetro VersionOption en AllVersions. Valores válidos: v1 a v100.
TemplateStage	String	No	Processed	La etapa de la plantilla. Este parámetro solo surte efecto cuando se especifica el parámetro StackId, ChangeSetId o StackGroupName. Valor predeterminado: Processed. Valores válidos: Processed: devuelve la plantilla procesada que contiene transformaciones. Original: devuelve la plantilla original que usted especificó.
IncludePermission	String	No	Enabled	Especifica si se debe consultar la información sobre el uso compartido de la plantilla. Valor predeterminado: Disabled. Valores válidos: Enabled Disabled Nota Solo el propietario de la plantilla puede consultar la información sobre su uso compartido.
StackGroupName	String	No	MyStackGroup	El nombre del grupo de pilas. Nota Debe especificar solo uno de los siguientes parámetros: StackId, ChangeSetId, StackGroupName y TemplateId.
IncludeTags	String	No	Enabled	Especifica si se debe consultar la información de las etiquetas. Valor predeterminado: Disabled. Valores válidos: Enabled Disabled Nota Este parámetro solo surte efecto cuando se especifica el parámetro TemplateId.

Para obtener más información sobre los parámetros de solicitud comunes, consulte Parámetros comunes.

Parámetros de respuesta

Parámetro	Tipo	Ejemplo	Descripción
TemplateARN	String	acs:ros::151266687691:template/a52f81be-496f-4e1c-a286-8852ab54*	El Alibaba Cloud Resource Name (ARN) de la plantilla. Este parámetro se devuelve solo si se especifica el parámetro TemplateId.
Description	String	ROS template for create ECS instance.	La descripción de la plantilla. Este parámetro se devuelve solo si se especifica el parámetro TemplateId.
RequestId	String	B288A0BE-D927-4888-B0F7-B35EF84****	El ID de la solicitud.
CreateTime	String	2020-11-18T08:49:26	La hora en que se creó la plantilla. Este parámetro se devuelve solo si se especifica el parámetro TemplateId. Nota Si se especifica el parámetro TemplateVersion, se devuelve la hora de creación de la plantilla cuya versión se indicó mediante dicho parámetro. Si no se especifica el parámetro TemplateVersion, se devuelve la hora de creación de la plantilla cuya versión es la predeterminada.
StackGroupName	String	MyStackGroup	El nombre del grupo de pilas. Este parámetro se devuelve solo si se especifica el parámetro StackGroupName.
TemplateVersion	String	v1	La versión de la plantilla. Este parámetro se devuelve solo si se especifica el parámetro TemplateId. Si el parámetro TemplateVersion no se especifica o no surte efecto, el valor de este parámetro corresponde a la versión predeterminada de la plantilla. Si la plantilla es compartida, este parámetro se devuelve solo si el parámetro VersionOption está establecido en AllVersions.
TemplateBody	String	{"ROSTemplateFormatVersion": "2015-09-01"}	El cuerpo de la plantilla.
ChangeSetId	String	e85abe0c-6528-43fb-ae93-fdf8de22****	El ID del conjunto de cambios. Este parámetro se devuelve solo si se especifica el parámetro ChangeSetId.
OwnerId	String	151266687691****	El ID de la cuenta de Alibaba Cloud a la que pertenece la plantilla. Este parámetro se devuelve solo si se especifica el parámetro TemplateId.
UpdateTime	String	2020-12-07T06:11:48	La hora de la última actualización de la plantilla. Este parámetro se devuelve solo si se especifica el parámetro TemplateId. Nota Si se especifica el parámetro TemplateVersion, se devuelve la hora de la última actualización de la plantilla cuya versión se indicó mediante dicho parámetro. Si no se especifica el parámetro TemplateVersion, se devuelve la hora de la última actualización de la plantilla cuya versión es la predeterminada.
Permissions	Array of Permission		Detalles del estado de uso compartido de la plantilla. Este parámetro se devuelve solo si se especifica el parámetro TemplateId y el parámetro IncludePermission está establecido en Enabled. Nota Si el parámetro TemplateVersion no se especifica o no surte efecto, se devuelven los detalles del estado de uso compartido de la plantilla cuya versión es la predeterminada. Si se especifica el parámetro TemplateVersion y surte efecto, se devuelven los detalles del estado de uso compartido de la plantilla cuya versión se indicó mediante dicho parámetro.
VersionOption	String	AllVersions	La opción de versión para la plantilla compartida. Este parámetro se devuelve solo si el parámetro ShareOption está establecido en ShareToAccounts. Valores válidos: AllVersions: Se comparten todas las versiones de la plantilla. Latest: Solo se comparte la versión más reciente de la plantilla. Cuando se actualiza la versión de la plantilla, ROS actualiza la versión compartida a la más reciente. Current: Solo se comparte la versión predeterminada de la plantilla al momento de configurar el uso compartido. Cuando se actualiza la versión de la plantilla, ROS no actualiza la versión compartida. Specified: Solo se comparte la versión especificada de la plantilla.
AccountId	String	142437958638****	El ID de la cuenta de Alibaba Cloud con la que se comparte la plantilla.
ShareOption	String	ShareToAccounts	La opción de uso compartido. El valor se establece en ShareToAccounts, lo que indica que la plantilla se comparte con una o más cuentas de Alibaba Cloud.
TemplateVersion	String	v1	La versión de la plantilla compartida. Este parámetro se devuelve solo si el parámetro ShareOption está establecido en ShareToAccounts y el parámetro VersionOption está establecido en Specified o Current. Valores válidos: v1 a v100.
ShareSource	String	ROS	El servicio que se utiliza para compartir recursos. Valores válidos: ROS: Los recursos se comparten desde ROS mediante la consola de ROS o llamando a la API de ROS. ResourceDirectory: Los recursos se comparten con cuentas en un directorio de recursos desde Resource Management mediante la función de uso compartido de recursos. Nota La cantidad de cuentas con las que se comparten recursos desde ROS es independiente de la cantidad de cuentas con las que se comparten recursos desde el directorio de recursos. Los recursos compartidos desde ROS no pueden anular ni sobrescribir los recursos compartidos desde el directorio de recursos. Los recursos compartidos desde el directorio de recursos pueden sobrescribir los recursos compartidos desde ROS.
TemplateName	String	MyTemplate	El nombre de la plantilla. Este parámetro se devuelve solo si se especifica el parámetro TemplateId. Nota Si se especifica el parámetro TemplateVersion, se devuelve el nombre de la plantilla cuya versión se indicó mediante dicho parámetro. Si no se especifica el parámetro TemplateVersion, se devuelve el nombre de la plantilla cuya versión es la predeterminada.
RegionId	String	cn-hangzhou	El ID de la región a la que pertenece la pila o el grupo de pilas definido en la plantilla. Este parámetro se devuelve solo si se especifica el parámetro StackId, ChangeSetId o StackGroupName.
TemplateId	String	a52f81be-496f-4e1c-a286-8852ab54****	El ID de la plantilla. Este parámetro se devuelve solo si se especifica el parámetro TemplateId. Si la plantilla es compartida, el valor de este parámetro coincide con el valor del parámetro TemplateARN.
StackId	String	4a6c9851-3b0f-4f5f-b4ca-a14bf691****	El ID de la pila. Este parámetro se devuelve solo si se especifica el parámetro StackId.
ShareType	String	Private	El tipo de uso compartido de la plantilla. Este parámetro se devuelve solo si se especifica el parámetro TemplateId. Valores válidos: Private: La plantilla solo puede ser utilizada por su propietario. Shared: La plantilla se comparte con otros usuarios.
ResourceGroupId	String	rg-acfmxazb4ph6aiy****	El ID del resource group.
Interface	String	{}	La descripción de la interfaz web en la consola de ROS.
Tags	Array of Tags		Las etiquetas de la plantilla.
Key	String	usage	La clave de la etiqueta.
Value	String	test	El valor de la etiqueta.

Ejemplos

Solicitudes de muestra

http(s)://ros.aliyuncs.com/?Action=GetTemplate
&RegionId=cn-hangzhou
&TemplateId=5ecd1e10-b0e9-4389-a565-e4c15efc****
&IncludePermission=Enabled
&<Common request parameters>

Respuestas exitosas de muestra

Formato XML

HTTP/1.1 200 OK
Content-Type:application/xml

<GetTemplateResponse>
    <TemplateARN>acs:ros:*:151266687691****:template/a52f81be-496f-4e1c-a286-8852ab54****</TemplateARN>
    <Description>ROS template for create ECS instance.</Description>
    <RequestId>B288A0BE-D927-4888-B0F7-B35EF84****</RequestId>
    <CreateTime>2020-11-18T08:49:26</CreateTime>
    <StackGroupName>MyStackGroup</StackGroupName>
    <TemplateVersion>v1</TemplateVersion>
    <TemplateBody>{"ROSTemplateFormatVersion": "2015-09-01"}</TemplateBody>
    <ChangeSetId>e85abe0c-6528-43fb-ae93-fdf8de22****</ChangeSetId>
    <OwnerId>151266687691****</OwnerId>
    <UpdateTime>2020-12-07T06:11:48</UpdateTime>
    <Permissions>
        <VersionOption>AllVersions</VersionOption>
        <AccountId>142437958638****</AccountId>
        <ShareOption>ShareToAccounts</ShareOption>
        <TemplateVersion>v1</TemplateVersion>
        <ShareSource>ROS</ShareSource>
    </Permissions>
    <TemplateName>MyTemplate</TemplateName>
    <RegionId>cn-hangzhou</RegionId>
    <TemplateId>a52f81be-496f-4e1c-a286-8852ab54****</TemplateId>
    <StackId>4a6c9851-3b0f-4f5f-b4ca-a14bf691****</StackId>
    <ShareType>Private</ShareType>
    <ResourceGroupId>rg-acfmxazb4ph6aiy****</ResourceGroupId>
    <Interface>{}</Interface>
    <Tags>
        <Key>usage</Key>
        <Value>test</Value>
    </Tags>
</GetTemplateResponse>

Formato JSON

HTTP/1.1 200 OK
Content-Type:application/json

{
  "TemplateARN" : "acs:ros:*:151266687691****:template/a52f81be-496f-4e1c-a286-8852ab54****",
  "Description" : "ROS template for create ECS instance.",
  "RequestId" : "B288A0BE-D927-4888-B0F7-B35EF84****",
  "CreateTime" : "2020-11-18T08:49:26",
  "StackGroupName" : "MyStackGroup",
  "TemplateVersion" : "v1",
  "TemplateBody" : "{\"ROSTemplateFormatVersion\": \"2015-09-01\"}",
  "ChangeSetId" : "e85abe0c-6528-43fb-ae93-fdf8de22****",
  "OwnerId" : "151266687691****",
  "UpdateTime" : "2020-12-07T06:11:48",
  "Permissions" : {
    "VersionOption" : "AllVersions",
    "AccountId" : "142437958638****",
    "ShareOption" : "ShareToAccounts",
    "TemplateVersion" : "v1",
    "ShareSource" : "ROS"
  },
  "TemplateName" : "MyTemplate",
  "RegionId" : "cn-hangzhou",
  "TemplateId" : "a52f81be-496f-4e1c-a286-8852ab54****",
  "StackId" : "4a6c9851-3b0f-4f5f-b4ca-a14bf691****",
  "ShareType" : "Private",
  "ResourceGroupId" : "rg-acfmxazb4ph6aiy****",
  "Interface" : "{}",
  "Tags" : [ {
    "Key" : "usage",
    "Value" : "test"
  } ]
}

Códigos de error

Para obtener una lista de códigos de error, visite el Centro de errores de API.

Código de estado HTTP	Código de error	Mensaje de error	Descripción
404	ChangeSetNotFound	The ChangeSet ({name}) of Stack ({stack}) could not be found.	El mensaje de error devuelto porque el conjunto de cambios especificado no existe. name indica el nombre o ID del conjunto de cambios, y stack indica el nombre o ID de la pila.
404	ChangeSetNotFound	The ChangeSet {ID} could not be found.	El mensaje de error devuelto porque el conjunto de cambios especificado no existe. ID indica el ID del conjunto de cambios.
404	StackNotFound	The Stack ({name}) could not be found.	El mensaje de error devuelto porque la pila no existe. name indica el nombre o ID de la pila.
404	TemplateNotFound	The Template { ID } could not be found.	El mensaje de error devuelto porque la plantilla especificada no existe. ID indica el ID de la plantilla.
404	TemplateNotFound	The Template { ID } with version { version } could not be found.	El mensaje de error devuelto porque la plantilla o la versión de la plantilla especificada no existe. ID indica el ID de la plantilla. version indica la versión de la plantilla.
404	StackGroupNotFound	The StackGroup ({name}) could not be found.	El mensaje de error devuelto porque el grupo de pilas especificado no existe. name indica el nombre del grupo de pilas.