All Products
Search
Document Center

Get a model you've created

Last Updated: Jul 12, 2019

Description

You can call this operation to query all models in a group.

  • Searching by fuzzy match is supported.

Request Parameters

Parameter Type Required Description
Action String Yes The operation that you want to perform. Set this parameter to DescribeModels.
GroupId String Yes The ID of the group to query.
ModelName String No The name of the model to query.
PageSize Integer No The number of entries to return on each page. Maximum value: 100. Default value: 10.
PageNumber Integer No The number of the page to return. Pages start from page 1. Default value: 1.

Response parameters

Parameter Type Description
RequestId String The ID of the request.
TotalCount String The total number of returned entries.
PageSize String The number of entries returned on each page.
PageNumber String The number of the page returned.
ModelDetails String The detailed information of the returned models. It is an array consisting of ModelDetails data.

Examples

Sample requests

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

Sample responsesXML format

  1. <DescribeModelsResponse>
  2. <PageNumber>1</PageNumber>
  3. <TotalCount>1</TotalCount>
  4. <PageSize>10</PageSize>
  5. <RequestId>40306469-2FB5-417A-B723-AF1F4A4FA204</RequestId>
  6. <ModelDetails>
  7. <ModelDetail>
  8. <Description>Model Description</Description>
  9. <ModelId>766c0b9538a04bdf974953b5576783ba</ModelId>
  10. <CreatedTime>2019-01-29T11:07:48Z</CreatedTime>
  11. <ModelName>Test</ModelName>
  12. <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>
  13. <ModelRef>https://apigateway.aliyun.com/models/30e792398d6c4569b04c0e53a3494381/766c0b9538a04bdf974953b5576783ba</ModelRef>
  14. <ModifiedTime>2019-01-29T11:07:48Z</ModifiedTime>
  15. <GroupId>30e792398d6c4569b04c0e53a3494381</GroupId>
  16. </ModelDetail>
  17. </ModelDetails>
  18. </DescribeModelsResponse>

JSON format

  1. {
  2. "PageNumber": 1,
  3. "TotalCount": 1,
  4. "PageSize": 10,
  5. "RequestId": "40306469-2FB5-417A-B723-AF1F4A4FA204",
  6. "ModelDetails": {
  7. "ModelDetail": [
  8. {
  9. "Description": "Model Description",
  10. "ModelId": "766c0b9538a04bdf974953b5576783ba",
  11. "CreatedTime": "2019-01-29T11:07:48Z",
  12. "ModelName": "Test",
  13. "Schema": "{\"type\":\"object\",\"properties\":{\"id\":{\"format\":\"int64\",\"maximum\":100,\"exclusiveMaximum\":true,\"type\":\"integer\"},\"name\":{\"maxLength\":10,\"type\":\"string\"}}}",
  14. "ModelRef": "https://apigateway.aliyun.com/models/30e792398d6c4569b04c0e53a3494381/766c0b9538a04bdf974953b5576783ba",
  15. "ModifiedTime": "2019-01-29T11:07:48Z",
  16. "GroupId": "30e792398d6c4569b04c0e53a3494381"
  17. }
  18. ]
  19. }
  20. }