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

Consulta una lista de plantillas privadas y compartidas.

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

list

*Template

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

Ninguna

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
PageNumber	integer	No	El número de página de la lista de plantillas. El valor comienza desde 1. Valor predeterminado: 1.	1
PageSize	integer	No	El número de entradas que se devolverán en cada página para una consulta paginada. Valores válidos: de 1 a 50. Valor predeterminado: 10.	10
TemplateName	string	No	El nombre de la plantilla. Este parámetro solo surte efecto cuando ShareType se establece en Private. El nombre puede tener hasta 255 caracteres de longitud. Debe comenzar con un dígito o una letra y puede contener dígitos, letras, guiones (-) y guiones bajos (_).	MyTemplate
ShareType	string	No	El tipo de uso compartido de la plantilla. Valores válidos: Private (predeterminado): La plantilla es propiedad del usuario. Shared: La plantilla está compartida por otros usuarios. Official: La plantilla es una plantilla oficial compartida.	Private
Tag	array<object>	No	Las etiquetas. Puede especificar hasta 20 etiquetas.
	object	No	La etiqueta.
Key	string	No	La clave de la etiqueta. Este parámetro solo surte efecto cuando ShareType se establece en Private. Puede especificar hasta 20 claves de etiqueta.	usage
Value	string	No	El valor de la etiqueta. Este parámetro solo surte efecto cuando ShareType se establece en Private. Puede especificar hasta 20 valores de etiqueta.	deploy
ResourceGroupId	string	No	El ID del grupo de recursos. Para obtener más información sobre los grupos de recursos, consulte ¿Qué es un grupo de recursos?.	rg-acfmxazb4ph6aiy****
IncludeTags	string	No	Especifica si se debe consultar la información de las etiquetas. Valores válidos: Enabled: consulta la información de las etiquetas. Disabled (predeterminado): no consulta la información de las etiquetas.	Enabled
Filters	array<object>	No	El filtro.
	object	No	El filtro.
Name	string	No	El nombre del filtro. Puede seleccionar uno o más nombres para consultar. Valores válidos: Categories: categoría de la plantilla DeployTypes: tipo de despliegue ApplicationScenes: escenario de aplicación BasicServices: servicio básico ResourceTypes: tipo de recurso TemplateNames: nombre de la plantilla	Categories
Values	array	No	La lista de valores de filtro.
	string	No	La lista de valores de filtro. El valor de N puede ser de 1 a 10.	ROS

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
TotalCount	integer	El número total de plantillas.	1
PageSize	integer	El número de entradas devueltas por página.	10
RequestId	string	El ID de la solicitud.	C3A8413B-1F16-4DED-AC3E-61A00718DE8A
PageNumber	integer	El número de página de la lista de plantillas. El valor comienza desde 1.	1
Templates	array<object>	La lista de plantillas.
	array<object>	La lista de plantillas.
TemplateARN	string	El nombre de recurso de Alibaba Cloud (ARN) de la plantilla.	acs:ros::151266687691*:template/a52f81be-496f-4e1c-a286-8852ab54**
UpdateTime	string	La hora en que se actualizó la plantilla por última vez.	2019-10-15T08:17:14.000000
Description	string	La descripción de la plantilla.	test-description
CreateTime	string	La hora en que se creó la plantilla.	2019-10-15T08:17:14.000000
TemplateName	string	El nombre de la plantilla.	demo
TemplateVersion	string	El nombre de la versión más reciente de la plantilla.	v1
TemplateId	string	El ID de la plantilla.	4d4f5aa2-3260-4e47-863b-763fbb12****
OwnerId	string	El ID de la cuenta de Alibaba Cloud a la que pertenece la plantilla.	151266687691****
ShareType	string	El tipo de uso compartido de la plantilla. Valores válidos: Private: La plantilla es propiedad del usuario. Shared: La plantilla está compartida por otros usuarios.	Private
ResourceGroupId	string	El ID del grupo de recursos.	rg-acfmxazb4ph6aiy****
Tags	array<object>	Las etiquetas de la plantilla.
	object	Las etiquetas de la plantilla.
Key	string	La clave de la etiqueta de la plantilla.	usage
Value	string	El valor de la etiqueta de la plantilla.	test
AdditionalInfo	object	La información complementaria sobre 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"]}
TemplateUrl	string	La URL de la plantilla.	https://ros-public-templates.oss-cn-hangzhou.aliyuncs.com/demo.yml

Ejemplos

Respuesta exitosa

JSON Formato

{
  "TotalCount": 1,
  "PageSize": 10,
  "RequestId": "C3A8413B-1F16-4DED-AC3E-61A00718DE8A",
  "PageNumber": 1,
  "Templates": [
    {
      "TemplateARN": "acs:ros:*:151266687691****:template/a52f81be-496f-4e1c-a286-8852ab54****",
      "UpdateTime": "2019-10-15T08:17:14.000000",
      "Description": "test-description",
      "CreateTime": "2019-10-15T08:17:14.000000",
      "TemplateName": "demo",
      "TemplateVersion": "v1",
      "TemplateId": "4d4f5aa2-3260-4e47-863b-763fbb12****",
      "OwnerId": "151266687691****",
      "ShareType": "Private",
      "ResourceGroupId": "rg-acfmxazb4ph6aiy****",
      "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"
        ]
      },
      "TemplateUrl": "https://ros-public-templates.oss-cn-hangzhou.aliyuncs.com/demo.yml"
    }
  ]
}

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.