すべてのプロダクト
Search

このプロダクト

    :RegisterResourceType

    ドキュメントセンター

    :RegisterResourceType

    最終更新日:Jun 03, 2026

    新しいリソースタイプを作成するか、既存のリソースタイプの新しいバージョンを作成します。

    操作説明

    • バージョンは v1 から始まります。

    • 新しいリソースタイプを作成する場合、v1 がリソースタイプのデフォルトバージョンとして使用されます。SetResourceType API を呼び出して、リソースタイプのデフォルトバージョンを変更できます。

    今すぐお試しください

    この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

    テスト

    RAM 認証

    下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

    • アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。

    • API：アクションを具体的に実行するための API。

    • アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。

    • リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。

      • リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。

      • リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。

    • 条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。

    • 依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    ros:RegisterResourceType

    create

    *All Resource

    *

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    EntityType

    string

    必須

    エンティティタイプです。値を Module に設定します。

    列挙値:

    • Module :

      モジュール

    Module
    ResourceType

    string

    必須

    リソースタイプです。

    MODULE::MyOrganization::MyService::MyUsecase
    TemplateBody

    string

    任意

    テンプレート本文を含む構造です。テンプレート本文の長さは、1～524,288 バイトである必要があります。テンプレート本文はモジュールコンテンツとして使用されます。テンプレート本文の長さが上限を超える場合は、長すぎる URL によるリクエストの失敗を防ぐため、HTTP POST リクエストの本文にパラメーターを追加することを推奨します。

    説明

    • このパラメーターは、EntityType が Module に設定されている場合にのみ有効です。

    • TemplateBody と TemplateURL のいずれか一方のみを指定できます。

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

    string

    任意

    テンプレート本文を含むファイルの URL。URL は、HTTP または HTTPS の Web サーバー上、または Object Storage Service (OSS) バケット内にあるテンプレートを指す必要があります (例: oss://ros/template/demo または oss://ros/template/demo?RegionId=cn-hangzhou)。テンプレート本文の長さは最大 524,288 バイトです。テンプレート本文はモジュールコンテンツとして使用されます。

    説明

    • OSS バケットのリージョン ID を指定しない場合、RegionId の値が使用されます。

    • このパラメーターは、EntityType が Module に設定されている場合にのみ有効です。

    • TemplateBody と TemplateURL のいずれか一方のみを指定できます。

    URL の長さは最大 1,024 バイトです。

    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 API を呼び出して、登録レコードを照会できます。

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

    例

    成功レスポンス

    JSONJSON

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

    エラーコード

    完全なリストについては、「エラーコード」をご参照ください。

    変更履歴

    完全なリストについては、「変更履歴」をご参照ください。