调用DescribeModels查询用户某个分组下的所有模型定义。

  • 模型查询支持模糊查询

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String DescribeModels

操作接口名,系统规定参数,取值:DescribeModels

GroupId String 30e792398d6c4569b04c0e53a3494381

指定的分组编号

ModelName String Test

模型的名称

PageSize Integer 10

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

PageNumber Integer 1

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

ModelId String 123

模型ID

返回数据

名称 类型 示例值 描述
ModelDetails Array of ModelDetail

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

ModelDetail
CreatedTime String 2019-01-29T11:07:48Z

模型的创建时间

Description String Model Description

模型的定义说明

GroupId String 30e792398d6c4569b04c0e53a3494381

模型所属的分组编号

ModelId String 766c0b9538a04bdf974953b5576783ba

模型的编号

ModelName String Test

模型的名称

ModelRef String https://apigateway.aliyun.com/models/30e792398d6c4569b04c0e53a3494381/766c0b9538a04bdf974953b5576783ba

模型的URI

ModifiedTime String 2019-01-29T11:07:48Z

模型的最后修改时间

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

模型的定义

PageNumber Integer 1

返回指定的页码

PageSize Integer 10

返回指定的每页条数

RequestId String 40306469-2FB5-417A-B723-AF1F4A4FA204

请求ID

TotalCount Integer 1

返回结果的总条数

示例

请求示例

http(s)://apigateway.cn-qingdao.aliyuncs.com/?Action=DescribeModels
&GroupId=30e792398d6c4569b04c0e53a3494381
&<公共请求参数>

正常返回示例

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>{"type":"object","properties":{"id":{"format":"int64","maximum":100,"exclusiveMaximum":true,"type":"integer"},"name":{"maxLength":10,"type":"string"}}}</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"
        }
    ]
    }
}

错误码

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