ListConsumedServices API 呼び出しによるマイクロサービスサブスクリプションのクエリ - SAE - Alibaba Cloud - Serverless App Engine

`ListConsumedServices` 操作を呼び出して、サブスクライブしたマイクロサービスのリストを取得できます。

今すぐお試しください

この 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:ListConsumedServices

get

*All Resource

*

なし

リクエスト構文

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

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
AppId	string	必須	アプリケーション ID。	b2a8a925-477a-4ed7-b825-d5e22500****

レスポンスフィールド

フィールド	型	説明	例
	object	返されるデータ。
RequestId	string	リクエスト ID。	91F93257-7A4A-4BD3-9A7E-2F6EAE6D****
Message	string	返されるメッセージ。リクエストが成功した場合、success が返されます。リクエストが失敗した場合、エラーコードが返されます。	success
TraceId	string	リクエストトレースの ID。この ID を使用して、リクエストの詳細をクエリできます。	0a98a02315955564772843261e****
Data	array<object>	マイクロサービスに関する情報。
	object	マイクロサービスに関する情報。
Type	string	公開されたサービスのタイプ。	RPC
Groups	array	利用中のサービスが属するグループ。
	string	利用中のサービスが属するグループ。	HSF
Version	string	公開されたサービスのバージョン。	1.0.0
AppId	string	アプリケーション ID。	b2a8a925-477a-4ed7-b825-d5e22500****
Group2Ip	string	予約済みのフィールド。	{}
Ips	array	サービスサブスクリプションアドレス。
	string	サービスサブスクリプションアドレス。	10.0.0.1
Name	string	公開されたサービスの名前。	com.alibaba.nodejs.ItemService
ErrorCode	string	エラーコード。リクエストが成功した場合、このパラメーターは返されません。リクエストが失敗した場合、このパラメーターが返されます。詳細については、このトピックの「エラーコード」セクションをご参照ください。
Code	string	HTTP ステータスコード。 2xx：リクエストは成功しました。 3xx：リクエストはリダイレクトされました。 4xx：リクエストエラーが発生しました。 5xx：サーバーエラーが発生しました。	200
Success	boolean	サブスクライブしたマイクロサービスのリストが取得されたかどうかを示します。 true：リストは取得されました。 false：リストの取得に失敗しました。	true

例

成功レスポンス

JSONJSON

{
  "RequestId": "91F93257-7A4A-4BD3-9A7E-2F6EAE6D****",
  "Message": "success",
  "TraceId": "0a98a02315955564772843261e****",
  "Data": [
    {
      "Type": "RPC",
      "Groups": [
        "HSF"
      ],
      "Version": "1.0.0",
      "AppId": "b2a8a925-477a-4ed7-b825-d5e22500****",
      "Group2Ip": "{}",
      "Ips": [
        "10.0.0.1"
      ],
      "Name": "com.alibaba.nodejs.ItemService"
    }
  ],
  "ErrorCode": "",
  "Code": "200",
  "Success": true
}

エラーコード

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

変更履歴

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