CreateModel - 创建模型

在API分组的模型管理中创建模型。

接口说明

  • 模型定义参考JSON架构草案4的规范
  • Json Schema只支持Object类型的元素属性。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
apigateway:CreateModelWrite
  • ApiGateway
    acs:apigateway:*:{#accountId}:*/*

请求参数

名称类型必填描述示例值
ModelNamestring

模型的名称,组内不许重复

Test
GroupIdstring

模型所属的分组编号

30e792398d6c4569b04c0e53a3494381
Schemastring

模型的JSON Schema定义

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

模型定义的描述

Model Description

返回参数

名称类型描述示例值
object
ModifiedTimestring

本次创建模型的最后修改时间

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

请求ID

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

本次创建模型的描述

Model Description
GroupIdstring

本次创建模型所属的分组编号

30e792398d6c4569b04c0e53a3494381
Schemastring

本次创建模型的模型定义

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

本次创建模型的名称

Test
CreatedTimestring

本次创建模型的创建时间

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

本次创建模型的ID

766c0b9538a04bdf974953b5576783ba
RegionIdstring

本次创建模型的所属区域

cn-qingdao
ModelRefstring

本次创建模型的URI

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

示例

请求示例

http(s)://apigateway.cn-qingdao.aliyuncs.com/?Action=CreateModel
&GroupId=30e792398d6c4569b04c0e53a3494381
&ModelName=Test
&Schema={"type":"object","properties":{"id":{"format":"int64","maximum":100,"exclusiveMaximum":true,"type":"integer"},"name":{"maxLength":10,"type":"string"}}}
&<公共请求参数>

正常返回示例

JSON格式

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

XML格式

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

错误码

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

阿里云首页 API 网关 相关技术圈