调用CreateModel创建描述API请求的数据模型并返回数据的模型。

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String CreateModel

操作接口名,系统规定参数,取值:CreateModel

GroupId String 30e792398d6c4569b04c0e53a3494381

模型所属的分组编号

ModelName String Test

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

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

模型的JSON Schema定义

Description String Model Description

模型定义的描述

返回数据

名称 类型 示例值 描述
CreatedTime String 2019-01-29T09:33:01Z

本次创建模型的创建时间

Description String Model Description

本次创建模型的描述

GroupId String 30e792398d6c4569b04c0e53a3494381

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

ModelId String 766c0b9538a04bdf974953b5576783ba

本次创建模型的ID

ModelName String Test

本次创建模型的名称

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

本次创建模型的URI

ModifiedTime String 2019-01-29T09:33:01Z

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

RegionId String cn-qingdao

本次创建模型的所属区域

RequestId String 4173F95B-360C-460C-9F6C-4A960B904411

请求ID

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

本次创建模型的模型定义

示例

请求示例

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"}}}
&<公共请求参数>

正常返回示例

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>

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

错误码

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