更新时间:2024-10-16 GMT+08:00
分享

添加域名组

功能介绍

添加域名组

调用方法

请参见如何调用API

URI

POST /v1/{project_id}/domain-set

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID, 可以从调API处获取,也可以从控制台获取。项目ID获取方式

表2 Query参数

参数

是否必选

参数类型

描述

enterprise_project_id

String

企业项目ID,用户根据组织规划企业项目,对应的ID为企业项目ID,可通过如何获取企业项目ID获取,用户未开启企业项目时为0

fw_instance_id

String

防火墙id,可通过防火墙ID获取方式获取

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。可通过如何获取用户Token获取。

表4 请求Body参数

参数

是否必选

参数类型

描述

fw_instance_id

String

防火墙id,可通过防火墙ID获取方式获取

object_id

String

防护对象id,是创建云防火墙后用于区分互联网边界防护和VPC边界防护的标志id,可通过调用查询防火墙实例接口获得,通过返回值中的data.records.protect_objects.object_id(.表示各对象之间层级的区分)获得,注意type为0的为互联网边界防护对象id,type为1的为VPC边界防护对象id,type可通过data.records.protect_objects.type(.表示各对象之间层级的区分)获得

name

String

域名组名称

description

String

域名组描述

domain_names

Array of DomainSetInfoDto objects

域名信息列表

domain_set_type

Integer

域名组类型,0表示应用域名组,1表示网络域名组

表5 DomainSetInfoDto

参数

是否必选

参数类型

描述

domain_name

String

域名,如www.test.com

description

String

域名描述

响应参数

状态码: 200

表6 响应Body参数

参数

参数类型

描述

data

DomainSetResponseData object

添加域名组返回数据

表7 DomainSetResponseData

参数

参数类型

描述

id

String

域名组id

name

String

域名组名称

请求示例

向项目id为9d80d070b6d44942af73c9c3d38e0429,防火墙id为546af3f8-88e9-47f2-a205-2346d7090925添加域名组,域名组名称为test,域名组内域名为www.aaa.com,防护对象id为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",
  "description" : "",
  "domain_names" : [ {
    "domain_name" : "www.aaa.com",
    "description" : ""
  } ],
  "fw_instance_id" : "546af3f8-88e9-47f2-a205-2346d7090925",
  "object_id" : "fde07429-2e02-45c0-a85f-4f1cacea24d2"
}

响应示例

状态码: 200

添加域名组返回值

{
  "data" : {
    "id" : "e43db369-a863-45ed-8850-58d6b571b1ab",
    "name" : "test"
  }
}

SDK代码示例

SDK代码示例如下。

Java

向项目id为9d80d070b6d44942af73c9c3d38e0429,防火墙id为546af3f8-88e9-47f2-a205-2346d7090925添加域名组,域名组名称为test,域名组内域名为www.aaa.com,防护对象id为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
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");
        String projectId = "{project_id}";

        ICredential auth = new BasicCredentials()
                .withProjectId(projectId)
                .withAk(ak)
                .withSk(sk);

        CfwClient client = CfwClient.newBuilder()
                .withCredential(auth)
                .withRegion(CfwRegion.valueOf("<YOUR REGION>"))
                .build();
        AddDomainSetRequest request = new AddDomainSetRequest();
        AddDomainSetInfoDto body = new AddDomainSetInfoDto();
        [](model.DomainSetInfoDto) listbodyDomainNames = new ArrayList<>();
        listbodyDomainNames.add(
            new DomainSetInfoDto()
                .withDomainName("www.aaa.com")
                .withDescription("")
        );
        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

向项目id为9d80d070b6d44942af73c9c3d38e0429,防火墙id为546af3f8-88e9-47f2-a205-2346d7090925添加域名组,域名组名称为test,域名组内域名为www.aaa.com,防护对象id为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
# coding: utf-8

import os
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 = os.environ["CLOUD_SDK_AK"]
    sk = os.environ["CLOUD_SDK_SK"]
    projectId = "{project_id}"

    credentials = BasicCredentials(ak, sk, projectId)

    client = CfwClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(CfwRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = AddDomainSetRequest()
        listDomainNamesbody = [
            DomainSetInfoDto(
                domain_name="www.aaa.com",
                description=""
            )
        ]
        request.body = AddDomainSetInfoDto(
            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

向项目id为9d80d070b6d44942af73c9c3d38e0429,防火墙id为546af3f8-88e9-47f2-a205-2346d7090925添加域名组,域名组名称为test,域名组内域名为www.aaa.com,防护对象id为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
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")
    projectId := "{project_id}"

    auth := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        WithProjectId(projectId).
        Build()

    client := cfw.NewCfwClient(
        cfw.CfwClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.AddDomainSetRequest{}
	descriptionDomainNames:= ""
	var listDomainNamesbody = []model.DomainSetInfoDto{
        {
            DomainName: "www.aaa.com",
            Description: &descriptionDomainNames,
        },
    }
	descriptionAddDomainSetInfoDto:= ""
	request.Body = &model.AddDomainSetInfoDto{
		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)
    }
}

更多

更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。

状态码

状态码

描述

200

添加域名组返回值

错误码

请参见错误码

相关文档