全部產品
Search
文件中心

Resource Orchestration Service:RegisterResourceType - 註冊資源類型

更新時間:Jun 04, 2026

建立新的資源類型,或為已有資源類型增加一個新版本。

介面說明

  • 版本從 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****"
}

錯誤碼

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊,參考變更詳情