All Products
Search

This Product

    Resource Orchestration Service:RegisterResourceType

    Document Center

    Resource Orchestration Service:RegisterResourceType

    Last Updated:Jun 03, 2026

    Creates a new resource type, or creates a new version for an existing resource type.

    Operation description

    • Versions increase from v1.

    • If you create a new resource type, v1 is used as the default version of the resource type. You can call the SetResourceType operation to change the default version of a 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:RegisterResourceType

    create

    *All Resource

    *

    		 None None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    EntityType

    string

    Yes

    The entity type. Set the value to Module.

    Valid values:

    • Module :

      Module

    Module
    ResourceType

    string

    Yes

    The resource type.

    MODULE::MyOrganization::MyService::MyUsecase
    TemplateBody

    string

    No

    The structure that contains the template body. The template body must be 1 to 524,288 bytes in length. The template body is used as the module content. If the length of the template body exceeds the upper limit, we recommend that you add parameters to the HTTP POST request body to prevent request failures caused by excessively long URLs.

    Note

    • This parameter takes effect only when EntityType is set to Module.

    • You can specify only one of the TemplateBody and TemplateURL parameters.

    {"ROSTemplateFormatVersion":"2015-09-01"}
    TemplateURL

    string

    No

    The URL of the file that contains the template body. The URL must point to a template that is located on an HTTP or HTTPS web server or in an Object Storage Service (OSS) bucket, such as oss://ros/template/demo or oss://ros/template/demo?RegionId=cn-hangzhou. The template body can be up to 524,288 bytes in length. The template body is used as the module content.

    Note

    • If you do not specify the region ID of the OSS bucket, the value of RegionId is used.

    • This parameter takes effect only when EntityType is set to Module.

    • You can specify only one of the TemplateBody and TemplateURL parameters.

    The URL can be up to 1,024 bytes in length.

    oss://ros-template/demo
    Description

    string

    No

    The description of the resource type. The description can be up to 512 characters in length.

    It is a demo.
    ClientToken

    string

    No

    The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests.
    The token can be up to 64 characters in length, and can contain letters, digits, hyphens (-), and underscores (_).
    For more information, see Ensure idempotence.

    123e4567-e89b-12d3-a456-42665544****

    Response elements

    Element

    Type

    Description

    Example

    object

    RequestId

    string

    The request ID.

    B288A0BE-D927-4888-B0F7-B35EF84B6E6F
    RegistrationId

    string

    The ID of the registration record. You can call the ListResourceTypeRegistrations operation to query registration records.

    4a6c9851-3b0f-4f5f-b4ca-a14bf691****

    Examples

    Success response

    JSON format

    {
  "RequestId": "B288A0BE-D927-4888-B0F7-B35EF84B6E6F",
  "RegistrationId": "4a6c9851-3b0f-4f5f-b4ca-a14bf691****"
}

    Error codes

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.