DescribeModels - API Gateway - Alibaba Cloud Documentation Center

Queries the created models of an API group.

Operation description

Fuzzy queries are supported.

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:DescribeModels

get

*ApiGroup

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

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 elements

Element	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	object
ModelDetail	array<object>	The returned information about models. It is an array consisting of ModelDetail data.
	array<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	object
TagInfo	array<object>	The tags of the model.
	object
Key	string	The tag key.	ENV
Value	string	The tag value.	ST4

Examples

Success response

JSON format

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

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.