RegisterResourceType - Resource Orchestration Service - Alibaba Cloud Documentation Center

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.

Debugging

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

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
EntityType	string	Yes	The entity type. Set the value to 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 parameters

Parameter	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

Sample success responses

JSONformat

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

Error codes

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

Change history

Change time	Summary of changes	Operation

No change history