使用RegisterResourceType注册资源类型-资源编排-阿里云-资源编排(ROS)-阿里云帮助中心

接口说明

版本从 v1 开始递增。
创建新的资源类型，v1 版本会被设置为默认版本。可以通过 SetResourceType 修改默认版本。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

ros:RegisterResourceType

create

*全部资源

*

无

请求参数

名称	类型	必填	描述	示例值
EntityType	string	是	实体类型。取值：Module，模块。枚举值： Module : Module	Module
ResourceType	string	是	资源类型。	MODULE::MyOrganization::MyService::MyUsecase
TemplateBody	string	否	模板主体的结构。长度为 1~524,288 个字节。模板即为模块内容。如果长度较大，建议通过 HTTP POST+Body Param 的方式，将参数放在请求体中进行传递，避免 URL 过长而导致请求失败。说明仅在 EntityType 为 Module 时生效。您仅能指定 TemplateBody、TemplateURL 其中一个参数。	{"ROSTemplateFormatVersion":"2015-09-01"}
TemplateURL	string	否	包含模板主体的文件的位置。URL 必须指向位于 Web 服务器（HTTP 或 HTTPS）或阿里云 OSS 存储空间（例如：oss://ros/template/demo、oss://ros/template/demo?RegionId=cn-hangzhou）中的模板，模板最大为 524,288 个字节。模板即为模块内容。说明如果 OSS 地域未指定，默认与接口参数 RegionId 相同。仅在 EntityType 为 Module 时生效。您仅能指定 TemplateBody、TemplateURL 其中一个参数。 URL 的最大长度为：1024 个字节。	oss://ros-template/demo
Description	string	否	资源类型的描述。最大长度为 512 个字符。	It is a demo.
ClientToken	string	否	保证请求的幂等性。该值由客户端生成，并且必须是全局唯一的。长度最大为 64 个字符，可包含英文字符、数字、短划线（-）和下划线（_）。更多详情，请参见如何保证幂等性。	123e4567-e89b-12d3-a456-42665544****

返回参数

名称	类型	描述	示例值
	object
RequestId	string	请求 ID。	B288A0BE-D927-4888-B0F7-B35EF84B6E6F
RegistrationId	string	注册 ID。可使用 ListResourceTypeRegistrations 接口查询注册结果。	4a6c9851-3b0f-4f5f-b4ca-a14bf691****

示例

正常返回示例

JSON格式

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

错误码

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。