ListInstances API で関数インスタンスを一覧表示 - FC - Alibaba Cloud - Function Compute

関数インスタンスをリストします。

今すぐお試しください

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

list

*All Resource

*

なし

リクエスト構文

GET /2023-03-30/functions/{functionName}/instances HTTP/1.1

パスパラメーター

パラメーター	型	必須 / 任意	説明	例
functionName	string	必須	関数名。	my-func

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
qualifier	string	任意	関数のバージョンまたはエイリアス。	LATEST
withAllActive	boolean	任意	すべてのアクティブなインスタンスをリストするかどうかを指定します。	true
instanceStatus	array	任意	インスタンスステータスの配列。この操作は、ステータスがこの配列内にあるインスタンスのみを返します。
	string	任意	インスタンスステータス。
startTimeMs	integer	任意	クエリ範囲の開始時刻。UNIX タイムスタンプ (ミリ秒) で指定します。
endTimeMs	integer	任意	クエリ範囲の終了時刻。UNIX タイムスタンプ (ミリ秒) で指定します。
startKey	string	任意	クエリの開始位置を指定するトークン。応答が切り捨てられた場合に返され、結果の次のページを取得するために使用できます。
limit	string	任意	返すインスタンスの最大数。
instanceIds	array	任意	返すインスタンス ID のリスト。
	string	任意	インスタンス ID。

レスポンスフィールド

フィールド	型	説明	例
	ListInstancesOutput	関数インスタンスのリスト。

例

成功レスポンス

JSONJSON

{
  "instances": [
    {
      "instanceId": "1ef6b6ff-7f7b-485e-ab49-501ac681****",
      "versionId": "0",
      "qualifier": "",
      "status": "",
      "createdTimeMs": 0,
      "destroyedTimeMs": 0,
      "resourceType": ""
    }
  ],
  "requestId": ""
}

エラーコード

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

変更履歴

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