文档

DescribeModels - 获取已创建的模型

更新时间:

获取API分组已创建的模型。

接口说明

  • 模型查询支持模糊查询

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
apigateway:DescribeModelsRead
  • ApiGroup
    acs:apigateway:{#regionId}:{#accountId}:apigroup/{#GroupId}

请求参数

名称类型必填描述示例值
GroupIdstring

指定的分组编号

30e792398d6c4569b04c0e53a3494381
ModelNamestring

模型的名称

Test
PageSizeinteger

指定分页查询时每页行数,最大值 100,默认值为 10

10
PageNumberinteger

指定要查询的页码,默认是 1,起始是 1

1
ModelIdstring

模型 ID

123
Tagobject []

指定规则所适用的对象标签,可设置多个。

Keystring

标签的 key

key
Valuestring

标签的值。

value

返回参数

名称类型描述示例值
object
PageNumberinteger

返回指定的页码

1
RequestIdstring

请求 ID

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

返回指定的每页条数

10
TotalCountinteger

返回结果的总条数

1
ModelDetailsobject []

由 ModelDetail 组成的数组格式,返回模型的详细信息

ModifiedTimestring

模型的最后修改时间

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

模型所属的分组编号

30e792398d6c4569b04c0e53a3494381
Descriptionstring

模型的定义说明

Model Description
Schemastring

模型的定义

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

模型的名称

Test
CreatedTimestring

模型的创建时间

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

模型的编号

766c0b9538a04bdf974953b5576783ba
ModelRefstring

模型的 URI

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

标签。

Keystring

标签键。

ENV
Valuestring

标签值

ST4

示例

正常返回示例

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

错误码

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2023-12-07OpenAPI 入参发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
入参OpenAPI 入参发生变更
    新增入参:Tag
出参OpenAPI 返回结构发生变更
  • 本页导读 (0)
文档反馈