Add Domain Set
Function
This API is used to add domain set.
Calling Method
For details, see Calling APIs.
URI
POST /v1/{project_id}/domain-set
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
project 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 |
---|---|---|---|
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. |
object_id |
Yes |
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. |
name |
Yes |
String |
name |
description |
No |
String |
description |
domain_names |
No |
Array of DomainSetInfoDto objects |
domain names |
domain_set_type |
Yes |
Integer |
Domain name group type. 0 means Application type and 1 means Network type. |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
data |
DomainSetResponseData object |
Add Domain Set Response Data |
Example Requests
Add a domain set whose project ID is 9d80d070b6d44942af73c9c3d38e0429, firewall ID is 546af3f8-88e9-47f2-a205-2346d7090925, domain set name is test, domain name is www.aaa.com, and protected object ID is fde07429-2e02-45c0-a85f-4f1cacea24d2.
https://{Endpoint}/v1/9d80d070b6d44942af73c9c3d38e0429/domain-set?fw_instance_id=546af3f8-88e9-47f2-a205-2346d7090925&enterprise_project_id=default { "name" : "test", "domain_set_type" : 0, "description" : "", "domain_names" : [ { "domain_name" : "www.aaa.com", "description" : "" } ], "fw_instance_id" : "546af3f8-88e9-47f2-a205-2346d7090925", "object_id" : "fde07429-2e02-45c0-a85f-4f1cacea24d2" }
Example Responses
Status code: 200
Add Domain Set Response
{ "data" : { "id" : "e43db369-a863-45ed-8850-58d6b571b1ab", "name" : "test" } }
SDK Sample Code
The SDK sample code is as follows.
Java
Add a domain set whose project ID is 9d80d070b6d44942af73c9c3d38e0429, firewall ID is 546af3f8-88e9-47f2-a205-2346d7090925, domain set name is test, domain name is www.aaa.com, and protected object ID is fde07429-2e02-45c0-a85f-4f1cacea24d2.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 |
package com.huaweicloud.sdk.test; import com.huaweicloud.sdk.core.auth.ICredential; import com.huaweicloud.sdk.core.auth.BasicCredentials; import com.huaweicloud.sdk.core.exception.ConnectionException; import com.huaweicloud.sdk.core.exception.RequestTimeoutException; import com.huaweicloud.sdk.core.exception.ServiceResponseException; import com.huaweicloud.sdk.cfw.v1.region.CfwRegion; import com.huaweicloud.sdk.cfw.v1.*; import com.huaweicloud.sdk.cfw.v1.model.*; import java.util.List; import java.util.ArrayList; public class AddDomainSetSolution { public static void main(String[] args) { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment String ak = System.getenv("CLOUD_SDK_AK"); String sk = System.getenv("CLOUD_SDK_SK"); ICredential auth = new BasicCredentials() .withAk(ak) .withSk(sk); CfwClient client = CfwClient.newBuilder() .withCredential(auth) .withRegion(CfwRegion.valueOf("<YOUR REGION>")) .build(); AddDomainSetRequest request = new AddDomainSetRequest(); request.withEnterpriseProjectId("<enterprise_project_id>"); request.withFwInstanceId("<fw_instance_id>"); AddDomainSetInfoDto body = new AddDomainSetInfoDto(); List<DomainSetInfoDto> listbodyDomainNames = new ArrayList<>(); listbodyDomainNames.add( new DomainSetInfoDto() .withDomainName("www.aaa.com") .withDescription("") ); body.withDomainSetType(0); body.withDomainNames(listbodyDomainNames); body.withDescription(""); body.withName("test"); body.withObjectId("fde07429-2e02-45c0-a85f-4f1cacea24d2"); body.withFwInstanceId("546af3f8-88e9-47f2-a205-2346d7090925"); request.withBody(body); try { AddDomainSetResponse response = client.addDomainSet(request); System.out.println(response.toString()); } catch (ConnectionException e) { e.printStackTrace(); } catch (RequestTimeoutException e) { e.printStackTrace(); } catch (ServiceResponseException e) { e.printStackTrace(); System.out.println(e.getHttpStatusCode()); System.out.println(e.getRequestId()); System.out.println(e.getErrorCode()); System.out.println(e.getErrorMsg()); } } } |
Python
Add a domain set whose project ID is 9d80d070b6d44942af73c9c3d38e0429, firewall ID is 546af3f8-88e9-47f2-a205-2346d7090925, domain set name is test, domain name is www.aaa.com, and protected object ID is fde07429-2e02-45c0-a85f-4f1cacea24d2.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 |
# coding: utf-8 from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkcfw.v1.region.cfw_region import CfwRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkcfw.v1 import * if __name__ == "__main__": # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak = __import__('os').getenv("CLOUD_SDK_AK") sk = __import__('os').getenv("CLOUD_SDK_SK") credentials = BasicCredentials(ak, sk) \ client = CfwClient.new_builder() \ .with_credentials(credentials) \ .with_region(CfwRegion.value_of("<YOUR REGION>")) \ .build() try: request = AddDomainSetRequest() request.enterprise_project_id = "<enterprise_project_id>" request.fw_instance_id = "<fw_instance_id>" listDomainNamesbody = [ DomainSetInfoDto( domain_name="www.aaa.com", description="" ) ] request.body = AddDomainSetInfoDto( domain_set_type=0, domain_names=listDomainNamesbody, description="", name="test", object_id="fde07429-2e02-45c0-a85f-4f1cacea24d2", fw_instance_id="546af3f8-88e9-47f2-a205-2346d7090925" ) response = client.add_domain_set(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
Go
Add a domain set whose project ID is 9d80d070b6d44942af73c9c3d38e0429, firewall ID is 546af3f8-88e9-47f2-a205-2346d7090925, domain set name is test, domain name is www.aaa.com, and protected object ID is fde07429-2e02-45c0-a85f-4f1cacea24d2.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 |
package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" cfw "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cfw/v1" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cfw/v1/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cfw/v1/region" ) func main() { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak := os.Getenv("CLOUD_SDK_AK") sk := os.Getenv("CLOUD_SDK_SK") auth := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). Build() client := cfw.NewCfwClient( cfw.CfwClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.AddDomainSetRequest{} enterpriseProjectIdRequest:= "<enterprise_project_id>" request.EnterpriseProjectId = &enterpriseProjectIdRequest fwInstanceIdRequest:= "<fw_instance_id>" request.FwInstanceId = &fwInstanceIdRequest domainNameDomainNames:= "www.aaa.com" descriptionDomainNames:= "" var listDomainNamesbody = []model.DomainSetInfoDto{ { DomainName: &domainNameDomainNames, Description: &descriptionDomainNames, }, } descriptionAddDomainSetInfoDto:= "" request.Body = &model.AddDomainSetInfoDto{ DomainSetType: int32(0), DomainNames: &listDomainNamesbody, Description: &descriptionAddDomainSetInfoDto, Name: "test", ObjectId: "fde07429-2e02-45c0-a85f-4f1cacea24d2", FwInstanceId: "546af3f8-88e9-47f2-a205-2346d7090925", } response, err := client.AddDomainSet(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
More
For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.
Status Codes
Status Code |
Description |
---|---|
200 |
Add Domain Set Response |
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