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

部署策略组

功能介绍

为已经开启旗舰版或容器版防护的服务器部署策略组

调用方法

请参见如何调用API

URI

POST /v5/{project_id}/policy/deploy

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释:

项目ID,用于明确项目归属,配置后可通过该ID查询项目下资产。获取方式请参见获取项目ID

约束限制:

不涉及

取值范围:

字符长度1-256位

默认取值:

不涉及

表2 Query参数

参数

是否必选

参数类型

描述

enterprise_project_id

String

参数解释:

企业项目ID,用于过滤不同企业项目下的资产。获取方式请参见获取企业项目ID

如需查询所有企业项目下的资产请传参“all_granted_eps”。

约束限制:

开通企业项目功能后才需要配置企业项目ID参数。

取值范围:

字符长度1-256位

默认取值:

0,表示默认企业项目(default)。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

用户Token,包含了用户的身份、权限等信息,在调用API接口时,可通过Token进行身份认证。获取方式请参见获取用户Token

约束限制:

不涉及

取值范围:

字符长度1-32768位

默认取值:

不涉及

region

String

参数解释:

区域ID,用于查询目的区域内的资产。获取方式请参见获取区域ID

约束限制:

不涉及

取值范围:

字符长度1-128位

默认取值:

不涉及

表4 请求Body参数

参数

是否必选

参数类型

描述

target_policy_group_id

String

参数解释:

部署的目标策略组ID

约束限制:

需查询ListPolicyGroup接口,仅支持传其返回参数data_list中support_version等于hss.version.premium或hss.version.container.enterprise的group_id

取值范围:

只能由英文字母、数字及“-”组成,字符长度36-64位

默认取值:

不涉及

operate_all

Boolean

参数解释:

是否要对全量主机/pod实例/工作负载/集群部署策略,如果为true的话,会自动筛选符合策略组支持版本和操作系统版本的全量主机/pod实例/工作负载/集群部署策略,不需填写host_id_list,如果为false的话,需要填写host_id_list

约束限制:

不涉及

取值范围:

  • true: 自动筛选符合策略组支持版本和操作系统版本的全量主机/pod实例/工作负载/集群部署策略,不需填写host_id_list。

  • false: 非全量部署,仅对指定的主机/pod实例/工作负载/集群部署策略,需要填写host_id_list。

默认取值:

不涉及

deploy_type

String

参数解释:

需要部署策略组的实例类型(预留字段)

约束限制:

不涉及

取值范围:

  • host: 主机。

  • pod: pod实例。

  • workload: 工作负载。

  • cluster: 集群。

默认取值:

host

host_id_list

Array of strings

参数解释:

需要部署策略组的已开启旗舰版或容器版防护的主机/pod实例/负载/集群ID列表

约束限制:

需查询ListHostStatus接口,仅支持传其返回参数data_list中version等于hss.version.premium或hss.version.container.enterprise的host_id

取值范围:

最少0条,最多10000条

默认取值:

不涉及

响应参数

状态码:200

请求已成功

请求示例

部署服务器防护策略,目标服务器ID为15462c0e-32c6-4217-a869-bbd131a00ecf,目标策略组ID为1df671f7-2677-4705-a320-de1a62bff306。

POST https://{endpoint}/v5/{project_id}/policy/deploy

{
  "target_policy_group_id" : "1df671f7-2677-4705-a320-de1a62bff306",
  "host_id_list" : [ "15462c0e-32c6-4217-a869-bbd131a00ecf" ],
  "operate_all" : false
}

响应示例

SDK代码示例

SDK代码示例如下。

部署服务器防护策略,目标服务器ID为15462c0e-32c6-4217-a869-bbd131a00ecf,目标策略组ID为1df671f7-2677-4705-a320-de1a62bff306。

 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
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.hss.v5.region.HssRegion;
import com.huaweicloud.sdk.hss.v5.*;
import com.huaweicloud.sdk.hss.v5.model.*;

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

public class AssociatePolicyGroupSolution {

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

        HssClient client = HssClient.newBuilder()
                .withCredential(auth)
                .withRegion(HssRegion.valueOf("<YOUR REGION>"))
                .build();
        AssociatePolicyGroupRequest request = new AssociatePolicyGroupRequest();
        AssociatePolicyGroupRequestInfo body = new AssociatePolicyGroupRequestInfo();
        List<String> listbodyHostIdList = new ArrayList<>();
        listbodyHostIdList.add("15462c0e-32c6-4217-a869-bbd131a00ecf");
        body.withHostIdList(listbodyHostIdList);
        body.withOperateAll(false);
        body.withTargetPolicyGroupId("1df671f7-2677-4705-a320-de1a62bff306");
        request.withBody(body);
        try {
            AssociatePolicyGroupResponse response = client.associatePolicyGroup(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为15462c0e-32c6-4217-a869-bbd131a00ecf,目标策略组ID为1df671f7-2677-4705-a320-de1a62bff306。

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

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkhss.v5.region.hss_region import HssRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkhss.v5 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 = HssClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(HssRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = AssociatePolicyGroupRequest()
        listHostIdListbody = [
            "15462c0e-32c6-4217-a869-bbd131a00ecf"
        ]
        request.body = AssociatePolicyGroupRequestInfo(
            host_id_list=listHostIdListbody,
            operate_all=False,
            target_policy_group_id="1df671f7-2677-4705-a320-de1a62bff306"
        )
        response = client.associate_policy_group(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为15462c0e-32c6-4217-a869-bbd131a00ecf,目标策略组ID为1df671f7-2677-4705-a320-de1a62bff306。

 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 main

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

    request := &model.AssociatePolicyGroupRequest{}
	var listHostIdListbody = []string{
        "15462c0e-32c6-4217-a869-bbd131a00ecf",
    }
	operateAllAssociatePolicyGroupRequestInfo:= false
	request.Body = &model.AssociatePolicyGroupRequestInfo{
		HostIdList: &listHostIdListbody,
		OperateAll: &operateAllAssociatePolicyGroupRequestInfo,
		TargetPolicyGroupId: "1df671f7-2677-4705-a320-de1a62bff306",
	}
	response, err := client.AssociatePolicyGroup(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

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

状态码

状态码

描述

200

请求已成功

错误码

请参见错误码

相关文档