All Products
Search

This Product

    API Gateway:CreateModel

    Document Center

    API Gateway:CreateModel

    Last Updated:Apr 01, 2024

    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

    OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

    Authorization information

    The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

    • Operation: the value that you can use in the Action element to specify the operation on a resource.
    • Access level: the access level of each operation. The levels are read, write, and list.
    • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
      • The required resource types are displayed in bold characters.
      • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
    • Condition Key: the condition key that is defined by the cloud service.
    • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
    OperationAccess levelResource typeCondition keyAssociated operation
    apigateway:CreateModelWrite
    • All Resources
      *
      none
    		none

    Request parameters

    ParameterTypeRequiredDescriptionExample
    ModelNamestringYes

    The name of the model. The name must be unique within the group.

    		Test
    GroupIdstringYes

    The ID of the API group to which the model belongs.

    		30e792398d6c4569b04c0e53a3494381
    SchemastringYes

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

    The description of the model definition.

    		Model Description
    Tagobject []No

    The object tags that match the lifecycle rule. You can specify multiple tags.

    KeystringNo

    The key of the tag.

    		key
    ValuestringNo

    The values of the tag.

    		123

    Response parameters

    ParameterTypeDescriptionExample
    object
    ModifiedTimestring

    The time when the model is last modified.

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

    The ID of the request.

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

    The description of the created model.

    		Model Description
    GroupIdstring

    The ID of the API group to which the created model belongs.

    		30e792398d6c4569b04c0e53a3494381
    Schemastring

    The definition of the created model.

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

    The name of the created model.

    		Test
    CreatedTimestring

    The time when the model was created.

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

    The ID of the created model.

    		766c0b9538a04bdf974953b5576783ba
    RegionIdstring

    The region to which the created model belongs.

    		cn-qingdao
    ModelRefstring

    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 timeSummary of changesOperation
    2023-12-07The request parameters of the API has changedsee changesets
    Change itemChange content
    Input ParametersThe request parameters of the API has changed.
      Added Input Parameters: Tag