更新时间:2024-04-07 GMT+08:00
分享

添加域名列表

功能介绍

添加域名列表

调用方法

请参见如何调用API

URI

POST /v1/{project_id}/domain-set/domains/{set_id}

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

租户项目id

set_id

String

域名组id

表2 Query参数

参数

是否必选

参数类型

描述

enterprise_project_id

String

企业项目id,用户支持企业项目后,由企业项目生成的id。

fw_instance_id

String

防火墙实例id,创建云防火墙后用于标志防火墙由系统自动生成的标志id,可通过调用查询防火墙实例接口获得。具体可参考APIExlorer和帮助中心FAQ。默认情况下,fw_instance_Id为空时,返回账号下第一个墙的信息;fw_instance_Id非空时,返回与fw_instance_Id对应墙的信息。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)

表4 请求Body参数

参数

是否必选

参数类型

描述

fw_instance_id

String

防火墙实例id,创建云防火墙后用于标志防火墙由系统自动生成的标志id,可通过调用查询防火墙实例接口获得。具体可参考APIExlorer和帮助中心FAQ。默认情况下,fw_instance_Id为空时,返回账号下第一个墙的信息;fw_instance_Id非空时,返回与fw_instance_Id对应墙的信息。

object_id

String

防护对象id,是创建云防火墙后用于区分互联网边界防护和VPC边界防护的标志id,可通过调用查询防火墙实例接口获得,注意type为0的为互联网边界防护对象id,type为1的为VPC边界防护对象id。具体可参考APIExlorer和帮助中心FAQ。

domain_names

Array of DomainSetInfoDto objects

域名列表

表5 DomainSetInfoDto

参数

是否必选

参数类型

描述

domain_name

String

域名

description

String

描述

响应参数

状态码: 200

表6 响应Body参数

参数

参数类型

描述

data

DomainSetResponseData object

域名组返回值数据

表7 DomainSetResponseData

参数

参数类型

描述

id

String

域名组id

name

String

域名组名称

请求示例

给项目id为14181c1245cf4fd786824efe1e2b9388下的域名组添加域名,防火墙id为546af3f8-88e9-47f2-a205-2346d7090925,防护对象id为ae42418e-f077-41a0-9d3b-5b2f5ad9102b,域名组id为78719348-6d79-477e-acec-676a29842ab2,域名为www.bnm.com和www.vbc.com

https://{Endpoint}v1/14181c1245cf4fd786824efe1e2b9388/domain-set/domains/78719348-6d79-477e-acec-676a29842ab2?fw_instance_id=546af3f8-88e9-47f2-a205-2346d7090925&enterprise_project_id=default

{
  "domain_names" : [ {
    "description" : "",
    "domain_name" : "www.bnm.com"
  }, {
    "description" : "",
    "domain_name" : "www.vbc.com"
  } ],
  "fw_instance_id" : "546af3f8-88e9-47f2-a205-2346d7090925",
  "object_id" : "ae42418e-f077-41a0-9d3b-5b2f5ad9102b"
}

响应示例

状态码: 200

添加域名返回值

{
  "data" : {
    "id" : "78719348-6d79-477e-acec-676a29842ab2",
    "name" : "test26"
  }
}

SDK代码示例

SDK代码示例如下。

Java

给项目id为14181c1245cf4fd786824efe1e2b9388下的域名组添加域名,防火墙id为546af3f8-88e9-47f2-a205-2346d7090925,防护对象id为ae42418e-f077-41a0-9d3b-5b2f5ad9102b,域名组id为78719348-6d79-477e-acec-676a29842ab2,域名为www.bnm.com和www.vbc.com

 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
64
65
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 AddDomainsSolution {

    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();
        AddDomainsRequest request = new AddDomainsRequest();
        request.withEnterpriseProjectId("<enterprise_project_id>");
        request.withFwInstanceId("<fw_instance_id>");
        AddDomainListDto body = new AddDomainListDto();
        List<DomainSetInfoDto> listbodyDomainNames = new ArrayList<>();
        listbodyDomainNames.add(
            new DomainSetInfoDto()
                .withDomainName("www.bnm.com")
                .withDescription("")
        );
        listbodyDomainNames.add(
            new DomainSetInfoDto()
                .withDomainName("www.vbc.com")
                .withDescription("")
        );
        body.withDomainNames(listbodyDomainNames);
        body.withObjectId("ae42418e-f077-41a0-9d3b-5b2f5ad9102b");
        body.withFwInstanceId("546af3f8-88e9-47f2-a205-2346d7090925");
        request.withBody(body);
        try {
            AddDomainsResponse response = client.addDomains(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为14181c1245cf4fd786824efe1e2b9388下的域名组添加域名,防火墙id为546af3f8-88e9-47f2-a205-2346d7090925,防护对象id为ae42418e-f077-41a0-9d3b-5b2f5ad9102b,域名组id为78719348-6d79-477e-acec-676a29842ab2,域名为www.bnm.com和www.vbc.com

 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
# 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 = AddDomainsRequest()
        request.enterprise_project_id = "<enterprise_project_id>"
        request.fw_instance_id = "<fw_instance_id>"
        listDomainNamesbody = [
            DomainSetInfoDto(
                domain_name="www.bnm.com",
                description=""
            ),
            DomainSetInfoDto(
                domain_name="www.vbc.com",
                description=""
            )
        ]
        request.body = AddDomainListDto(
            domain_names=listDomainNamesbody,
            object_id="ae42418e-f077-41a0-9d3b-5b2f5ad9102b",
            fw_instance_id="546af3f8-88e9-47f2-a205-2346d7090925"
        )
        response = client.add_domains(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为14181c1245cf4fd786824efe1e2b9388下的域名组添加域名,防火墙id为546af3f8-88e9-47f2-a205-2346d7090925,防护对象id为ae42418e-f077-41a0-9d3b-5b2f5ad9102b,域名组id为78719348-6d79-477e-acec-676a29842ab2,域名为www.bnm.com和www.vbc.com

 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
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.AddDomainsRequest{}
	enterpriseProjectIdRequest:= "<enterprise_project_id>"
	request.EnterpriseProjectId = &enterpriseProjectIdRequest
	fwInstanceIdRequest:= "<fw_instance_id>"
	request.FwInstanceId = &fwInstanceIdRequest
	domainNameDomainNames:= "www.bnm.com"
	descriptionDomainNames:= ""
	domainNameDomainNames1:= "www.vbc.com"
	descriptionDomainNames1:= ""
	var listDomainNamesbody = []model.DomainSetInfoDto{
        {
            DomainName: &domainNameDomainNames,
            Description: &descriptionDomainNames,
        },
        {
            DomainName: &domainNameDomainNames1,
            Description: &descriptionDomainNames1,
        },
    }
	request.Body = &model.AddDomainListDto{
		DomainNames: listDomainNamesbody,
		ObjectId: "ae42418e-f077-41a0-9d3b-5b2f5ad9102b",
		FwInstanceId: "546af3f8-88e9-47f2-a205-2346d7090925",
	}
	response, err := client.AddDomains(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

更多

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

状态码

状态码

描述

200

添加域名返回值

错误码

请参见错误码

分享:

    相关文档

    相关产品