すべてのプロダクト
Search
ドキュメントセンター

Edge Security Acceleration:ListEdgeContainerApps

最終更新日:Mar 20, 2026

Alibaba Cloud アカウント内のすべてのコンテナ化アプリケーションをクエリします。

今すぐお試しください

この 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 ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

esa:ListEdgeContainerApps

none

*All Resource

*

なし なし

リクエストパラメーター

パラメーター

必須 / 任意

説明

PageNumber

integer

任意

ページ番号。デフォルト値:1。有効な値の範囲:1~65535。

1

PageSize

integer

任意

1 ページあたりのエントリ数。デフォルト値:20。有効な値の範囲:1~500。

20

OrderKey

string

任意

ソートフィールド。このパラメーターはデフォルトで空です。有効な値:

  • Name:バージョン名。

  • CreateTime:バージョンが作成された時刻。

  • UpdateTime:バージョンが最後に変更された時刻。

CreateTime

OrderType

string

任意

クエリ結果のソート順。このパラメーターはデフォルトで空です。有効な値:

  • ASC:昇順。

  • DESC:降順。

Asc

SearchType

string

任意

あいまい検索を実行する際の検索条件。有効な値:

  • Appid:アプリケーション ID。

  • Name:アプリケーション名。

AppId

SearchKey

string

任意

検索キーワード。

ver-1005682639679266816

レスポンスフィールド

フィールド

説明

object

RequestId

string

リクエスト ID。

2430E05E-1340-5773-B5E1-B743929F46F2

PageNumber

integer

ページ番号。デフォルト値:1。有効な値の範囲:1~65535。

1

PageSize

integer

1 ページあたりのエントリ数。有効な値の範囲:1~500。

10

TotalCount

integer

エントリの総数。

10

Apps

array<object>

クエリされたアプリケーション。

array<object>

クエリされたアプリケーション。

Status

string

アプリケーションのステータス。有効な値:

  • creating:アプリケーションは作成中です。

  • failed:アプリケーションの作成に失敗しました。

  • created:アプリケーションは作成済みです。

created

GatewayType

string

ゲートウェイのタイプ。有効な値:

  • l7:レイヤー 7 ゲートウェイ。

  • l4:レイヤー 4 ゲートウェイ。

l7

CreateTime

string

バージョンが作成された時刻。

2022-12-01T16:16:27.418298794+08:00

VersionCount

integer

アプリケーションのバージョン数。

10

DomainName

string

アプリケーションに関連付けられているドメイン名。

test.com

Remarks

string

備考。

test app

ServicePort

integer

サーバーポート。有効な値の範囲:1~65535。

80

AppId

string

アプリケーション ID。

app-88068867578379****

TargetPort

integer

バックエンドポート。これはアプリケーションのサービスポートでもあります。有効な値の範囲:1~65535。

80

QuicCid

string

QUIC が有効になっているかどうかを示します。

false

Name

string

アプリケーション名。

app-test

UpdateTime

string

アプリケーションが最後に変更された時刻。時刻は、YYYY-MM-DDThh:mm:ss 形式の ISO 8601 標準に準拠しています。時刻は協定世界時 (UTC) で表示されます。

2023-11-15T12:11:02Z

HealthCheck

object

ヘルスチェックに関する情報。

Timeout

integer

ヘルスチェックのタイムアウト期間。単位:秒。

60

Type

string

ヘルスチェックのタイプ。有効な値:

  • l7

  • l4

l7

Host

string

ヘルスチェックに使用されるドメイン名。

test.com

Interval

integer

ヘルスチェックの間隔。単位:秒。

5

SuccTimes

integer

アプリケーションが正常であると見なされるための、連続して成功したヘルスチェックの回数。

1

Method

string

ヘルスチェックに使用される HTTP メソッド。

GET

HttpCode

string

ヘルスチェックの成功を示すヘルスチェックのステータスコードの範囲。

http_2XX

FailTimes

integer

アプリケーションが異常であると見なされるための、連続して失敗したヘルスチェックの回数。

5

Port

integer

ヘルスチェックポート。

8080

Uri

string

ヘルスチェック URL。

/health_check

Percentage

integer

アプリケーション作成タスクの進捗状況 (パーセンテージ)。

100

成功レスポンス

JSONJSON

{
  "RequestId": "2430E05E-1340-5773-B5E1-B743929F46F2",
  "PageNumber": 1,
  "PageSize": 10,
  "TotalCount": 10,
  "Apps": [
    {
      "Status": "created",
      "GatewayType": "l7",
      "CreateTime": "2022-12-01T16:16:27.418298794+08:00",
      "VersionCount": 10,
      "DomainName": "test.com",
      "Remarks": "test app",
      "ServicePort": 80,
      "AppId": "app-88068867578379****",
      "TargetPort": 80,
      "QuicCid": "false",
      "Name": "app-test",
      "UpdateTime": "2023-11-15T12:11:02Z",
      "HealthCheck": {
        "Timeout": 60,
        "Type": "l7",
        "Host": "test.com",
        "Interval": 5,
        "SuccTimes": 1,
        "Method": "GET",
        "HttpCode": "http_2XX",
        "FailTimes": 5,
        "Port": 8080,
        "Uri": "/health_check"
      },
      "Percentage": 100
    }
  ]
}

エラーコード

HTTP ステータスコード

エラーコード

エラーメッセージ

説明

400 InvalidParameter.OrderType The specified OrderType is invalid. Please check the OrderType parameter. You may not have set it to either Asc or Desc. Please make the necessary changes and call the interface again.
400 InvalidParameter.OrderKey The specified OrderKey is invalid. Please check the OrderKey parameter.
400 InvalidParameter Invalid parameter. Check the parameter configuration.
400 InvalidParameter.PageNumber Failed to verify parameter PageNumber.Check whether the parameter exists and is set to a positive integer.
400 InvalidParameter.appid The format of the application ID is invalid. You can call ListEdgeContainerApps to obtain the application ID.
400 InvalidPageSize.ValueNotSupported The PageSize value is invalid. The default value is set to 20. The acceptable range is between 1 and 500.
500 InternalError Failed to call the service. Try again later or contact technical support.
404 InvalidApp.NotFound The application does not exist. Check whether the application ID you specified is correct and try again.

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

変更履歴

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