ListResourceTypes-阿里云帮助中心

Queries the list of supported resource types.

Operation description

This topic provides an example of how to query the list of regular resource types 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, see Resources. DataSource: data source resource types. For more information, see Data source resources. Module: modules. Valid values: All : All Resource : Resource Module : Module DataSource : DataSource	Resource
Provider	string	No	The resource type provider. Valid values: ROS (default): Resource Orchestration Service. Self: the user. Valid values: ROS : ROS Self : Self	ROS
ResourceType	string	No	The resource type. The value can contain uppercase and lowercase letters, digits, colons (:), and asterisks (*). If an asterisk is used, fuzzy match is performed.	MODULE::MyOrganization::MyService::MyUsecase

Response elements

Element	Type	Description	Example
	object
ResourceTypes	array	The resource type array.
	string	The resource type array.	["ALIYUN::ECS::Instance","ALIYUN::RDS::Instance"]
RequestId	string	The request ID.	EA00860C-ECAF-5253-A1F9-8198695A7157
ResourceTypeSummaries	array<object>	The resource type summary list.
	object
Provider	string	The resource type provider. Valid values: ROS: Resource Orchestration Service. Self: the user. Valid values: ROS : ROS Self : Self	ROS
EntityType	string	The entity type. Valid values: Resource: regular resource type. DataSource: data source resource type. Module: module. Valid values: Resource : Resource Module : Module DataSource : DataSource	Module
ResourceType	string	The resource type.	MODULE::MyOrganization::MyService::MyUsecase
DefaultVersionId	string	The default version ID.	v1
LatestVersionId	string	The latest version ID.	v10
CreateTime	string	The creation time. The time is displayed in UTC+0 based on the ISO 8601 standard but without the Z suffix. Format: YYYY-MM-DDThh:mm:ss.	2023-02-24T08:25:21
UpdateTime	string	The update time. The time is displayed in UTC+0 based on the ISO 8601 standard but without the Z suffix. Format: YYYY-MM-DDThh:mm:ss.	2023-02-24T08:25:21
Description	string	The resource type description.	It is a demo.
TotalVersionCount	integer	The total number of versions.	10

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.