調用DescribeModels擷取API分組的模型資訊-API Gateway-阿里雲

擷取API分組已建立的模型。

介面說明

模型查詢支援模糊查詢

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

apigateway:DescribeModels

get

*ApiGroup

acs:apigateway:{#regionId}:{#accountId}:apigroup/{#GroupId}

無

請求參數

名稱	類型	必填	描述	樣本值
GroupId	string	是	指定的分組編號	30e792398d6c4569b04c0e53a3494381
ModelName	string	否	模型的名稱	Test
PageSize	integer	否	指定分頁查詢時每頁行數，最大值 100，預設值為 10	10
PageNumber	integer	否	指定要查詢的頁碼，預設是 1，起始是 1	1
ModelId	string	否	模型 ID	123
Tag	array<object>	否	指定規則所適用的對象標籤，可設定多個。
	object	否
Key	string	否	標籤的 key	key
Value	string	否	標籤的值。	value

返回參數

名稱	類型	描述	樣本值
	object
PageNumber	integer	返回指定的頁碼	1
RequestId	string	請求 ID	40306469-2FB5-417A-B723-AF1F4A4FA204
PageSize	integer	返回指定的每頁條數	10
TotalCount	integer	返回結果的總條數	1
ModelDetails	object
ModelDetail	array<object>	由 ModelDetail 組成的數組格式，返回模型的詳細資料
	array<object>
ModifiedTime	string	模型的最後修改時間	2019-01-29T11:07:48Z
GroupId	string	模型所屬的分組編號	30e792398d6c4569b04c0e53a3494381
Description	string	模型的定義說明	Model Description
Schema	string	模型的定義	{\"type\":\"object\",\"properties\":{\"id\":{\"format\":\"int64\",\"maximum\":100,\"exclusiveMaximum\":true,\"type\":\"integer\"},\"name\":{\"maxLength\":10,\"type\":\"string\"}}}
ModelName	string	模型的名稱	Test
CreatedTime	string	模型的建立時間	2019-01-29T11:07:48Z
ModelId	string	模型的編號	766c0b9538a04bdf974953b5576783ba
ModelRef	string	模型的 URI	https://apigateway.aliyun.com/models/30e792398d6c4569b04c0e53a3494381/766c0b9538a04bdf974953b5576783ba
Tags	object
TagInfo	array<object>	標籤。
	object
Key	string	標籤鍵。	ENV
Value	string	標籤值	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"
            }
          ]
        }
      }
    ]
  }
}

錯誤碼

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。