すべてのプロダクト
Search

このプロダクト

    :CreateModel

    ドキュメントセンター

    :CreateModel

    最終更新日:Dec 24, 2025

    API グループのモデルを作成します。

    操作説明

    • モデル定義の詳細については、JSON Schema Draft 4 をご参照ください。

    • JSON スキーマは、オブジェクトタイプの要素属性のみをサポートします。

    今すぐお試しください

    この 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 ロールに付与する必要があります。

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    apigateway:CreateModel

    create

    *ApiGroup

    acs:apigateway:{#regionId}:{#accountId}:apigroup/{#GroupId}

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    ModelName

    string

    必須

    モデルの名前。名前はグループ内で一意である必要があります。

    Test
    GroupId

    string

    必須

    モデルが属する API グループの ID。

    30e792398d6c4569b04c0e53a3494381
    Schema

    string

    必須

    JSON スキーマでのモデルの定義。

    {"type":"object","properties":{"id":{"format":"int64","maximum":100,"exclusiveMaximum":true,"type":"integer"},"name":{"maxLength":10,"type":"string"}}}
    Description

    string

    任意

    モデル定義の説明。

    Model Description
    Tag

    array<object>

    任意

    ライフサイクルルールに一致するオブジェクトタグ。複数のタグを指定できます。

    object

    任意

    Key

    string

    任意

    タグのキー。

    key
    Value

    string

    任意

    タグの値。

    123

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    ModifiedTime

    string

    モデルの最終更新日時。

    2019-01-29T09:33:01Z
    RequestId

    string

    リクエストの ID。

    4173F95B-360C-460C-9F6C-4A960B904411
    Description

    string

    作成されたモデルの説明。

    Model Description
    GroupId

    string

    作成されたモデルが属する API グループの ID。

    30e792398d6c4569b04c0e53a3494381
    Schema

    string

    作成されたモデルの定義。

    {\"type\":\"object\",\"properties\":{\"id\":{\"format\":\"int64\",\"maximum\":100,\"exclusiveMaximum\":true,\"type\":\"integer\"},\"name\":{\"maxLength\":10,\"type\":\"string\"}}}
    ModelName

    string

    作成されたモデルの名前。

    Test
    CreatedTime

    string

    モデルの作成日時。

    2019-01-29T09:33:01Z
    ModelId

    string

    作成されたモデルの ID。

    766c0b9538a04bdf974953b5576783ba
    RegionId

    string

    作成されたモデルが属するリージョン。

    cn-qingdao
    ModelRef

    string

    作成されたモデルの URI。

    https://apigateway.aliyun.com/models/30e792398d6c4569b04c0e53a3494381/766c0b9538a04bdf974953b5576783ba

    例

    成功レスポンス

    JSONJSON

    {
  "ModifiedTime": "2019-01-29T09:33:01Z",
  "RequestId": "4173F95B-360C-460C-9F6C-4A960B904411",
  "Description": "Model Description",
  "GroupId": "30e792398d6c4569b04c0e53a3494381",
  "Schema": "{\\\"type\\\":\\\"object\\\",\\\"properties\\\":{\\\"id\\\":{\\\"format\\\":\\\"int64\\\",\\\"maximum\\\":100,\\\"exclusiveMaximum\\\":true,\\\"type\\\":\\\"integer\\\"},\\\"name\\\":{\\\"maxLength\\\":10,\\\"type\\\":\\\"string\\\"}}}",
  "ModelName": "Test",
  "CreatedTime": "2019-01-29T09:33:01Z",
  "ModelId": "766c0b9538a04bdf974953b5576783ba",
  "RegionId": "cn-qingdao",
  "ModelRef": "https://apigateway.aliyun.com/models/30e792398d6c4569b04c0e53a3494381/766c0b9538a04bdf974953b5576783ba"
}

    エラーコード

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

    変更履歴

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