Help Center/ Cloud Firewall/ API Reference (Ankara Region)/ API/ Domain Parse and Domain Set Management/ Update Domain Set
Updated on 2024-12-05 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Update Domain Set

Function

This API is used to update domain set.

Calling Method

For details, see Calling APIs.

URI

PUT /v1/{project_id}/domain-set/{set_id}

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

project ID

set_id

Yes

String

domain set id
Table 2 Query Parameters

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

Yes

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

Table 3 Request header 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.
Table 4 Request body parameters

Parameter

Mandatory

Type

Description

name

Yes

String

name

description

No

String

description

Response Parameters

Status code: 200

Table 5 Response body parameters

Parameter

Type

Description

data

DomainSetResponseData object

update domain set response
Table 6 DomainSetResponseData

Parameter

Type

Description

id

String

id

name

String

name

Example Requests

For the firewall 7a004e79-0b8b-4679-ab20-267f3946e8ba in the project 9d80d070b6d44942af73c9c3d38e0429, change the domain set ID to 94da194d-24b2-4f60-919e-cf0bc76c75b3, the domain name to www.aaa.com, and name to test.

https://{Endpoint}/v1/9d80d070b6d44942af73c9c3d38e0429/domain-set/94da194d-24b2-4f60-919e-cf0bc76c75b3?fw_instance_id=7a004e79-0b8b-4679-ab20-267f3946e8ba&enterprise_project_id=default

{
  "name" : "test",
  "description" : ""
}

Example Responses

Status code: 200

Update Domain Set Response

{
  "data" : {
    "id" : "94da194d-24b2-4f60-919e-cf0bc76c75b3",
    "name" : "test"
  }
}

Status Codes

Status Code

Description

200

Update Domain Set Response

Error Codes

See Error Codes.