Viewing Details About a Specified Policies
Function
This API is used to view details about a specified policy.
Calling Method
For details, see Calling APIs.
URI
GET /v5/{project_id}/cluster-protect/policy/{policy_id}
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Definition Project ID, which is used to specify the project that an asset belongs to. After the project ID is configured, you can query assets in the project using the project ID. For details about how to obtain it, see Obtaining a Project ID. Constraints N/A Range The value can contain 1 to 256 characters. Default Value N/A |
policy_id |
Yes |
String |
Definition Policy ID. Constraints Mandatory. Range The value can contain 1 to 64 characters. Default Value N/A |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
enterprise_project_id |
No |
String |
Definition Enterprise project ID, which is used to filter assets in different enterprise projects. For details, see Obtaining an Enterprise Project ID. To query assets in all enterprise projects, set this parameter to all_granted_eps. Constraints You need to set this parameter only after the enterprise project function is enabled. Range The value can contain 1 to 256 characters. Default Value 0: default enterprise project. |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
Yes |
String |
Definition User token, which contains user identity and permissions. The token can be used for identity authentication when an API is called. For details about how to obtain the token, see Obtaining a User Token. Constraints N/A Range The value can contain 1 to 32,768 characters. Default Value N/A |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
total_num |
Integer |
Total |
x_auth_token |
String |
User token. |
project_id |
String |
Project ID |
enterprise_project_id |
String |
Enterprise ID. |
region |
String |
Region |
general_policy_num |
Integer |
Number of general policies |
malicious_image_policy_num |
Integer |
Number of malicious_image policies |
security_policy_num |
Integer |
Number of security_policy policies |
data_list |
Array of ClusterPolicyResponseInfo objects |
Cluster protection policy list |
Parameter |
Type |
Description |
---|---|---|
cluster_id |
String |
Cluster ID |
cluster_name |
String |
Cluster Name |
content |
Object |
Policy content |
deploy_content |
String |
deploy content |
parameters |
String |
Parameters |
policy_name |
String |
Policy name |
policy_id |
String |
Policy ID |
resources |
Array of Resources objects |
Resource |
template_id |
String |
Template ID |
template_name |
String |
Template name. |
template_type |
String |
Template type. |
description |
String |
Description |
update_time |
Integer |
Update time |
create_time |
Integer |
Creation time |
image_num |
Integer |
Number of protected images |
labels_num |
Integer |
Number of protection labels |
status |
String |
Status |
white_images |
Array of WhiteImageInfo objects |
Whitelisted image |
Example Requests
None
Example Responses
Status code: 200
Request succeeded.
{ "project_id" : "", "enterprise_project_id" : "0", "total_num" : 3, "data_list" : [ { "policy_id" : "042a0ffd-6883-4ea6-be28-9e20ff83cb10", "policy_name" : "Default template", "template_id" : "", "description" : "testK8s", "content" : { "enable_image_startup" : false, "policy_type" : "baselines", "severity" : 4, "risky_item" : [ "1.1", "1.10", "1.11", "1.12", "1.13", "1.14", "1.15", "1.16", "1.17", "1.2", "1.3", "1.4", "1.5", "1.6", "1.7", "1.8", "1.9" ], "action" : 0 }, "resources" : [ { "cluster_name" : "test-lby", "cluster_id" : "149dab20-2ebb-4925-8ca8-6bfd511a8f01", "namespaces" : [ "default", "openebs", "hss" ], "labels" : [ ], "images" : [ "anp-agent", "apptest", "busybox", "cce-install-agent", "cce-install-agent-aarch64", "cce-install-agent-x86_64", "centos", "centos-malwarefile-spring", "centos7", "centosnew" ] } ], "image_num" : 10, "labels_num" : 0, "cluster_id" : "149dab20-2ebb-4925-8ca8-6bfd511a8f01", "cluster_name" : "test-lby", "status" : "inuse", "white_images" : [ ] }, { "policy_id" : "23c4fe52-413f-4f5c-8717-e8e3545fb87a", "policy_name" : "hss-glz-test-01", "template_id" : "", "description" : "hss-glz-test-01", "content" : { "enable_image_startup" : false, "policy_type" : "baselines", "severity" : 7, "risky_item" : [ "1.1", "1.10", "1.11", "1.12", "1.13", "1.14", "1.15", "1.16", "1.17", "1.2", "1.3", "1.4", "1.5", "1.6", "1.7", "1.8", "1.9" ], "action" : 0 }, "resources" : [ { "cluster_name" : "hss-glz-2451", "cluster_id" : "1ff15c8b-2265-11ef-8338-0255ac1001b2", "namespaces" : [ "monitoring" ], "labels" : [ ], "images" : [ "centos7" ] } ], "image_num" : 1, "labels_num" : 0, "cluster_id" : "1ff15c8b-2265-11ef-8338-0255ac1001b2", "cluster_name" : "hss-glz-2451", "status" : "inuse", "white_images" : [ ] }, { "policy_id" : "2ee2614d-2f17-4889-8c59-1e9f3f38fadb", "policy_name" : "Default template", "template_id" : "", "description" : "teshw01", "content" : { "enable_image_startup" : false, "policy_type" : "malwares", "severity" : 4, "risky_item" : [ "malwares" ], "action" : 0 }, "resources" : [ { "cluster_name" : "showcase-private", "cluster_id" : "cc59fbaf-b837-4779-b574-b3ad6e45c392", "namespaces" : [ "k8sdemo", "hss", "default", "openebs" ], "labels" : [ ], "images" : [ "apptest", "busybox", "cce-install-agent", "cce-install-agent-aarch64", "cce-install-agent-x86_64", "centos", "centos-malwarefile-spring", "centos7", "centosnew", "cfgtest", "cgs-provider", "cgs-shield", "consul", "couchdb", "debian", "debian-test", "debian113test", "django", "dxn", "euler2sp2", "euleros", "euleros/test", "f-image-test-2", "gatekeeper-x86_64", "hce_arm", "hello-world", "hss-admission-controller", "hss-agent-install", "hss-opa-docker-authz", "hss-opa-docker-authz-linux", "hss-opa-docker-authz-linux-amd64", "hss-opa-docker-authz-linux-arm64", "imagescan-centos-release-test", "imagescan-deb-pkg-test", "imagescan-suse-release-test", "install-hss-agent", "java-debian10", "lib-roa", "log4j", "lzldockerfile", "lzldockerfle", "modelarts_outter_base_tensorflow_2_3", "mysql", "mysql-ljx", "nginx", "openeuler", "openeuler-x86_64", "openjdk", "pause-amd64", "performance_test", "poctest", "poctest2", "poctest3", "poctest4", "poctest5", "python-0920", "ssh-server", "tomcat", "ubuntu", "ubuntu-contain13", "vul-img-3", "vul-img-4", "vul-img-5", "webshell-ljx" ] } ], "image_num" : 64, "labels_num" : 0, "cluster_id" : "cc59fbaf-b837-4779-b574-b3ad6e45c392", "cluster_name" : "showcase-private", "status" : "inuse", "white_images" : [ ] } ] }
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 |
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 ListClusterProtectionPolicyDetailSolution { 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(); ListClusterProtectionPolicyDetailRequest request = new ListClusterProtectionPolicyDetailRequest(); request.withPolicyId("{policy_id}"); try { ListClusterProtectionPolicyDetailResponse response = client.listClusterProtectionPolicyDetail(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 |
# 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 = ListClusterProtectionPolicyDetailRequest() request.policy_id = "{policy_id}" response = client.list_cluster_protection_policy_detail(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 |
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.ListClusterProtectionPolicyDetailRequest{} request.PolicyId = "{policy_id}" response, err := client.ListClusterProtectionPolicyDetail(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. |
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