調用CreateModel介面建立模型-API Gateway-阿里雲

介面說明

模型定義參考JSON 架構草案 4的規範
Json Schema 只支援 Object 類型的元素屬性。

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

apigateway:CreateModel

create

*ApiGroup

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

無

請求參數

名稱	類型	必填	描述	樣本值
ModelName	string	是	模型的名稱，組內不許重複	Test
GroupId	string	是	模型所屬的分組編號	30e792398d6c4569b04c0e53a3494381
Schema	string	是	模型的 JSON Schema 定義	{"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	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	本次建立模型所屬的分組編號	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

樣本

正常返回樣本

JSON格式

{
  "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"
}

錯誤碼

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

變更歷史

更多資訊，參考變更詳情。