DescribeModels - API Gateway - Alibaba Cloud Documentation Center

Queries the created models of an API group.

Operation description

Fuzzy queries are supported.

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

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:
- For mandatory resource types, indicate with a prefix of * .
- 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.

Operation	Access level	Resource type	Condition key	Associated operation
apigateway:DescribeModels	get	*ApiGroup `acs:apigateway:{#regionId}:{#accountId}:apigroup/{#GroupId}`	none	none

Request parameters

Parameter	Type	Required	Description	Example
GroupId	string	Yes	The ID of the API group.	30e792398d6c4569b04c0e53a3494381
ModelName	string	No	The name of the model.	Test
PageSize	integer	No	The number of entries to return on each page. Maximum value: 100. Default value: 10.	10
PageNumber	integer	No	The number of the page to return. Pages start from page 1. Default value: 1.	1
ModelId	string	No	The ID of the model.	123
Tag	array<object>	No	The tag of objects that match the rule. You can specify multiple tags.
	object	No
Key	string	No	The tag key.	key
Value	string	No	The tag value.	value

Response parameters

Parameter	Type	Description	Example
	object
PageNumber	integer	The page number of the page to return.	1
RequestId	string	The request ID.	40306469-2FB5-417A-B723-AF1F4A4FA204
PageSize	integer	The number of entries per page.	10
TotalCount	integer	The total number of returned entries.	1
ModelDetails	array<object>	The returned information about models. It is an array consisting of ModelDetail data.
ModelDetail	object
ModifiedTime	string	The time when the model was last modified.	2019-01-29T11:07:48Z
GroupId	string	The ID of the API group to which the model belongs.	30e792398d6c4569b04c0e53a3494381
Description	string	The description of the model definition.	Model Description
Schema	string	The definition of the model.	{\"type\":\"object\",\"properties\":{\"id\":{\"format\":\"int64\",\"maximum\":100,\"exclusiveMaximum\":true,\"type\":\"integer\"},\"name\":{\"maxLength\":10,\"type\":\"string\"}}}
ModelName	string	The name of the model.	Test
CreatedTime	string	The time when the model was created.	2019-01-29T11:07:48Z
ModelId	string	The ID of the model.	766c0b9538a04bdf974953b5576783ba
ModelRef	string	The URI of the model.	https://apigateway.aliyun.com/models/30e792398d6c4569b04c0e53a3494381/766c0b9538a04bdf974953b5576783ba
Tags	array<object>	The tags of the model.
TagInfo	object
Key	string	The tag key.	ENV
Value	string	The tag value.	ST4

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",
        "Tags": {
          "TagInfo": [
            {
              "Key": "ENV",
              "Value": "ST4"
            }
          ]
        }
      }
    ]
  }
}

Error codes

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

Change history

Change time	Summary of changes	Operation
2024-11-14	API Description Update	View Change Details
2023-12-07	The request parameters of the API has changed. The response structure of the API has changed	View Change Details