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

Consulta los detalles de una plantilla al especificar una pila, un grupo de pilas, un conjunto de cambios o una plantilla personalizada.

Descripción de la operación

Este tema proporciona un ejemplo sobre cómo consultar los detalles de una plantilla cuyo ID es 5ecd1e10-b0e9-4389-a565-e4c15efc**** en la región cn-hangzhou.

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:GetTemplate

get

stack.

acs:ros:{#regionId}:{#accountId}:stack/{#stackId}

template.

acs:ros:*:{#accountId}:template/{#templateId}

Ninguna

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
StackId	string	No	El ID de la pila. Nota Debe especificar solo uno de los siguientes parámetros: StackId, ChangeSetId, StackGroupName y TemplateId.	4a6c9851-3b0f-4f5f-b4ca-a14bf691****
RegionId	string	No	El ID de la región de la pila o el grupo de pilas al que pertenece la plantilla. Puede llamar a la operación DescribeRegions para consultar la lista de regiones más reciente.	cn-hangzhou
ChangeSetId	string	No	El ID del conjunto de cambios. Nota Debe especificar solo uno de los siguientes parámetros: StackId, ChangeSetId, StackGroupName y TemplateId.	1f6521a4-05af-4975-afe9-bc4b45ad****
TemplateId	string	No	El ID de la plantilla. Se admiten tanto plantillas compartidas como privadas. Para una plantilla compartida, el TemplateId es el mismo que el TemplateARN. Utilice este valor para la consulta. Nota Debe especificar solo uno de los siguientes parámetros: StackId, ChangeSetId, StackGroupName y TemplateId.	5ecd1e10-b0e9-4389-a565-e4c15efc****
TemplateVersion	string	No	La versión de la plantilla. Este parámetro solo surte efecto cuando se especifica TemplateId. Para una plantilla compartida, este parámetro solo se admite cuando VersionOption se establece en AllVersions. Para obtener más información, consulte SetTemplatePermission. Valores válidos: v1 a v65000, y Draft. Valores válidos para plantillas compartidas: v1 a v65000.	v1
TemplateStage	string	No	La etapa de la plantilla. Este parámetro solo surte efecto cuando se especifica StackId, ChangeSetId o StackGroupName. Valores válidos: Processed: la plantilla analizada y transformada. Este es el valor predeterminado. Original: la plantilla original especificada por el usuario.	Processed
IncludePermission	string	No	Especifica si se debe consultar la información de uso compartido de la plantilla. Valores válidos: Enabled: consulta la información de uso compartido. Disabled: no consulta la información de uso compartido. Este es el valor predeterminado. Nota Solo el propietario de la plantilla puede consultar la información de uso compartido.	Enabled
StackGroupName	string	No	El nombre del grupo de pilas. Nota Debe especificar solo uno de los siguientes parámetros: StackId, ChangeSetId, StackGroupName y TemplateId.	MyStackGroup
IncludeTags	string	No	Especifica si se debe consultar la información de etiquetas. Valores válidos: Enabled: consulta la información de etiquetas. Disabled: no consulta la información de etiquetas. Este es el valor predeterminado. Nota Este parámetro solo surte efecto cuando se especifica TemplateId.	Enabled

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

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object
TemplateARN	string	El ARN de la plantilla. Este parámetro se devuelve solo cuando se especifica TemplateId.	acs:ros::151266687691*:template/a52f81be-496f-4e1c-a286-8852ab54**
Description	string	La descripción de la plantilla. Este parámetro se devuelve solo cuando se especifica TemplateId.	ROS template for create ECS instance.
RequestId	string	El ID de la solicitud.	B288A0BE-D927-4888-B0F7-B35EF84****
CreateTime	string	La hora en que se creó la plantilla. La hora se muestra en el formato AAAA-MM-DDThh:mm:ss. Este parámetro se devuelve solo cuando se especifica TemplateId. Nota Si se especifica TemplateVersion, se devuelve la hora de creación de la plantilla de la versión especificada. Si no se especifica TemplateVersion, se devuelve la hora de creación de la plantilla de la versión predeterminada.	2020-11-18T08:49:26
StackGroupName	string	El nombre del grupo de pilas. Este parámetro se devuelve solo cuando se especifica StackGroupName.	MyStackGroup
TemplateVersion	string	La versión de la plantilla. Este parámetro se devuelve solo cuando se especifica TemplateId. Si no se especifica TemplateVersion o no surte efecto, este parámetro indica la versión actual de la plantilla. Para una plantilla compartida, este parámetro se devuelve solo cuando VersionOption se establece en AllVersions.	v1
TemplateBody	string	El contenido de la plantilla.	{"ROSTemplateFormatVersion": "2015-09-01"}
ChangeSetId	string	El ID del conjunto de cambios. Este parámetro se devuelve solo cuando se especifica ChangeSetId.	e85abe0c-6528-43fb-ae93-fdf8de22****
OwnerId	string	El ID de la cuenta de Alibaba Cloud a la que pertenece la plantilla. Este parámetro se devuelve solo cuando se especifica TemplateId.	151266687691****
UpdateTime	string	La hora en que se actualizó por última vez la plantilla. La hora se muestra en el formato AAAA-MM-DDThh:mm:ss. Este parámetro se devuelve solo cuando se especifica TemplateId. Nota Si se especifica TemplateVersion, se devuelve la hora de la última actualización de la plantilla de la versión especificada. Si no se especifica TemplateVersion, se devuelve la hora de la última actualización de la plantilla.	2020-12-07T06:11:48
Permissions	array<object>	El estado de uso compartido de la plantilla. Este parámetro se devuelve solo cuando se especifica TemplateId y IncludePermission se establece en Enabled. Nota Si no se especifica TemplateVersion o no surte efecto, se devuelve el estado de uso compartido de la plantilla. Si se especifica TemplateVersion y surte efecto, se devuelve el estado de uso compartido de la plantilla asociada a la versión.
	object
VersionOption	string	La opción de versión compartida. Este parámetro se devuelve solo cuando ShareOption se establece en ShareToAccounts. Valores válidos: AllVersions: comparte todas las versiones de la plantilla compartida. Latest: comparte solo la última versión de la plantilla compartida. Cuando se añade una nueva versión a la plantilla compartida, la versión compartida cambia en consecuencia para mantenerse siempre como la más reciente. Current: comparte solo la versión actual más reciente de la plantilla compartida. Cuando se añade una nueva versión a la plantilla compartida, la versión compartida permanece sin cambios. Specified: comparte solo una versión especificada de la plantilla compartida.	AllVersions
AccountId	string	La cuenta de Alibaba Cloud con la que se comparte la plantilla.	142437958638****
ShareOption	string	La opción de uso compartido. Valor válido: ShareToAccounts, que indica que la plantilla se comparte con otras cuentas de Alibaba Cloud.	ShareToAccounts
TemplateVersion	string	La versión de la plantilla compartida. Este parámetro se devuelve cuando ShareOption se establece en ShareToAccounts y VersionOption se establece en Specified o Current. Cuando el parámetro TemplateVersion se establece en Draft, si la versión Draft existe, se devuelve Draft. Si la versión Draft no existe o se ha eliminado, se devuelve la versión actual más reciente. Valores válidos: v1 a v65000, y Draft.	v1
ShareSource	string	El origen de la relación de uso compartido. Valores válidos: ROS: la relación de uso compartido se establece mediante la consola o la API de ROS. ResourceDirectory: la relación de uso compartido se establece para las cuentas de un directorio de recursos mediante la función de uso compartido de recursos en Resource Management. Nota El uso compartido desde ROS y el uso compartido desde Resource Directory tienen cuotas independientes. El uso compartido desde Resource Directory no se puede cancelar ni sobrescribir mediante la consola o la API de ROS. El uso compartido desde Resource Directory puede sobrescribir el uso compartido desde ROS.	ROS
TemplateName	string	El nombre de la plantilla. Este parámetro se devuelve solo cuando se especifica TemplateId. Nota Si se especifica TemplateVersion, se devuelve el nombre de la plantilla asociada a la versión. Si no se especifica TemplateVersion, se devuelve el nombre de la plantilla.	MyTemplate
RegionId	string	El ID de la región de la pila o el grupo de pilas al que pertenece la plantilla. Este parámetro se devuelve solo cuando se especifica StackId, ChangeSetId o StackGroupName.	cn-hangzhou
TemplateId	string	El ID de la plantilla. Este parámetro se devuelve solo cuando se especifica TemplateId. Para una plantilla compartida, el valor devuelto es el mismo que el TemplateARN.	a52f81be-496f-4e1c-a286-8852ab54****
StackId	string	El ID de la pila. Este parámetro se devuelve solo cuando se especifica StackId.	4a6c9851-3b0f-4f5f-b4ca-a14bf691****
ShareType	string	El tipo de uso compartido de la plantilla. Este parámetro se devuelve solo cuando se especifica TemplateId. Valores válidos: Private: la plantilla es propiedad del usuario. Shared: la plantilla la comparte otro usuario.	Private
ResourceGroupId	string	El ID del grupo de recursos.	rg-acfmxazb4ph6aiy****
Interface	string	La descripción de la interfaz.	{}
Tags	array<object>	Las etiquetas de la plantilla.
	object	Las etiquetas de la plantilla.
Key	string	La clave de etiqueta de la plantilla.	usage
Value	string	El valor de etiqueta de la plantilla.	test
AdditionalInfo	object	La información complementaria de la plantilla pública.	{"DeploymentDuration":null,"Title":"Self-Built_ElasticSearch_Snapshot_Saved_To_OSS","Labels":{"ResourceTypes":["ALIYUN::ECS::Instance","ALIYUN::ECS::SecurityGroup","ALIYUN::ECS::VPC","ALIYUN::ECS::VSwitch","ALIYUN::OSS::Bucket","ALIYUN::ROS::WaitCondition","ALIYUN::ROS::WaitConditionHandle"],"DeployTypes":["ROS"],"ApplicationScenes":["Other"]},"Provider":"ROS","Categories":["Solution"]}

Ejemplos

Respuesta exitosa

JSON Formato

{
  "TemplateARN": "acs:ros:*:151266687691****:template/a52f81be-496f-4e1c-a286-8852ab54****",
  "Description": "Plantilla de ROS para crear una instancia de ECS",
  "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****\t",
  "ShareType": "Private",
  "ResourceGroupId": "rg-acfmxazb4ph6aiy****",
  "Interface": "{}",
  "Tags": [
    {
      "Key": "usage",
      "Value": "test"
    }
  ],
  "AdditionalInfo": {
    "DeploymentDuration": null,
    "Title": "Self-Built_ElasticSearch_Snapshot_Saved_To_OSS",
    "Labels": {
      "ResourceTypes": [
        "ALIYUN::ECS::Instance",
        "ALIYUN::ECS::SecurityGroup",
        "ALIYUN::ECS::VPC",
        "ALIYUN::ECS::VSwitch",
        "ALIYUN::OSS::Bucket",
        "ALIYUN::ROS::WaitCondition",
        "ALIYUN::ROS::WaitConditionHandle"
      ],
      "DeployTypes": [
        "ROS"
      ],
      "ApplicationScenes": [
        "other"
      ]
    },
    "Provider": "ROS",
    "Categories": [
      "Solution"
    ]
  }
}

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.