ListResourceTypes - Resource Orchestration Service - Alibaba Cloud Documentation Center

Queries the list of supported resource types.

Operation description

This topic provides an example of how to query the regular resource types that are supported by ROS.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

ros:ListResourceTypes

get

*All Resource

*

None

Request parameters

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

Response parameters

Parameter	Type	Description	Example
	object
ResourceTypes	array	The array of resource types.
	string	An array of resource types.	["ALIYUN::ECS::Instance","ALIYUN::RDS::Instance"]
RequestId	string	The request ID.	EA00860C-ECAF-5253-A1F9-8198695A7157
ResourceTypeSummaries	array<object>	The list of resource type summaries.
	object
Provider	string	The provider of the resource type. Valid values: ROS: Resource Orchestration Service. Self: your own.	ROS
EntityType	string	The entity type. Valid values: Resource: regular resource types. DataSource: data source resource types. 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 time when the resource type was created. The time is displayed in the YYYY-MM-DDThh:mm:ss format in UTC.	2023-02-24T08:25:21
UpdateTime	string	The time when the resource type was updated. The time is displayed in the YYYY-MM-DDThh:mm:ss format in UTC.	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

Success response

JSON format

{
  "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

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.