All Products
Search
Document Center

Resource Orchestration Service:ListResourceTypes

Last Updated:Feb 22, 2024

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.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
EntityTypestringNo

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
ProviderstringNo

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
ResourceTypestringNo

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

ParameterTypeDescriptionExample
object
ResourceTypesarray

The array of resource types.

string
["ALIYUN::ECS::Instance","ALIYUN::RDS::Instance"]
RequestIdstring

The ID of the request.

EA00860C-ECAF-5253-A1F9-8198695A7157
ResourceTypeSummariesobject []

The resource type summaries.

Providerstring

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
EntityTypestring

The entity type. Valid values:

  • Resource: regular resources.
  • DataSource: DataSource resources.
  • Module: modules.
Module
ResourceTypestring

The resource type.

MODULE::MyOrganization::MyService::MyUsecase
DefaultVersionIdstring

The ID of the default version.

v1
LatestVersionIdstring

The ID of the latest version.

v10
CreateTimestring

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
UpdateTimestring

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
Descriptionstring

The description of the resource type.

It is a demo.
TotalVersionCountinteger

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 timeSummary of changesOperation
2023-05-10The request parameters of the API has changed. The response structure of the API has changedsee changesets
Change itemChange content
Input ParametersThe request parameters of the API has changed.
    Added Input Parameters: Provider
    Added Input Parameters: ResourceType
Output ParametersThe response structure of the API has changed.
2022-01-18The request parameters of the API has changedsee changesets
Change itemChange content
Input ParametersThe request parameters of the API has changed.
    Added Input Parameters: EntityType