首页 API 网关 开发指南 API参考指南 API目录 模型 DescribeModels - 获取已创建的模型

DescribeModels - 获取已创建的模型

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

接口说明

  • 模型查询支持模糊查询

调试

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

调试

授权信息

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

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

请求参数

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

指定的分组编号

30e792398d6c4569b04c0e53a3494381
ModelNamestring

模型的名称

Test
PageSizeinteger

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

10
PageNumberinteger

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

1
ModelIdstring

模型ID

123

返回参数

名称类型描述示例值
object
PageNumberinteger

返回指定的页码

1
RequestIdstring

请求ID

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

返回指定的每页条数

10
TotalCountinteger

返回结果的总条数

1
ModelDetailsarray

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

object
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

示例

请求示例

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

正常返回示例

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

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>

错误码

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

阿里云首页 API 网关 相关技术圈