All Products
Search
Document Center

API Gateway:DescribeModels

Last Updated:Mar 01, 2024

Queries the created models of an API group.

Operation description

  • Fuzzy queries are supported.

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:DescribeModelsRead
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
GroupIdstringYes

The ID of the API group.

30e792398d6c4569b04c0e53a3494381
ModelNamestringNo

The name of the model.

Test
PageSizeintegerNo

The number of entries to return on each page. Maximum value: 100. Default value: 10.

10
PageNumberintegerNo

The number of the page to return. Pages start from page 1. Default value: 1.

1
ModelIdstringNo

The ID of the model.

123

Response parameters

ParameterTypeDescriptionExample
object
PageNumberinteger

The page number of the returned page.

1
RequestIdstring

The ID of the request.

40306469-2FB5-417A-B723-AF1F4A4FA204
PageSizeinteger

The number of entries returned per page.

10
TotalCountinteger

The total number of returned entries.

1
ModelDetailsobject []

The returned information about models. It is an array consisting of ModelDetail data.

ModifiedTimestring

The last modification time of the model.

2019-01-29T11:07:48Z
GroupIdstring

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

30e792398d6c4569b04c0e53a3494381
Descriptionstring

The definition of the model description.

Model Description
Schemastring

The definition of the model.

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

The name of the model.

Test
CreatedTimestring

The time when the model was created.

2019-01-29T11:07:48Z
ModelIdstring

The ID of the model.

766c0b9538a04bdf974953b5576783ba
ModelRefstring

The URI of the model.

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

Examples

Sample success responses

JSONformat

{
  "PageNumber": 1,
  "RequestId": "40306469-2FB5-417A-B723-AF1F4A4FA204",
  "PageSize": 10,
  "TotalCount": 1,
  "ModelDetails": {
    "ModelDetail": [
      {
        "ModifiedTime": "2019-01-29T11:07:48Z",
        "GroupId": "30e792398d6c4569b04c0e53a3494381",
        "Description": "Model Description",
        "Schema": "{\\\"type\\\":\\\"object\\\",\\\"properties\\\":{\\\"id\\\":{\\\"format\\\":\\\"int64\\\",\\\"maximum\\\":100,\\\"exclusiveMaximum\\\":true,\\\"type\\\":\\\"integer\\\"},\\\"name\\\":{\\\"maxLength\\\":10,\\\"type\\\":\\\"string\\\"}}}",
        "ModelName": "Test",
        "CreatedTime": "2019-01-29T11:07:48Z",
        "ModelId": "766c0b9538a04bdf974953b5576783ba",
        "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 changed. The response structure of the API has changedsee changesets
Change itemChange content
Input ParametersThe request parameters of the API has changed.
    Added Input Parameters: Tag
Output ParametersThe response structure of the API has changed.