CreateModel - API Gateway - Alibaba Cloud Documentation Center

Creates a model for an API group.

Operation description

For more information about the model definition, see JSON Schema Draft 4.
JSON Schema supports only element attributes of the Object type.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
ModelName	string	Yes	The name of the model. The name must be unique within the group.	Test
GroupId	string	Yes	The ID of the API group to which the model belongs.	30e792398d6c4569b04c0e53a3494381
Schema	string	Yes	The definition of the model in JSON Schema.	{"type":"object","properties":{"id":{"format":"int64","maximum":100,"exclusiveMaximum":true,"type":"integer"},"name":{"maxLength":10,"type":"string"}}}
Description	string	No	The description of the model definition.	Model Description
Tag	array<object>	No	The object tags that match the lifecycle rule. You can specify multiple tags.
	object	No
Key	string	No	The key of the tag.	key
Value	string	No	The values of the tag.	123

Response parameters

Parameter	Type	Description	Example
	object
ModifiedTime	string	The time when the model is last modified.	2019-01-29T09:33:01Z
RequestId	string	The ID of the request.	4173F95B-360C-460C-9F6C-4A960B904411
Description	string	The description of the created model.	Model Description
GroupId	string	The ID of the API group to which the created model belongs.	30e792398d6c4569b04c0e53a3494381
Schema	string	The definition of the created model.	{\"type\":\"object\",\"properties\":{\"id\":{\"format\":\"int64\",\"maximum\":100,\"exclusiveMaximum\":true,\"type\":\"integer\"},\"name\":{\"maxLength\":10,\"type\":\"string\"}}}
ModelName	string	The name of the created model.	Test
CreatedTime	string	The time when the model was created.	2019-01-29T09:33:01Z
ModelId	string	The ID of the created model.	766c0b9538a04bdf974953b5576783ba
RegionId	string	The region to which the created model belongs.	cn-qingdao
ModelRef	string	The URI of the created model.	https://apigateway.aliyun.com/models/30e792398d6c4569b04c0e53a3494381/766c0b9538a04bdf974953b5576783ba

Examples

Sample success responses

JSONformat

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

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2023-12-07	The request parameters of the API has changed	View Change Details