调用CreateModel接口创建模型-API 网关-阿里云-API 网关(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"
}

错误码

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

变更历史

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