DescribeModels - - Alibaba Cloud ドキュメントセンター

API グループに作成されたモデルを照会します。

操作説明

あいまいクエリがサポートされています。

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。
API：アクションを具体的に実行するための API。
アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。
リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。
- リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。
- リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。
条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。
依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

apigateway:DescribeModels

get

*ApiGroup

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

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
GroupId	string	必須	API グループの ID。	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
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	モデルが属する API グループの ID。	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	モデルの ID。	766c0b9538a04bdf974953b5576783ba
ModelRef	string	モデルの URI。	https://apigateway.aliyun.com/models/30e792398d6c4569b04c0e53a3494381/766c0b9538a04bdf974953b5576783ba
Tags	object
TagInfo	array<object>	モデルのタグ。
	object
Key	string	タグキー。	ENV
Value	string	タグ値。	ST4

例

成功レスポンス

JSONJSON

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

エラーコード

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。