Verify Firewall Template Deployment Status via API - Simple Application Server - Alibaba Cloud - Simple Application Server

Queries the results of applying a firewall template to instances.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

swas-open:DescribeFirewallTemplateApplyResults

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID of the simple application server. You can call ListRegions to query the list of supported Alibaba Cloud regions.	cn-hangzhou
ClientToken	string	No	The client token that is used to ensure the idempotence of the request. A client token is generated from your client to ensure uniqueness across different requests. The value of ClientToken can contain only ASCII characters and cannot exceed 64 characters in length. For more information, see How to ensure idempotence.	123e4567-e89b-12d3-a456-426655440000
FirewallTemplateId	string	No	The firewall template ID.	ft-bcf1a7hrdq717****
TaskId	array	No	The ID of the template application task.
	string	No	The ID of the template application task.	aft-ikgt0bynitvs3****
PageNumber	integer	No	The page number of the firewall rule list.	1
PageSize	integer	No	The number of entries per page for a paged query. Default value: 20.	20

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	30637AD6-D977-4833-A54C-CC89483E****
PageNumber	string	The number of entries per page for a paged query.	1
PageSize	string	The number of entries per page for a paged query. Default value: 20.	20
TotalCount	string	The total number of firewall rules.	1
data	array<object>	The returned results.
	array<object>	The returned results.
TaskId	string	The ID of the template application task.	aft-ikgt0bynitvs3****
FirewallTemplateId	string	The firewall template ID.	ft-bcf1a7hrdq717****
Status	string	The status of applying the firewall template to all instances. Valid values: Running: The firewall template is being applied. Failed: The firewall template failed to be applied to all instances. Success: The firewall template was applied. PartFailed: The firewall template was partially applied. Some instances failed.	Success
TotalCount	string	The total number of instances to which the firewall template is applied.	1
FailedCount	string	The total number of instances to which the firewall template failed to be applied.	0
InstanceApplyResults	array<object>	The results of applying the firewall template to instances.
	object	The results of applying the firewall template to instances.
InstanceId	string	The simple application server instance ID.	33774babccc84003a2b1ad47e8001233
Status	string	The status of applying the firewall template to a specific instance. Valid values: Running: The firewall template is being applied. Failed: The firewall template failed to be applied. Success: The firewall template was applied. PartFailed: The firewall template was partially applied. Some rules failed.	Success
CreateTime	string	The time when the firewall template application task was executed, in the format of EEE MMM dd HH:mm:ss zzz yyyy.	Tue May 14 11:53:07 CST 2024

Examples

Success response

JSON format

{
  "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"
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.