Updated on 2026-02-05 GMT+08:00

Querying Policy View Objects

Function

This API is used to query policy view objects.

Calling Method

For details, see Calling APIs.

URI

GET /v1/{project_id}/workspaces/{workspace_id}/soc/policys/{policy_id}

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition

Project ID, which is used to specify the project that a resource belongs to. You can query the resources of a project by project ID. You can obtain the project ID from the API or console. Obtaining the Project ID

Constraints

N/A

Range

N/A

Default Value

N/A

workspace_id

Yes

String

Definition

Workspace ID.

Constraints

N/A

Range

N/A

Default Value

N/A

policy_id

Yes

String

Definition

Policy ID.

Constraints

N/A

Range

N/A

Default Value

N/A

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Definition

User token. You can obtain it by calling the IAM API for obtaining a user token. The user token is the value of X-Subject-Token in the response header. Obtaining a User Token

Constraints

N/A

Range

N/A

Default Value

N/A

Content-Type

Yes

String

Definition

Content type.

  • application/json;charset=UTF-8: common API request type

Constraints

N/A

Range

  • application/json;charset=UTF-8

Default Value

N/A

X-Secmaster-Version

Yes

String

Service version, for example, 25.5.0.

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

code

String

Return code.

message

String

Returned information.

data

Object

Return data.

request_id

String

Request ID.

success

Boolean

Success status.

Status code: 400

Table 4 Response body parameters

Parameter

Type

Description

code

String

Definition

Error code.

Range

N/A

message

String

Definition

Error description.

Range

N/A

Example Requests

https://{endpoint}/v1/{project_id}/workspaces/{workspace_id}/soc/policys/41eb9024-1fa2-4e43-9721-e09ec426ce00

Example Responses

Status code: 200

Queried policy view objects.

{
  "code" : "00000000",
  "message" : "",
  "data" : {
    "aggs_data_objects" : [ ],
    "create_time" : "2025-12-04T14:58:50.256Z+0800",
    "data_object" : {
      "modifier_name" : "userName",
      "block_age" : {
        "is_block_ageing" : false,
        "block_ageing" : null
      },
      "description" : "",
      "policy_task_id" : "82516118-b0cc-42f4-98e0-8421dcd4cade",
      "domain_id" : "ac7438b990ef4a37b741004eb45e8bf4",
      "workspace_id" : "ea956472-44a9-47d6-808b-03b95d06f355",
      "domain_name" : "domainName",
      "update_time" : "2025-12-04T14:58:52.534Z+0800",
      "is_deleted" : false,
      "block_target" : "1.1.1.1",
      "project_id" : "15645222e8744afa985c93dab6341da6",
      "region_name" : null,
      "defense_policy_object" : {
        "target_project_name" : "regionId",
        "defense_connection_name" : "VPC",
        "defense_type" : "VPC",
        "defense_policy_list" : null,
        "target_enterprise_id" : "0",
        "defense_connection_region_id" : "regionId",
        "description" : null,
        "defense_policy_name" : "SecMaster_Group_IPv4_INGRESS_BLOCK0",
        "defense_modifier_name" : "userName",
        "defense_connection_id" : "9a9d7deb-c8e0-3adb-b9ac-14b2f0944798",
        "defense_id" : "6d26ccce-6232-4a25-9503-738f782c20dd",
        "defense_connection_region_name" : "regionId",
        "target_enterprise_name" : "default",
        "defense_update_time" : "2025-12-04T14:58:50.136+08:00",
        "dataobject_id" : null,
        "defense_block_status" : "SUCCESS",
        "target_project_id" : "15645222e8744afa985c93dab6341da6",
        "defense_modifier_id" : "b40b54b1f27a4224aa0c95ede5b5a46a",
        "defense_policy_id" : "6f4465f2-4cf7-4b3a-93ce-7de24bcece7d"
      },
      "id" : "3283560a-6282-4d5e-9d12-8e8655881f92",
      "policy_direction" : "INGRESS",
      "create_time" : "2025-12-04T14:58:50.256Z+0800",
      "region_id" : "regionId",
      "dataclass_id" : "fcd0d00a-18a2-39f8-854d-49e86f5c5b10",
      "policy_task_name" : "userName-VPC-20251204145850",
      "labels" : "",
      "environment" : {
        "domain_id" : "ac7438b990ef4a37b741004eb45e8bf4",
        "domain_name" : "domainName",
        "project_id" : "15645222e8744afa985c93dab6341da6",
        "region_id" : "regionId",
        "region_name" : "regionId",
        "project_name" : "regionId",
        "vendor_type" : "Cloud"
      },
      "policy_type" : {
        "policy_type" : "Source Ip",
        "id" : "4d67fe756fcefbf60337e5c8debdff6d",
        "category" : "defense direction"
      },
      "trigger_flag" : true,
      "policy_category" : "BLOCK",
      "creator_id" : "b40b54b1f27a4224aa0c95ede5b5a46a",
      "modifier_id" : "b40b54b1f27a4224aa0c95ede5b5a46a",
      "creator_name" : "userName"
    },
    "dataclass_ref" : {
      "id" : "fcd0d00a-18a2-39f8-854d-49e86f5c5b10",
      "name" : "Policy"
    },
    "format_version" : 0,
    "id" : "3283560a-6282-4d5e-9d12-8e8655881f92",
    "project_id" : "",
    "type" : null,
    "update_time" : "2025-12-04T14:58:52.534Z+0800",
    "version" : 0,
    "workspace_id" : ""
  },
  "request_id" : "",
  "success" : true
}

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
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.secmaster.v1.region.SecMasterRegion;
import com.huaweicloud.sdk.secmaster.v1.*;
import com.huaweicloud.sdk.secmaster.v1.model.*;


public class ShowPolicySolution {

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

        SecMasterClient client = SecMasterClient.newBuilder()
                .withCredential(auth)
                .withRegion(SecMasterRegion.valueOf("<YOUR REGION>"))
                .build();
        ShowPolicyRequest request = new ShowPolicyRequest();
        request.withWorkspaceId("{workspace_id}");
        request.withPolicyId("{policy_id}");
        try {
            ShowPolicyResponse response = client.showPolicy(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
# coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdksecmaster.v1.region.secmaster_region import SecMasterRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdksecmaster.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 = SecMasterClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(SecMasterRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = ShowPolicyRequest()
        request.workspace_id = "{workspace_id}"
        request.policy_id = "{policy_id}"
        response = client.show_policy(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
package main

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

    request := &model.ShowPolicyRequest{}
	request.WorkspaceId = "{workspace_id}"
	request.PolicyId = "{policy_id}"
	response, err := client.ShowPolicy(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

Queried policy view objects.

400

Response body for querying the policy view object.

Error Codes

See Error Codes.