Updating the Blacklist or Whitelist
Function
This API is used to update the blacklist or whitelist.
Debugging
You can debug this API through automatic authentication in or use the SDK sample code generated by API Explorer.
URI
PUT /v1/{project_id}/black-white-list/{list_id}
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
project_id |
Yes |
String |
Project ID |
list_id |
Yes |
String |
Blacklist/Whitelist ID |
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
enterprise_project_id |
No |
String |
Enterprise project id, the id generated by the enterprise project after the user supports the enterprise project. |
fw_instance_id |
No |
String |
Firewall instance ID, which is automatically generated after a CFW instance is created. You can obtain the ID by calling the API used for querying a firewall instance. For details, see the API Explorer and Help Center FAQ.By default, if fw_instance_Id is not specified, information about the first firewall under the account is returned. If fw_instance_Id is specified, information about the firewall with this fw_instance_Id is returned.If object_Id is specified, information about the firewall with this object_Id is returned by default. If both fw_instance_Id and object_Id are specified, the specified object_Id must belong to the specified firewall. |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
X-Auth-Token |
Yes |
String |
User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is a token. |
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
direction |
No |
Integer |
Indicates the address direction. 0: source address 1: destination address |
address_type |
No |
Integer |
Address type. 0: ipv4; 1: ipv6; 2: domain |
address |
No |
String |
IP address |
protocol |
No |
Integer |
Protocol type. The value is 6 for TCP, 17 for UDP, 1 for ICMP, 58 for ICMPv6, and -1 for any protocol. |
port |
No |
String |
Port |
list_type |
No |
Integer |
Blacklist/Whitelist type. The options are 4 (blacklist) and 5 (whitelist). Enumeration values:
|
object_id |
No |
String |
Protected object ID, which is used to distinguish Internet border protection from VPC border protection after a CFW instance is created. You can obtain the ID by calling the API used for querying a firewall instance. Note that the value 0 indicates the ID of a protected object on the Internet border, and the value 1 indicates the ID of a protected object on the VPC border. For details, see the API Explorer and Help Center FAQ. |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
|---|---|---|
data |
IdObject object |
Response to the request for updating a blacklist or whitelist |
Status code: 400
Parameter |
Type |
Description |
|---|---|---|
error_code |
String |
Error code Minimum: 8 Maximum: 36 |
error_msg |
String |
Description Minimum: 2 Maximum: 512 |
Example Requests
Add an IPv4 TCP whitelist to object cfebd347-b655-4b84-b938-3c54317599b2 of project 9d80d070b6d44942af73c9c3d38e0429. Whitelist direction: source address; IP address: 1.1.1.1; protocol type: TCP; port number: 1
https://{Endpoint}/v1/9d80d070b6d44942af73c9c3d38e0429/black-white-list/9d80d070b6d44942af73c9c3d38e042b
{
"object_id" : "cfebd347-b655-4b84-b938-3c54317599b2",
"list_type" : 5,
"direction" : 0,
"address" : "1.1.1.1",
"protocol" : 6,
"port" : "1",
"address_type" : 0
}
Example Responses
Status code: 200
Blacklist/Whitelist update response
{
"data" : {
"id" : "2eee3fe8-0b9b-49ac-8e7f-eaafa321e99a"
}
}
Status code: 400
Bad Request
{
"error_code" : "CFW.00200005",
"error_msg" : "operation content does not exist"
}
Status Codes
Status Code |
Description |
|---|---|
200 |
Blacklist/Whitelist update response |
400 |
Bad Request |
401 |
Unauthorized |
403 |
Forbidden |
404 |
Not Found |
500 |
Internal Server Error |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.
