Updated on 2024-05-30 GMT+08:00

Copying Domain Configuration

Function

This API is used to copy the domain configuration.

You can copy the configuration of a domain name to other domain names.

Calling Method

For details, see Calling APIs.

URI

POST /v1.0/cdn/configuration/domains/batch-copy

Request Parameters

Table 1 Request body parameters

Parameter

Mandatory

Type

Description

configs

Yes

BatchCopyConfigs object

Configuration of the source domain name.

Table 2 BatchCopyConfigs

Parameter

Mandatory

Type

Description

target_domain

Yes

String

List of target domain names, which are separated by commas (,). Up to 10 domain names are supported.

source_domain

Yes

String

Source domain name.

config_list

Yes

Array of strings

Configuration items to be copied. Multiple configuration items are separated by commas (,). The following configuration items can be copied:

  • originRequestHeader (origin request headers)

  • httpResponseHeader (HTTP headers)

  • cacheUrlParamsConfig (URL parameter filtering)

  • urlAuth (token authentication)

  • userAgentBlackAndWhiteList (User-Agent blacklist or whitelist)

  • ipv6Accelerate (IPv6)

  • rangeStatus (range requests)

  • cacheRules (cache rules)

  • followOrigin (origin cache control)

  • privateBucketRetrieval (private bucket access)

  • follow302Status (redirect from origin)

  • sources (origin server)

  • compress (smart compression)

  • referer (referer validation)

  • ipBlackAndWhiteList (IP address blacklist or whitelist)

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

result

Array of BatchCopyResultVo objects

Result of copying the configuration.

Table 4 BatchCopyResultVo

Parameter

Type

Description

reason

String

Failure cause. This parameter is unavailable when the response is successful.

status

String

Batch operation result.

domain_name

String

Domain name.

Status code: default

Table 5 Response body parameters

Parameter

Type

Description

error

error object

Error response body.

Table 6 error

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Example Requests

POST https://cdn.myhuaweicloud.com/v1.0/cdn/configuration/domains/batch-copy

{
  "configs" : {
    "target_domain" : "www.target1.com,www.target2.com",
    "source_domain" : "www.source.com",
    "config_list" : [ "ipv6Accelerate", "follow302Status", "sources" ]
  }
}

Example Responses

Status code: 200

Success.

{
  "result" : [ {
    "reason" : "This operation is not supported for the domain name in the current state.",
    "domain_name" : "www.target1.com",
    "status" : "fail"
  }, {
    "reason" : "This operation is not supported for the domain name in the current state.",
    "domain_name" : "www.target2.com",
    "status" : "fail"
  } ]
}

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
47
48
49
50
51
52
53
54
55
56
57
58
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.cdn.v2.region.CdnRegion;
import com.huaweicloud.sdk.cdn.v2.*;
import com.huaweicloud.sdk.cdn.v2.model.*;

import java.util.List;
import java.util.ArrayList;

public class BatchCopyDomainSolution {

    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);

        CdnClient client = CdnClient.newBuilder()
                .withCredential(auth)
                .withRegion(CdnRegion.valueOf("<YOUR REGION>"))
                .build();
        BatchCopyDomainRequest request = new BatchCopyDomainRequest();
        BatchCopyDRequestBody body = new BatchCopyDRequestBody();
        List<String> listConfigsConfigList = new ArrayList<>();
        listConfigsConfigList.add("ipv6Accelerate");
        listConfigsConfigList.add("follow302Status");
        listConfigsConfigList.add("sources");
        BatchCopyConfigs configsbody = new BatchCopyConfigs();
        configsbody.withTargetDomain("www.target1.com,www.target2.com")
            .withSourceDomain("www.source.com")
            .withConfigList(listConfigsConfigList);
        body.withConfigs(configsbody);
        request.withBody(body);
        try {
            BatchCopyDomainResponse response = client.batchCopyDomain(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
33
34
35
36
37
38
39
40
41
42
# coding: utf-8

from huaweicloudsdkcore.auth.credentials import GlobalCredentials
from huaweicloudsdkcdn.v2.region.cdn_region import CdnRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkcdn.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 = __import__('os').getenv("CLOUD_SDK_AK")
    sk = __import__('os').getenv("CLOUD_SDK_SK")

    credentials = GlobalCredentials(ak, sk) \

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

    try:
        request = BatchCopyDomainRequest()
        listConfigListConfigs = [
            "ipv6Accelerate",
            "follow302Status",
            "sources"
        ]
        configsbody = BatchCopyConfigs(
            target_domain="www.target1.com,www.target2.com",
            source_domain="www.source.com",
            config_list=listConfigListConfigs
        )
        request.body = BatchCopyDRequestBody(
            configs=configsbody
        )
        response = client.batch_copy_domain(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
39
40
41
42
43
44
45
46
47
48
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/global"
    cdn "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cdn/v2"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cdn/v2/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cdn/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 := cdn.NewCdnClient(
        cdn.CdnClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.BatchCopyDomainRequest{}
	var listConfigListConfigs = []string{
        "ipv6Accelerate",
	    "follow302Status",
	    "sources",
    }
	configsbody := &model.BatchCopyConfigs{
		TargetDomain: "www.target1.com,www.target2.com",
		SourceDomain: "www.source.com",
		ConfigList: listConfigListConfigs,
	}
	request.Body = &model.BatchCopyDRequestBody{
		Configs: configsbody,
	}
	response, err := client.BatchCopyDomain(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

Success.

default

Error response.

Error Codes

See Error Codes.