Help Center/ Web Application Firewall/ API Reference/ APIs/ Domain Name Management/ Migrating Protected Domain Names by Enterprise Project
Updated on 2024-07-02 GMT+08:00

Migrating Protected Domain Names by Enterprise Project

Function

This API is used to migrate a WAF instance along with domain names it protects from the current enterprise project to another. Only the professional and platinum editions support this function.

Calling Method

For details, see Calling APIs.

URI

POST /v1/{project_id}/composite-waf/hosts/migration

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID. To obtain it, go to Huawei Cloud management console and hover the cursor over your username. On the displayed window, choose My Credentials. Then, in the Projects area, view Project ID of the corresponding project.

Table 2 Query Parameters

Parameter

Mandatory

Type

Description

enterprise_project_id

Yes

String

ID of the source enterprise project

target_enterprise_project_id

Yes

String

ID of the destination enterprise project

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token. It can be obtained by calling the IAM API (value of X-Subject-Token in the response header).

Content-Type

Yes

String

Content type.

Table 4 Request body parameters

Parameter

Mandatory

Type

Description

host_ids

Yes

Array of strings

Host ID list.

policy_id

Yes

String

ID of the rule in the current enterprise project.

certificate_id

No

String

Certificate ID (certificate ID in the current enterprise project).

Response Parameters

Status code: 200

Table 5 Response body parameters

Parameter

Type

Description

host_ids

Array of strings

Host ID list.

policy_id

String

ID of the rule in the current enterprise project.

certificate_id

String

Certificate ID (certificate ID in the current enterprise project).

Status code: 400

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 401

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 500

Table 8 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Example Requests

The following example shows how to migrate a domain name along with protection policy used for the domain name in a project from an enterprise project to another. Domain name ID: 6cc26af071de46479840b41c143bb79b. Protection policy ID: b97ce5d4e38d4eaf94d65be7372974a8. Project ID: project_id. Source enterprise project ID: 0. Destination enterprise project ID: c341b6bd-0935-462b-abb5-28a63bd68021

POST https://{Endpoint}/v1/{project_id}/composite-waf/hosts/migration?enterprise_project_id=0&target_enterprise_project_id=c341b6bd-0935-462b-abb5-28a63bd68021

{
  "host_ids" : [ "6cc26af071de46479840b41c143bb79b" ],
  "policy_id" : "b97ce5d4e38d4eaf94d65be7372974a8"
}

Example Responses

Status code: 200

Request succeeded.

{
  "host_ids" : [ "6cc26af071de46479840b41c143bb79b" ],
  "policy_id" : "b97ce5d4e38d4eaf94d65be7372974a8"
}

SDK Sample Code

The SDK sample code is as follows.

The following example shows how to migrate a domain name along with protection policy used for the domain name in a project from an enterprise project to another. Domain name ID: 6cc26af071de46479840b41c143bb79b. Protection policy ID: b97ce5d4e38d4eaf94d65be7372974a8. Project ID: project_id. Source enterprise project ID: 0. Destination enterprise project ID: c341b6bd-0935-462b-abb5-28a63bd68021

 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
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.waf.v1.region.WafRegion;
import com.huaweicloud.sdk.waf.v1.*;
import com.huaweicloud.sdk.waf.v1.model.*;

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

public class MigrateCompositeHostsSolution {

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

        WafClient client = WafClient.newBuilder()
                .withCredential(auth)
                .withRegion(WafRegion.valueOf("<YOUR REGION>"))
                .build();
        MigrateCompositeHostsRequest request = new MigrateCompositeHostsRequest();
        MigrateCompositeHostsRequestBody body = new MigrateCompositeHostsRequestBody();
        List<String> listbodyHostIds = new ArrayList<>();
        listbodyHostIds.add("6cc26af071de46479840b41c143bb79b");
        body.withPolicyId("b97ce5d4e38d4eaf94d65be7372974a8");
        body.withHostIds(listbodyHostIds);
        request.withBody(body);
        try {
            MigrateCompositeHostsResponse response = client.migrateCompositeHosts(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());
        }
    }
}

The following example shows how to migrate a domain name along with protection policy used for the domain name in a project from an enterprise project to another. Domain name ID: 6cc26af071de46479840b41c143bb79b. Protection policy ID: b97ce5d4e38d4eaf94d65be7372974a8. Project ID: project_id. Source enterprise project ID: 0. Destination enterprise project ID: c341b6bd-0935-462b-abb5-28a63bd68021

 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
# coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkwaf.v1.region.waf_region import WafRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkwaf.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 = WafClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(WafRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = MigrateCompositeHostsRequest()
        listHostIdsbody = [
            "6cc26af071de46479840b41c143bb79b"
        ]
        request.body = MigrateCompositeHostsRequestBody(
            policy_id="b97ce5d4e38d4eaf94d65be7372974a8",
            host_ids=listHostIdsbody
        )
        response = client.migrate_composite_hosts(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

The following example shows how to migrate a domain name along with protection policy used for the domain name in a project from an enterprise project to another. Domain name ID: 6cc26af071de46479840b41c143bb79b. Protection policy ID: b97ce5d4e38d4eaf94d65be7372974a8. Project ID: project_id. Source enterprise project ID: 0. Destination enterprise project ID: c341b6bd-0935-462b-abb5-28a63bd68021

 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
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    waf "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/waf/v1"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/waf/v1/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/waf/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 := waf.NewWafClient(
        waf.WafClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.MigrateCompositeHostsRequest{}
	var listHostIdsbody = []string{
        "6cc26af071de46479840b41c143bb79b",
    }
	request.Body = &model.MigrateCompositeHostsRequestBody{
		PolicyId: "b97ce5d4e38d4eaf94d65be7372974a8",
		HostIds: listHostIdsbody,
	}
	response, err := client.MigrateCompositeHosts(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

Request succeeded.

400

Request failed.

401

The token does not have required permissions.

500

Internal server error.

Error Codes

See Error Codes.