查询策略组列表
功能介绍
查询策略组列表
调用方法
请参见如何调用API。
URI
GET /v5/{project_id}/policy/groups
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
项目ID 最小长度:1 最大长度:256 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
enterprise_project_id |
否 |
String |
企业项目ID,查询所有企业项目时填写:all_granted_eps 缺省值:0 最小长度:1 最大长度:256 |
group_name |
否 |
String |
策略组名 最小长度:1 最大长度:256 |
offset |
否 |
Integer |
偏移量:指定返回记录的开始位置 最小值:0 最大值:100000 缺省值:0 |
limit |
否 |
Integer |
每页显示个数 最小值:10 最大值:200 缺省值:10 |
container_mode |
否 |
Boolean |
是否查询容器版策略 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值) 最小长度:1 最大长度:32768 |
region |
是 |
String |
Region ID 最小长度:0 最大长度:128 |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
total_num |
Integer |
总数 |
data_list |
Array of PolicyGroupResponseInfo objects |
策略组列表 数组长度:0 - 100 |
参数 |
参数类型 |
描述 |
---|---|---|
group_name |
String |
策略组名 |
group_id |
String |
策略组ID |
description |
String |
策略组的描述信息 最小长度:1 最大长度:64 |
deletable |
Boolean |
是否允许删除该策略组 |
host_num |
Integer |
关联服务器数 |
default_group |
Boolean |
是否是默认策略组 |
support_os |
String |
支持的操作系统,包含如下:
|
support_version |
String |
支持的版本,包含如下:
|
请求示例
查询所有企业项目下的策略组列表。
GET https://{endpoint}/v5/{project_id}/policy/groups?offset=0&limit=100&enterprise_project_id=all_granted_eps
响应示例
状态码: 200
策略组列表
{ "data_list" : [ { "default_group" : true, "deletable" : false, "description" : "container policy group for linux", "group_id" : "c831f177-226d-4b91-be0f-bcf98d04ef5d", "group_name" : "tenant_linux_container_default_policy_group ", "host_num" : 0, "support_version" : "hss.version.container.enterprise", "support_os" : "Linux" }, { "default_group" : true, "deletable" : false, "description" : "enterprise policy group for windows", "group_id" : "1ff54b90-1b3e-42a9-a1da-9883a83385ce", "group_name" : "tenant_windows_enterprise_default_policy_group ", "host_num" : 0, "support_version" : "hss.version.enterprise", "support_os" : "Windows" }, { "default_group" : true, "deletable" : false, "description" : "enterprise policy group for linux", "group_id" : "1069bcc0-c806-4ccd-a35d-f1f7456805e9", "group_name" : "tenant_linux_enterprise_default_policy_group ", "host_num" : 1, "support_version" : "hss.version.enterprise", "support_os" : "Linux" }, { "default_group" : true, "deletable" : false, "description" : "premium policy group for windows", "group_id" : "11216d24-9e91-4a05-9212-c4c1d646ee79", "group_name" : "tenant_windows_premium_default_policy_group ", "host_num" : 0, "support_version" : "hss.version.premium", "support_os" : "Linux" }, { "default_group" : true, "deletable" : false, "description" : "premium policy group for linux", "group_id" : "e6e1228a-7bb4-424f-a42b-755162234da7", "group_name" : "tenant_linux_premium_default_policy_group ", "host_num" : 0, "support_version" : "hss.version.premium", "support_os" : "Windows" } ], "total_num" : 5 }
SDK代码示例
SDK代码示例如下。
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 |
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.*; public class ListPolicyGroupSolution { 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 BasicCredentials() .withAk(ak) .withSk(sk); HssClient client = HssClient.newBuilder() .withCredential(auth) .withRegion(HssRegion.valueOf("<YOUR REGION>")) .build(); ListPolicyGroupRequest request = new ListPolicyGroupRequest(); request.withEnterpriseProjectId("<enterprise_project_id>"); request.withGroupName("<group_name>"); request.withOffset(<offset>); request.withLimit(<limit>); request.withContainerMode(<container_mode>); try { ListPolicyGroupResponse response = client.listPolicyGroup(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 |
# 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"] credentials = BasicCredentials(ak, sk) client = HssClient.new_builder() \ .with_credentials(credentials) \ .with_region(HssRegion.value_of("<YOUR REGION>")) \ .build() try: request = ListPolicyGroupRequest() request.enterprise_project_id = "<enterprise_project_id>" request.group_name = "<group_name>" request.offset = <offset> request.limit = <limit> request.container_mode = <ContainerMode> response = client.list_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) |
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 |
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") auth := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). Build() client := hss.NewHssClient( hss.HssClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.ListPolicyGroupRequest{} enterpriseProjectIdRequest:= "<enterprise_project_id>" request.EnterpriseProjectId = &enterpriseProjectIdRequest groupNameRequest:= "<group_name>" request.GroupName = &groupNameRequest offsetRequest:= int32(<offset>) request.Offset = &offsetRequest limitRequest:= int32(<limit>) request.Limit = &limitRequest containerModeRequest:= <container_mode> request.ContainerMode = &containerModeRequest response, err := client.ListPolicyGroup(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
状态码 |
描述 |
---|---|
200 |
策略组列表 |
错误码
请参见错误码。