All Products
Search
Document Center

:ModifyApisecStatus

Last Updated:Nov 15, 2024

Changes the status of the API security module for protected objects or protected object groups.

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
yundun-waf:ModifyApisecStatusupdate
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringNo

The region in which the Web Application Firewall (WAF) instance is deployed. Valid values:

  • cn-hangzhou: Chinese mainland
  • ap-southeast-1: outside the Chinese mainland
cn-hangzhou
InstanceIdstringNo

The ID of the WAF instance.

Note You can call the DescribeInstance operation to query the ID of the WAF instance.
waf-cn-tl32ast****
ResourcesstringNo

The name of the protected object.

alb-wewbb23dfset***
ApisecStatusintegerYes

The status of the API security module. Valid values:

  • 1: enabled
  • 0: disabled
1
ResourceGroupsstringNo

The name of the protected object group to which the protected object belongs.

group
ResourceManagerResourceGroupIdstringNo

The ID of the Alibaba Cloud resource group.

rg-acfm***q

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

Statusboolean

Indicates whether the modification is successful.

true
RequestIdstring

The request ID.

D7861F61-5B61-46CE-A47C-6B19160D5EB0

Examples

Sample success responses

JSONformat

{
  "Status": true,
  "RequestId": "D7861F61-5B61-46CE-A47C-6B19160D5EB0"
}

Error codes

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