获取API分组已创建的模型。
接口说明
- 模型查询支持模糊查询
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| apigateway:DescribeModels | get | *ApiGroup acs:apigateway:{#regionId}:{#accountId}:apigroup/{#GroupId} |
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| GroupId | string | 是 | 指定的分组编号 | 30e792398d6c4569b04c0e53a3494381 |
| ModelName | string | 否 | 模型的名称 | Test |
| PageSize | integer | 否 | 指定分页查询时每页行数，最大值 100，默认值为 10 | 10 |
| PageNumber | integer | 否 | 指定要查询的页码，默认是 1，起始是 1 | 1 |
| ModelId | string | 否 | 模型 ID | 123 |
| Tag | array<object> | 否 | 指定规则所适用的对象标签，可设置多个。 | |
| object | 否 | |||
| Key | string | 否 | 标签的 key | key |
| Value | string | 否 | 标签的值。 | value |
返回参数
示例
正常返回示例
JSON格式
{
"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"
}
]
}
}
]
}
}错误码
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|---|---|
| 2024-11-14 | OpenAPI 描述信息更新 | 查看变更详情 |
| 2023-12-07 | OpenAPI 入参发生变更、OpenAPI 返回结构发生变更 | 查看变更详情 |