Updated on 2026-01-06 GMT+08:00

Viewing Domain Name Configurations

Function

This API is used to view the domain name configuration.

Calling Method

For details, see Calling APIs.

URI

GET /v2/aad/domains/{domain_id}/config

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

domain_id

Yes

String

Domain name ID.

Table 2 Query Parameters

Parameter

Mandatory

Type

Description

type

Yes

String

Request type: domain and waf

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

token

Content-Type

Yes

String

Content-Type

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

domain_id

String

Domain name ID.

domain_name

String

Domain name

real_server_type

Integer

Origin server type. 0: IP address of the origin server; 1: domain name of the origin server

port_http

Array of integers

HTTP port. This parameter and port_https cannot be both empty. You can view the HTTP ports supported by AAD on the console.

port_https

Array of integers

HTTPS port. This parameter and port_http cannot be both empty. You can view the HTTPS ports supported by AAD on the console.

real_server

String

Origin server IP address or domain name.

pp_enable

Integer

Whether to enable the pp. The options are 1 (yes) and 0 (no).

overseas_type

Integer

Protection region. 0: regions in the Chinese mainland. 1: regions outside the Chinese mainland.

tls

String

TLS (when the request parameter type is set to waf)

cipher

String

Cipher suite (when the request parameter type is set to waf)

http2_enable

Boolean

Whether HTTP/2 is allowed (when the request parameter type is set to waf)

header_map

Object

Field forwarding (when the request parameter type is set to waf)

Status code: 400

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_description

String

Error description.

Example Requests

None

Example Responses

None

SDK Sample Code

The SDK sample code is as follows.

 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
package com.huaweicloud.sdk.test;

import com.huaweicloud.sdk.core.auth.ICredential;
import com.huaweicloud.sdk.core.auth.GlobalCredentials;
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.aad.v2.region.AadRegion;
import com.huaweicloud.sdk.aad.v2.*;
import com.huaweicloud.sdk.aad.v2.model.*;


public class ShowDomainNameConfigSolution {

    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 GlobalCredentials()
                .withAk(ak)
                .withSk(sk);

        AadClient client = AadClient.newBuilder()
                .withCredential(auth)
                .withRegion(AadRegion.valueOf("<YOUR REGION>"))
                .build();
        ShowDomainNameConfigRequest request = new ShowDomainNameConfigRequest();
        request.withDomainId("{domain_id}");
        try {
            ShowDomainNameConfigResponse response = client.showDomainNameConfig(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
# coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import GlobalCredentials
from huaweicloudsdkaad.v2.region.aad_region import AadRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkaad.v2 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"]

    credentials = GlobalCredentials(ak, sk)

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

    try:
        request = ShowDomainNameConfigRequest()
        request.domain_id = "{domain_id}"
        response = client.show_domain_name_config(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
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/global"
    aad "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/aad/v2"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/aad/v2/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/aad/v2/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 := global.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        Build()

    client := aad.NewAadClient(
        aad.AadClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.ShowDomainNameConfigRequest{}
	request.DomainId = "{domain_id}"
	response, err := client.ShowDomainNameConfig(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

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

Protected domain name information.

400

Error response

Error Codes

See Error Codes.