All Products
Search
Document Center

Resource Orchestration Service:GetResourceType

Last Updated:Sep 12, 2024

This topic provides an example on how to query the details of \`ALIYUN::ROS::WaitConditionHandle\`.

Operation description

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

Debugging

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

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.
OperationAccess levelResource typeCondition keyAssociated operation
ros:GetResourceTypeget
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
ResourceTypestringYes

The ID of the request.

ALIYUN::ROS::WaitConditionHandle
VersionIdstringNo

The version ID. If you want to query a specific version of the resource type, you must specify this parameter. If you do not specify this parameter, only the resource type is queried.

Note This parameter is supported only for modules.
v1
HttpCodeError codesError messageDescription
404ResourceTypeNotFoundThe Resource Type ({name}) could not be found.The error message returned because the specified resource type does not exist. name indicates the name of the resource type.

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The attributes of the resource.

A28FBA2E-B6B3-5822-AA45-AB875EF23641
Attributesobject

The type of the resource.

ResourceTypestring

The properties of the resource.

ALIYUN::ROS::WaitConditionHandle
Propertiesobject

Indicates whether the resource supports drift detection. Default value: false. Valid values:

  • true: Drift detection is supported.
  • false: Drift detection is not supported.
SupportDriftDetectionboolean

Indicates whether the resource supports scratch detection. Default value: false. Valid values:

  • true: Scratch detection is supported.
  • false: Scratch detection is not supported.
false
SupportScratchDetectionboolean

The entity type. Valid values:

  • Resource: resources other than DataSource resources. For more information, see Resources .
  • DataSource: DataSource resources.
false
EntityTypestring

The entity type. Valid values:

  • Resource: regular resource. For more information, see Resources .
  • DataSource: DataSource resource. For more information, see DataSource resources.
  • module: module.
Enumeration Value:
  • Resource: Resource.
  • Module: Module.
  • DataSource: DataSource.
Resource
Providerstring

The provider of the resource type. Valid values:

  • ROS: The resource type is provided by Resource Orchestration Service (ROS).
  • Self: The resource type is provided by you.
ROS
Descriptionstring

The description of the resource type.

It is a demo.
DefaultVersionIdstring

The default version ID.

Note This parameter is returned only if the resource type is queried.
v1
LatestVersionIdstring

The latest version ID.

Note This parameter is returned only if the resource type is queried.
v10
CreateTimestring

The creation time. The time follows the ISO 8601 standard in the YYYY-MM-DDThh:mm:ss format. The time is displayed in UTC.

2023-02-24T08:25:21
UpdateTimestring

The update time. The time follows the ISO 8601 standard in the YYYY-MM-DDThh:mm:ss format. The time is displayed in UTC.

2023-02-24T08:25:21
TotalVersionCountinteger

The total number of versions.

Note This parameter is returned only if the resource type is queried.
10
IsDefaultVersionboolean

Indicates whether the version is the default version. Valid values:

  • true
  • false
Note This parameter is returned only if a specific version of the resource type is queried.
true
TemplateBodystring

The template content in the module.

Note This parameter is returned only if a specific version of the resource type is queried.
{"ROSTemplateFormatVersion":"2015-09-01"}

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

Examples

Sample success responses

JSONformat

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

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

Change history

Change timeSummary of changesOperation
2023-05-10The request parameters of the API has changed. The response structure of the API has changedView Change Details
2022-01-18The response structure of the API has changedView Change Details