Updating a Domain Name Group
Function
This API is used to update a domain name group.
URI
PUT /v1/{project_id}/domain-set/{set_id}
Parameter | Mandatory | Type | Description |
|---|---|---|---|
project_id | Yes | String | Project ID, which can be obtained by calling an API or from the console. For details, see Obtaining a Project ID. |
set_id | Yes | String | Domain name group ID, which can be obtained by calling the API for querying the domain name group list. Find the value in data.records.set_id (The period [.] is used to separate different levels of objects). |
Parameter | Mandatory | Type | Description |
|---|---|---|---|
enterprise_project_id | No | String | Enterprise project ID, which is the ID of a project planned based on organizations. You can obtain the enterprise project ID by referring to Obtaining an Enterprise Project ID. If the enterprise project function is not enabled, the value is 0. |
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 for querying a firewall instance. |
Request Parameters
Parameter | Mandatory | Type | Description |
|---|---|---|---|
X-Auth-Token | Yes | String | User token. You can obtain the token by referring to Obtaining a User Token. |
Content-Type | Yes | String | Content type. It can only be set to application/json. |
Parameter | Mandatory | Type | Description |
|---|---|---|---|
name | Yes | String | Domain name group name. |
description | No | String | Domain name group description. |
Response Parameters
Status code: 200
Parameter | Type | Description |
|---|---|---|
data | DomainSetResponseData object | Returned data of for updating a domain name group. |
Example Requests
Change the name of the domain name group 94da194d-24b2-4f60-919e-cf0bc76c75b3 of firewall 7a004e79-0b8b-4679-ab20-267f3946e8ba in project 9d80d070b6d44942af73c9c3d38e0429 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
Return value for updating a domain name group.
{
"data" : {
"id" : "94da194d-24b2-4f60-919e-cf0bc76c75b3",
"name" : "test"
}
} Status Codes
Status Code | Description |
|---|---|
200 | Return value for updating a domain name group. |
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.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot
