API でファイアウォールテンプレートデプロイ状況を確認する方法 - SAS - Alibaba Cloud - Simple Application Server

インスタンスへのファイアウォールテンプレートの適用結果を照会します。

今すぐお試しください

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

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

swas-open:DescribeFirewallTemplateApplyResults

list

*すべてのリソース。

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
RegionId	string	必須	シンプルアプリケーションサーバーのリージョン ID。 ListRegions を呼び出して、サポートされている Alibaba Cloud リージョンのリストをクエリできます。	cn-hangzhou
ClientToken	string	任意	リクエストのべき等性を確保するために使用されるクライアントトークン。クライアントトークンは、異なるリクエスト間での一意性を確保するためにクライアントから生成されます。ClientToken の値のフォーマットは ASCII 文字のみで、長さは 64 文字以下にする必要があります。詳細については、「べき等性を確保する方法」を参照してください。	123e4567-e89b-12d3-a456-426655440000
FirewallTemplateId	string	任意	ファイアウォールテンプレート ID。	ft-bcf1a7hrdq717****
TaskId	array	任意	テンプレートアプリケーションタスクの ID。
	string	任意	テンプレートアプリケーションタスクの ID。	aft-ikgt0bynitvs3****
PageNumber	integer	任意	ファイアウォールルールリストのページ番号。	1
PageSize	integer	任意	ページングクエリの 1 ページあたりのエントリ数。デフォルト値: 20。	20

レスポンスフィールド

フィールド	型	説明	例
	object
RequestId	string	リクエスト ID。	30637AD6-D977-4833-A54C-CC89483E****
PageNumber	string	ページングクエリのページ番号。	1
PageSize	string	ページングクエリの 1 ページあたりのエントリ数。デフォルト値: 20。	20
TotalCount	string	ファイアウォールルールの総数。	1
data	array<object>	返される結果。
	array<object>	返される結果。
TaskId	string	テンプレートアプリケーションタスクの ID。	aft-ikgt0bynitvs3****
FirewallTemplateId	string	ファイアウォールテンプレート ID。	ft-bcf1a7hrdq717****
Status	string	すべてのインスタンスへのファイアウォールテンプレートの適用ステータス。有効な値: Running: ファイアウォールテンプレートを適用中です。 Failed: ファイアウォールテンプレートをすべてのインスタンスに適用できませんでした。 Success: ファイアウォールテンプレートが適用されました。 PartFailed: ファイアウォールテンプレートが部分的に適用されました。一部のインスタンスへの適用に失敗しました。	Success
TotalCount	string	ファイアウォールテンプレートが適用されるインスタンスの総数。	1
FailedCount	string	ファイアウォールテンプレートの適用に失敗したインスタンスの総数。	0
InstanceApplyResults	array<object>	インスタンスへのファイアウォールテンプレートの適用結果。
	object	インスタンスへのファイアウォールテンプレートの適用結果。
InstanceId	string	シンプルアプリケーションサーバーインスタンス ID。	33774babccc84003a2b1ad47e8001233
Status	string	特定のインスタンスへのファイアウォールテンプレートの適用ステータス。有効な値: Running: ファイアウォールテンプレートを適用中です。 Failed: ファイアウォールテンプレートの適用に失敗しました。 Success: ファイアウォールテンプレートが適用されました。 PartFailed: ファイアウォールテンプレートが部分的に適用されました。一部のルールの適用に失敗しました。	Success
CreateTime	string	ファイアウォールテンプレート適用タスクが実行された時間。フォーマットは EEE MMM dd HH:mm:ss zzz yyyy です。	Tue May 14 11:53:07 CST 2024

例

成功レスポンス

JSONJSON

{
  "RequestId": "30637AD6-D977-4833-A54C-CC89483E****",
  "PageNumber": "1",
  "PageSize": "20",
  "TotalCount": "1",
  "data": [
    {
      "TaskId": "aft-ikgt0bynitvs3****",
      "FirewallTemplateId": "ft-bcf1a7hrdq717****",
      "Status": "Success",
      "TotalCount": "1",
      "FailedCount": "0",
      "InstanceApplyResults": [
        {
          "InstanceId": "33774babccc84003a2b1ad47e8001233",
          "Status": "Success"
        }
      ],
      "CreateTime": "Tue May 14 11:53:07 CST 2024"
    }
  ]
}

エラーコード

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

変更履歴

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