GetResourceType - Resource Orchestration Service - Alibaba Cloud Documentation Center

Queries the details of a resource type.

Operation description

This topic provides an example of how to query the details of the ALIYUN::ROS::WaitConditionHandle resource type.

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

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
ResourceType	string	Yes	The resource type. For more information about the resource types that ROS supports, see Resource type index.	ALIYUN::ROS::WaitConditionHandle
VersionId	string	No	The version ID. Specify this parameter to query a specific version of a resource type. If you do not specify this parameter, the details of the resource type are queried. Note Currently, only modules support versions.	v1

For more information about common request parameters, see Common parameters.

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	A28FBA2E-B6B3-5822-AA45-AB875EF23641
Attributes	object	The return values of the resource.	参见示例
ResourceType	string	The resource type.	ALIYUN::ROS::WaitConditionHandle
Properties	object	The properties of the resource.	参见示例
SupportDriftDetection	boolean	Indicates whether the resource supports drift detection. Valid values: true false	false
SupportScratchDetection	boolean	Indicates whether the resource supports resource scenarios. Valid values: true false	false
EntityType	string	The entity type. Valid values: Resource: a regular resource type. For more information, see Resources. DataSource: a data source resource type. For more information, see Data source resources. Module: a module. Valid values: Resource : Resource Module : Module DataSource : DataSource	Resource
Provider	string	The provider of the resource type. Valid values: ROS: Resource Orchestration Service. Self: the user. Valid values: ROS : ROS Self : Self	ROS
Description	string	The description of the resource type.	It is a demo.
DefaultVersionId	string	The default version ID. Note This parameter is returned only when you query a resource type.	v1
LatestVersionId	string	The latest version ID. Note This parameter is returned only when you query a resource type.	v10
CreateTime	string	The time when the resource type was created. The time is displayed in Coordinated Universal Time (UTC) and follows the ISO 8601 standard in the YYYY-MM-DDThh:mm:ss format.	2023-02-24T08:25:21
UpdateTime	string	The time when the resource type was last updated. The time is displayed in UTC and follows the ISO 8601 standard in the YYYY-MM-DDThh:mm:ss format.	2023-02-24T08:25:21
TotalVersionCount	integer	The total number of versions. Note This parameter is returned only when you query a resource type.	10
IsDefaultVersion	boolean	Indicates whether the version is the default version. Valid values: true false Note This parameter is returned only when you query a specific version of a resource type. Valid values: true : true false : false	true
TemplateBody	string	The template body of the module. Note This parameter is returned only when you query a specific version of a resource type.	{"ROSTemplateFormatVersion":"2015-09-01"}

Examples

Success response

JSON format

{
  "RequestId": "A28FBA2E-B6B3-5822-AA45-AB875EF23641",
  "Attributes": {
    "test": "test",
    "test2": 1
  },
  "ResourceType": "ALIYUN::ROS::WaitConditionHandle",
  "Properties": {
    "test": "test",
    "test2": 1
  },
  "SupportDriftDetection": false,
  "SupportScratchDetection": false,
  "EntityType": "Resource",
  "Provider": "ROS",
  "Description": "It is a demo.",
  "DefaultVersionId": "v1",
  "LatestVersionId": "v10",
  "CreateTime": "2023-02-24T08:25:21\n",
  "UpdateTime": "2023-02-24T08:25:21\n",
  "TotalVersionCount": 10,
  "IsDefaultVersion": true,
  "TemplateBody": "{\"ROSTemplateFormatVersion\":\"2015-09-01\"}"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.