All Products
Search
Document Center

Simple Application Server:DescribeFirewallTemplateApplyResults

Last Updated:Oct 30, 2024

Queries the result of applying a firewall template to simple application servers.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
swas-open:DescribeFirewallTemplateApplyResultslist
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

The region ID of the simple application server. You can call the ListRegions operation to query the most recent region list.

cn-hangzhou
ClientTokenstringNo

The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token 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
FirewallTemplateIdstringNo

The ID of the firewall template.

ft-bcf1a7hrdq717****
TaskIdarrayNo

The ID of the execution to apply the template.

stringNo

The ID of the execution to apply the template.

aft-ikgt0bynitvs3****
PageNumberintegerNo

The page number.

1
PageSizeintegerNo

The number of entries per page. Default value: 20.

20

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The request ID.

30637AD6-D977-4833-A54C-CC89483E****
PageNumberstring

The page number.

1
PageSizestring

The number of entries per page. Default value: 20.

20
TotalCountstring

The total number of entries returned.

1
dataarray<object>

The returned results.

ApplyFirewallTemplateResultobject
TaskIdstring

The ID of the execution to apply the template.

aft-ikgt0bynitvs3****
FirewallTemplateIdstring

The ID of the firewall template.

ft-bcf1a7hrdq717****
Statusstring

The status of applying the template to all simple application servers. Valid values:

  • Running: The firewall template is being applied to simple application servers.
  • Failed: The firewall template is applied to none of simple application servers.
  • Success: The firewall template is applied to all simple application servers.
  • PartFailed: The firewall template fails to be applied to some simple application servers.
Success
TotalCountstring

The total number of entries returned.

1
FailedCountstring

The total number of simple application servers to which the firewall template fails to apply.

0
InstanceApplyResultsarray<object>

The result of applying the firewall template to the simple application servers.

ApplyInstanceResultobject
InstanceIdstring

The ID of the simple application server.

33774babccc84003a2b1ad47e8001233
Statusstring

The status of applying the firewall template to the simple application servers. Valid values:

  • Running: The firewall template is being applied to the simple application servers.
  • Failed: The firewall template is applied to none of the simple application servers.
  • Success: The firewall template is applied to all the simple application servers.
  • PartFailed: The firewall template fails to be applied to some simple application servers.
Success
CreateTimestring

The time when the firewall template was applied to the simple application servers.

Tue May 14 11:53:07 CST 2024

Examples

Sample success responses

JSONformat

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

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2024-08-12The request parameters of the API has changedView Change Details