更新时间:2024-11-08 GMT+08:00

按企业项目迁移防护域名

功能介绍

按企业项目迁移防护域名,仅专业版与独享版支持该功能

调用方法

请参见如何调用API

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID,对应控制台用户名->我的凭证->项目列表->项目ID

表2 Query参数

参数

是否必选

参数类型

描述

enterprise_project_id

String

当前企业项目ID

target_enterprise_project_id

String

迁移的目标企业项目ID

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

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

Content-Type

String

内容类型

表4 请求Body参数

参数

是否必选

参数类型

描述

host_ids

Array of strings

host_id列表

policy_id

String

策略ID(目标企业项目下的策略ID)

certificate_id

String

证书ID(目标企业项目下的证书ID)

响应参数

状态码: 200

表5 响应Body参数

参数

参数类型

描述

host_ids

Array of strings

host_id列表

policy_id

String

策略ID(目标企业项目下的策略ID)

certificate_id

String

证书ID(目标企业项目下的证书ID)

状态码: 400

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误信息

encoded_authorization_message

String

编码 (加密) 后的详细拒绝原因,用户可以自行调用 STS 服务的decode-authorization-message接口进行解码,可参考STS5联调自验证。IAM5鉴权错误时才会返回此字段。

details

Array of IAM5ErrorDetails objects

调用下游服务的报错信息集合,IAM5鉴权错误时才会返回此字段。

表7 IAM5ErrorDetails

参数

参数类型

描述

error_code

String

下游服务错误码

error_msg

String

下游服务报错信息

状态码: 401

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误信息

encoded_authorization_message

String

编码 (加密) 后的详细拒绝原因,用户可以自行调用 STS 服务的decode-authorization-message接口进行解码,可参考STS5联调自验证。IAM5鉴权错误时才会返回此字段。

details

Array of IAM5ErrorDetails objects

调用下游服务的报错信息集合,IAM5鉴权错误时才会返回此字段。

表9 IAM5ErrorDetails

参数

参数类型

描述

error_code

String

下游服务错误码

error_msg

String

下游服务报错信息

状态码: 500

表10 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误信息

encoded_authorization_message

String

编码 (加密) 后的详细拒绝原因,用户可以自行调用 STS 服务的decode-authorization-message接口进行解码,可参考STS5联调自验证。IAM5鉴权错误时才会返回此字段。

details

Array of IAM5ErrorDetails objects

调用下游服务的报错信息集合,IAM5鉴权错误时才会返回此字段。

表11 IAM5ErrorDetails

参数

参数类型

描述

error_code

String

下游服务错误码

error_msg

String

下游服务报错信息

请求示例

将项目id为project_id的项目下的域名id为“6cc26af071de46479840b41c143bb79b”的域名和防护策略id为“b97ce5d4e38d4eaf94d65be7372974a8”的防护策略从企业id为0的企业,迁移到企业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"
}

响应示例

状态码: 200

请求成功

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

SDK代码示例

SDK代码示例如下。

将项目id为project_id的项目下的域名id为“6cc26af071de46479840b41c143bb79b”的域名和防护策略id为“b97ce5d4e38d4eaf94d65be7372974a8”的防护策略从企业id为0的企业,迁移到企业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());
        }
    }
}

将项目id为project_id的项目下的域名id为“6cc26af071de46479840b41c143bb79b”的域名和防护策略id为“b97ce5d4e38d4eaf94d65be7372974a8”的防护策略从企业id为0的企业,迁移到企业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)

将项目id为project_id的项目下的域名id为“6cc26af071de46479840b41c143bb79b”的域名和防护策略id为“b97ce5d4e38d4eaf94d65be7372974a8”的防护策略从企业id为0的企业,迁移到企业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)
    }
}

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

状态码

状态码

描述

200

请求成功

400

请求失败

401

token权限不足

500

服务器内部错误

错误码

请参见错误码