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" : "cn-north-7",
        "defense_connection_name" : "VPC authentication token.",
        "defense_type" : "VPC",
        "defense_policy_list" : null,
        "target_enterprise_id" : "0",
        "defense_connection_region_id" : "cn-north-7",
        "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" : "cn-north-7",
        "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" : "cn-north-7",
      "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" : "cn-north-7",
        "region_name" : "cn-north-7",
        "project_name" : "cn-north-7",
        "vendor_type" : "Cloud"
      },
      "policy_type" : {
        "policy_type" : "Source Ip",
        "id" : "4d67fe756fcefbf60337e5c8debdff6d",
        "category" : "Blocking 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
}