Querying the Policy Group List
Function
This API is used to query the policy group list.
Calling Method
For details, see Calling APIs.
URI
GET /v5/{project_id}/policy/groups
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Project ID Minimum: 1 Maximum: 256 |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
enterprise_project_id |
No |
String |
Enterprise project ID. To query all enterprise projects, set this parameter to all_granted_eps. Default: 0 Minimum: 1 Maximum: 256 |
group_name |
No |
String |
Policy group name Minimum: 1 Maximum: 256 |
offset |
No |
Integer |
Offset, which specifies the start position of the record to be returned. Minimum: 0 Maximum: 100000 Default: 0 |
limit |
No |
Integer |
Number of records displayed on each page. Minimum: 10 Maximum: 200 Default: 10 |
container_mode |
No |
Boolean |
Whether to query the container edition policy. |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
Yes |
String |
User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is a token. Minimum: 1 Maximum: 32768 |
region |
Yes |
String |
Region ID Minimum: 0 Maximum: 128 |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
total_num |
Integer |
Total number |
data_list |
Array of PolicyGroupResponseInfo objects |
Policy group list Array Length: 0 - 100 |
Parameter |
Type |
Description |
---|---|---|
group_name |
String |
Policy group name |
group_id |
String |
Policy group ID |
description |
String |
Description of the policy group Minimum: 1 Maximum: 64 |
deletable |
Boolean |
Whether a policy group can be deleted |
host_num |
Integer |
Number of associated servers |
default_group |
Boolean |
Whether a policy group is the default policy group |
support_os |
String |
Supported OS. The options are as follows:
|
support_version |
String |
Supported versions. The options are as follows:
|
Example Requests
Query the policy group list of all enterprise projects.
GET https://{endpoint}/v5/{project_id}/policy/groups?offset=0&limit=100&enterprise_project_id=all_granted_eps
Example Responses
Status code: 200
Policy group list
{ "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 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 |
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) } } |
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 |
Policy group list |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot