ListInstances を使用して関数のアクティブインスタンスを一覧表示 - Function Compute (FC)

操作説明

ListInstances API を使用すると、指定した関数のアクティブなインスタンスを一覧表示できます。

アクティブなインスタンスとは、リクエストを処理中であるか、またはリクエストの処理にスケジュール可能である状態のインスタンスを指します。ListInstances が返すインスタンスは、同じ ServiceName、FunctionName、および Qualifier を持つ InvokeFunction 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 ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

fc:ListInstances

get

*All Resource

*

なし

リクエスト構文

GET /2021-04-06/services/{serviceName}/functions/{functionName}/instances HTTP/1.1

パスパラメーター

パラメーター	型	必須 / 任意	説明	例
serviceName	string	必須	サービス名。	demoService
functionName	string	必須	関数名。	demoFunction

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
qualifier	string	任意	バージョンまたはエイリアス。	dev
instanceIds	array	任意	インスタンスの ID。
	string	任意	インスタンス ID。	["1ef6b6ff-7f7b-485e-ab49-501ac681**", "04db0821-c6d2-4c10-970b-93e36f1a**"]
limit	integer	任意	返されるインスタンスの最大数。有効な値：0 ～ 1000。実際の結果件数はこの値より少なくなる場合がありますが、これを超えることはありません。	20
X-Fc-Account-Id	string	任意	ご利用の Alibaba Cloud アカウント ID。	188077086902****
X-Fc-Date	string	任意
X-Fc-Trace-Id	string	任意

レスポンスフィールド

フィールド	型	説明	例
	object	クエリによって返されたインスタンス情報のリスト。
instances	array<object>	クエリによって返されたインスタンス情報のリスト。
	object	インスタンス情報。
instanceId	string	インスタンス ID。	1ef6b6ff-7f7b-485e-ab49-501ac681****
versionId	string	当該インスタンスが属するサービスのエディション。インスタンスが LATEST エイリアス下の関数に属する場合、バージョン ID は 0 になります。	1

例

成功レスポンス

JSONJSON

{
  "instances": [
    {
      "instanceId": "1ef6b6ff-7f7b-485e-ab49-501ac681****",
      "versionId": "1"
    }
  ]
}

エラーコード

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

変更履歴

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