ListResourceTypes - Resource Orchestration Service - Alibaba Cloud Documentation Center

This topic provides an example on how to query the list of resource types supported by Resource Orchestration Service (ROS).

Operation description

For more information about errors common to all operations, see Common error codes.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
ros:ListResourceTypes	get	All Resources *	none	none

Request parameters

Parameter	Type	Required	Description	Example
EntityType	string	No	The entity type. Valid values: All: all types of resources. Resource (default): regular resources. For more information, see Resources . DataSource: DataSource resources. For more information, see DataSource resources. Module: modules.	Resource
Provider	string	No	The provider of the resource type. Valid values: ROS (default): The resource type is provided by Resource Orchestration Service (ROS). Self: The resource type is provided by you.	ROS
ResourceType	string	No	The resource type. The resource type can contain letters, digits, colons (:), and asterisks (). You can use an asterisk () to perform a fuzzy match.	MODULE::MyOrganization::MyService::MyUsecase

Response parameters

Parameter	Type	Description	Example
	object
ResourceTypes	array	The array of resource types.
	string		["ALIYUN::ECS::Instance","ALIYUN::RDS::Instance"]
RequestId	string	The ID of the request.	EA00860C-ECAF-5253-A1F9-8198695A7157
ResourceTypeSummaries	array<object>	The resource type summaries.
	object
Provider	string	The provider of the resource type. Valid values: ROS: The resource type is provided by ROS. Self: The resource type is provided by you.	ROS
EntityType	string	The entity type. Valid values: Resource: regular resources. DataSource: DataSource resources. Module: modules.	Module
ResourceType	string	The resource type.	MODULE::MyOrganization::MyService::MyUsecase
DefaultVersionId	string	The ID of the default version.	v1
LatestVersionId	string	The ID of the latest version.	v10
CreateTime	string	The creation time. The time is displayed in UTC. The time follows the ISO 8601 standard in the YYYY-MM-DDThh:mm:ss format.	2023-02-24T08:25:21
UpdateTime	string	The update time. The time is displayed in UTC. The time follows the ISO 8601 standard in the YYYY-MM-DDThh:mm:ss format.	2023-02-24T08:25:21
Description	string	The description of the resource type.	It is a demo.
TotalVersionCount	integer	The number of versions.	10

The operation that you want to perform. Set the value to ListResourceTypes.

Examples

Sample success responses

JSONformat

{
  "ResourceTypes": [
    "[\"ALIYUN::ECS::Instance\",\"ALIYUN::RDS::Instance\"]"
  ],
  "RequestId": "EA00860C-ECAF-5253-A1F9-8198695A7157",
  "ResourceTypeSummaries": [
    {
      "Provider": "ROS",
      "EntityType": "Module",
      "ResourceType": "MODULE::MyOrganization::MyService::MyUsecase",
      "DefaultVersionId": "v1",
      "LatestVersionId": "v10",
      "CreateTime": "2023-02-24T08:25:21",
      "UpdateTime": "2023-02-24T08:25:21",
      "Description": "It is a demo.",
      "TotalVersionCount": 10
    }
  ]
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2023-05-10	The request parameters of the API has changed. The response structure of the API has changed	View Change Details
2022-01-18	The request parameters of the API has changed	View Change Details