更新时间:2025-06-30 GMT+08:00
分享

查看域名组详情

功能介绍

查看域名组详情

调用方法

请参见如何调用API

URI

GET /v1/{project_id}/domain-set/{domain_set_id}

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释

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

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

domain_set_id

String

参数解释

域名组ID,可通过查询域名组列表接口查询获得,通过返回值中的data.records.set_id(.表示各对象之间层级的区分)获取

约束限制

URL域名组无法解析

取值范围

不涉及

默认取值

不涉及

表2 Query参数

参数

是否必选

参数类型

描述

fw_instance_id

String

参数解释

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

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

enterprise_project_id

String

参数解释

企业项目ID,用户根据组织规划企业项目,对应的ID为企业项目ID,配置后可根据企业项目过滤不同企业项目下的资产,可通过如何获取企业项目ID获取

约束限制

不涉及

取值范围

不涉及

默认取值

0

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释

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

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

data

DomainSetVo object

参数解释

域名组详细信息

取值范围

不涉及

表5 DomainSetVo

参数

参数类型

描述

set_id

String

参数解释

域名组id

取值范围

不涉及

name

String

参数解释

域名组名称

取值范围

不涉及

description

String

参数解释

域名组描述

取值范围

不涉及

ref_count

Integer

参数解释

域名组被规则引用次数

取值范围

不涉及

domain_set_type

Integer

参数解释

域名组类型

取值范围

  • 0:应用域名组

  • 1:网络域名组

config_status

Integer

参数解释

配置状态

取值范围

  • -1:未配置态

  • 0:配置失败

  • 1:配置成功

  • 2:配置中

  • 3:正常

  • 4:配置异常

rules

Array of UseRuleVO objects

参数解释

使用规则id列表

取值范围

不涉及

表6 UseRuleVO

参数

参数类型

描述

id

String

规则ID

name

String

规则名称

请求示例

查询域名组id为7891eb51-009a-4e4e-ab15-e4290d9360b2的详细信息,防火墙ID为fced7179-64a4-4438-bc6d-b510a2da2f64,项目id为408972e72dcd4c1a9b033e955802a36b

https://{Endpoint}/v1/408972e72dcd4c1a9b033e955802a36b/domain-set/7891eb51-009a-4e4e-ab15-e4290d9360b2?fw_instance_id=fced7179-64a4-4438-bc6d-b510a2da2f64

响应示例

状态码:200

OK,域名组详细信息响应值

{
  "data" : {
    "config_status" : 3,
    "domain_set_type" : 0,
    "name" : "应用组2",
    "set_id" : "7891eb51-009a-4e4e-ab15-e4290d9360b2"
  }
}

SDK代码示例

SDK代码示例如下。

 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
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.*;


public class ShowDomainSetDetailSolution {

    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();
        ShowDomainSetDetailRequest request = new ShowDomainSetDetailRequest();
        request.withDomainSetId("{domain_set_id}");
        try {
            ShowDomainSetDetailResponse response = client.showDomainSetDetail(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());
        }
    }
}
 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
# 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 = ShowDomainSetDetailRequest()
        request.domain_set_id = "{domain_set_id}"
        response = client.show_domain_set_detail(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)
 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
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.ShowDomainSetDetailRequest{}
	request.DomainSetId = "{domain_set_id}"
	response, err := client.ShowDomainSetDetail(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

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

状态码

状态码

描述

200

OK,域名组详细信息响应值

401

Unauthorized,错误的请求

403

Forbidden,禁止访问

404

Not Found,网页未找到

错误码

请参见错误码

相关文档