Create an API Group Model via CreateModel - API Gateway

Operation description

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

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

apigateway:CreateModel

create

*ApiGroup

acs:apigateway:{#regionId}:{#accountId}:apigroup/{#GroupId}

None

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 elements

Element	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

Success response

JSON format

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

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.