ListAppServicesPage API でアプリサービス一覧を取得 - SAE - Alibaba Cloud - Serverless App Engine

ListAppServicesPage を呼び出して、アプリケーションサービスのリストを取得します。

今すぐお試しください

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

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

sae:ListAppServicesPage

*All Resource

*

なし

リクエスト構文

GET /pop/v1/sam/service/listAppServicesPage HTTP/1.1

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
AppId	string	必須	アプリケーション ID。	6dcc8c9e-d3da-478a-a066-86dcf820****
ServiceType	string	必須	サービスタイプ。有効な値： Dubbo Spring Cloud	springCloud
PageNumber	integer	任意	ページ番号。	1
PageSize	integer	任意	ページサイズ。値は 0 から 9,999 までの整数である必要があります。	9999

レスポンスフィールド

フィールド	型	説明	例
	object	返されるデータ。
RequestId	string	リクエスト ID。	2583E089-99C2-562E-8B7E-73512136****
Message	string	リクエストの結果を説明するメッセージ。	success
TraceId	string	リクエストの詳細を照会するために使用されるトレース ID。	0be3e0c816394483660457498e****
Data	array<object>	サービスリスト。
	array<object>	サービスリスト。
CurrentPage	string	現在のページ番号。	1
TotalSize	string	エントリの総数。	1
PageNumber	string	ページ番号。	1
PageSize	string	1ページあたりのエントリ数。値の範囲は 0～9999 です。	9999
Result	array<object>	返された結果。
	object	返された結果。
EdasAppName	string	アプリケーション名。	cn-zhangjiakou-micro-service-******
Version	string	サービスバージョン。この値はユーザー定義です。	1.0.0
InstanceNum	integer	インスタンス数。	1
EdasAppId	string	アプリケーション ID。	hc4fs1**@98314c8790b**
ServiceName	string	サービス名。	edas.service.provider
Group	string	サービスグループ。この値はユーザー定義です。	springCloud
ErrorCode	string	エラーコード。リクエストが成功した場合、このパラメーターは返されません。リクエストが失敗した場合、このパラメーターが返されます。詳細については、このトピックの「エラーコード」セクションをご参照ください。
Code	string	API ステータスコードまたは POP エラーコード。有効な値： 2xx：成功。 3xx：リダイレクト。 4xx：クライアントエラー。 5xx：サーバーエラー。	200
Success	boolean	リクエストが成功したかどうかを示します。有効な値： true：リクエストは成功しました。 false：リクエストは失敗しました。	true

例

成功レスポンス

JSONJSON

{
  "RequestId": "2583E089-99C2-562E-8B7E-73512136****",
  "Message": "success",
  "TraceId": "0be3e0c816394483660457498e****",
  "Data": [
    {
      "CurrentPage": "1",
      "TotalSize": "1",
      "PageNumber": "1",
      "PageSize": "9999",
      "Result": [
        {
          "EdasAppName": "cn-zhangjiakou-micro-service-******",
          "Version": "1.0.0",
          "InstanceNum": 1,
          "EdasAppId": "hc4fs1****@98314c8790b****",
          "ServiceName": "edas.service.provider",
          "Group": "springCloud"
        }
      ]
    }
  ],
  "ErrorCode": "",
  "Code": "200",
  "Success": true
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
400	Micro.Service.NotFound	The micro service not found {%s}.
400	InvalidParameter.Obviously	The specified parameter is invalid {%s}.

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

変更履歴

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