ListNisInspectionTasks API によるネットワーク検査タスククエリ - NIS

ネットワークインスペクションタスクをリスト表示します。

今すぐお試しください

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

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

nis:ListNisInspectionTasks

list

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
InspectionTaskId	string	任意	ネットワークインスペクションタスクの ID。	ni-8svm******hzr7fh79
InspectionName	string	任意	ネットワークインスペクションタスクの名前。	nis巡检
InspectionProject	string	任意	ネットワークインスペクションタスクが使用するインスペクションソリューションのタイプ。有効な値：basic と customized。列挙値: customized : customized basic : basic	basic
Status	string	任意	タスクの実行中のステータス。有効な値： Creating Active Running Inactive 列挙値: Creating : Creating Active : Active Running : Running Inactive : Inactive	Active
NextToken	string	任意	結果の次のページを取得するために使用されるトークン。このパラメーターを、以前の呼び出しから返された NextToken の値に設定します。	hKrS+MVXkuOgztXnvdml1/R9jhHkiH8eW3CfaOYU0CEL7yiT0zae6J8v1zYNg+d1
MaxResults	integer	任意	ページあたりのエントリ数。有効な値：1 から 100。デフォルト値：20。	20

レスポンスフィールド

フィールド	型	説明	例
	object	RpcResponse
RequestId	string	リクエスト ID。	A7F0D6EC-E19E-58AC-AC9F-08036763960F
InspectionTaskList	array<object>	ネットワークインスペクションタスクのリスト。
	object
InspectionTaskId	string	ネットワークインスペクションタスクの ID。	ni-8svm******hzr7fh79
InspectionName	string	ネットワークインスペクションタスクの名前。	nis巡检
Status	string	タスクの実行中のステータス。有効な値： Creating: タスクが作成中です。 Active Running Inactive	Active
InspectionProject	string	ネットワークインスペクションタスクが使用するインスペクションソリューションのタイプ。有効な値：basic と customized。	basic
CreateTime	string	タスクが作成された時間。	2024-06-18 00:14:46
LastUpdateReportId	string	最新のレポートの ID。	nir-b4c4c9******8a25e
NextToken	string	結果の次のページを取得するためのトークン。このパラメーターの値が空でない場合、さらに結果を取得できることを示します。このパラメーターが空の場合、すべての結果が返されています。	hKrS+MVXkuOgztXnvdml194Cz/lMNdmr+DEh0th6dVlNEo/F148UPCh2itDku7Qj
MaxResults	integer	ページあたりのエントリ数。有効な値：1 から 100。デフォルト値：20。	20
TotalCount	integer	返されたエントリの総数。	5

例

成功レスポンス

JSONJSON

{
  "RequestId": "A7F0D6EC-E19E-58AC-AC9F-08036763960F",
  "InspectionTaskList": [
    {
      "InspectionTaskId": "ni-8svm******hzr7fh79",
      "InspectionName": "nis巡检",
      "Status": "Active",
      "InspectionProject": "basic",
      "CreateTime": "2024-06-18 00:14:46",
      "LastUpdateReportId": "nir-b4c4c9******8a25e"
    }
  ],
  "NextToken": "hKrS+MVXkuOgztXnvdml194Cz/lMNdmr+DEh0th6dVlNEo/F148UPCh2itDku7Qj",
  "MaxResults": 20,
  "TotalCount": 5
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
400	IllegalParam.NextToken	The specified argument NextToken(%s) is illegal.
400	IllegalParam.Status	The specified Status(%s) parameter is illegal.
400	IllegalParam.InspectionProject	The specified argument InspectionProject(%s) is illegal.

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

変更履歴

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