全部产品
云市场

创建模型

更新时间:2019-02-12 15:09:05

描述

通过调用CreateModel接口, 可以创建描述API请求的数据模型或者返回数据的模型:

请求参数

名称 类型 是否必须 描述
Action String 操作接口名,系统规定参数,取值:CreateModel
GroupId String 模型所属的分组编号
ModelName String 模型的名称, 组内不许重复
Schema String 模型的JSON Schema定义
Description String 模型定义的描述

返回参数

名称 类型 描述
RequestId String 本次请求编号
ModelId String 本次创建模型的ID
ModelRef String 本次创建模型的URI
ModelName String 本次创建模型的名称
GroupId String 本次创建模型所属的分组编号
Schema String 本次创建模型的模型定义
RegionId String 本次创建模型的所属区域
Description String 本次创建模型的描述
CreatedTime String 本次创建模型的创建时间
ModifiedTime String 本次创建模型的最后修改时间

示例

请求示例

  1. https://apigateway.cn-qingdao.aliyuncs.com/?Action=CreateModel
  2. &GroupId=30e792398d6c4569b04c0e53a3494381
  3. &ModelName=Test
  4. &Schema={"type":"object","properties":{"id":{"format":"int64","maximum":100,"exclusiveMaximum":true,"type":"integer"},"name":{"maxLength":10,"type":"string"}}}
  5. &Description=Model Description
  6. &<公共请求参数>

返回示例XML格式

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

JSON格式

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