获取已创建的模型 - API 网关

描述

通过调用DescribeModels接口, 可以查看用户某个分组下的所有模型定义：

模型查询支持模糊查询

请求参数

名称	类型	是否必须	描述
Action	String	是	操作接口名，系统规定参数，取值：DescribeModels
GroupId	String	是	指定的分组编号
ModelName	String	否	模型的名称
PageSize	Integer	否	指定分页查询时每页行数，最大值100，默认值为10
pageNumber	Integer	否	指定要查询的页码，默认是1，起始是1

返回参数

名称	类型	描述
RequestId	String	本次请求编号
TotalCount	String	返回结果的总条数
PageSize	String	返回指定的每页条数
PageNumber	String	返回指定的页码
ModelDetails	String	由ModelDetails组成的数组格式，返回模型的详细信息

示例

请求示例

https://apigateway.cn-qingdao.aliyuncs.com/?Action=DescribeModels
&GroupId=30e792398d6c4569b04c0e53a3494381
&ModelName=Test

返回示例XML格式

<DescribeModelsResponse>
  <PageNumber>1</PageNumber>
      <TotalCount>1</TotalCount>
      <PageSize>10</PageSize>
      <RequestId>40306469-2FB5-417A-B723-AF1F4A4FA204</RequestId>
      <ModelDetails>
          <ModelDetail>
              <Description>Model Description</Description>
              <ModelId>766c0b9538a04bdf974953b5576783ba</ModelId>
              <CreatedTime>2019-01-29T11:07:48Z</CreatedTime>
              <ModelName>Test</ModelName>
              <Schema>{&quot;type&quot;:&quot;object&quot;,&quot;properties&quot;:{&quot;id&quot;:{&quot;format&quot;:&quot;int64&quot;,&quot;maximum&quot;:100,&quot;exclusiveMaximum&quot;:true,&quot;type&quot;:&quot;integer&quot;},&quot;name&quot;:{&quot;maxLength&quot;:10,&quot;type&quot;:&quot;string&quot;}}}</Schema>
              <ModelRef>https://apigateway.aliyun.com/models/30e792398d6c4569b04c0e53a3494381/766c0b9538a04bdf974953b5576783ba</ModelRef>
              <ModifiedTime>2019-01-29T11:07:48Z</ModifiedTime>
              <GroupId>30e792398d6c4569b04c0e53a3494381</GroupId>
          </ModelDetail>
      </ModelDetails>
</DescribeModelsResponse>

JSON格式

{
  "PageNumber": 1,
  "TotalCount": 1,
  "PageSize": 10,
  "RequestId": "40306469-2FB5-417A-B723-AF1F4A4FA204",
  "ModelDetails": {
    "ModelDetail": [
      {
        "Description": "Model Description",
        "ModelId": "766c0b9538a04bdf974953b5576783ba",
        "CreatedTime": "2019-01-29T11:07:48Z",
        "ModelName": "Test",
        "Schema": "{\"type\":\"object\",\"properties\":{\"id\":{\"format\":\"int64\",\"maximum\":100,\"exclusiveMaximum\":true,\"type\":\"integer\"},\"name\":{\"maxLength\":10,\"type\":\"string\"}}}",
        "ModelRef": "https://apigateway.aliyun.com/models/30e792398d6c4569b04c0e53a3494381/766c0b9538a04bdf974953b5576783ba",
        "ModifiedTime": "2019-01-29T11:07:48Z",
        "GroupId": "30e792398d6c4569b04c0e53a3494381"
      }
    ]
  }
}