更新时间:2025-11-21 GMT+08:00
分享

查询策略视图对象 - ShowPolicy

功能介绍

查询策略视图对象

调用方法

请参见如何调用API

授权信息

账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限,具体权限要求请参见权限和授权项

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释:

项目ID,用于明确项目归属,配置后可通过该ID查询项目下资产,可以通过调用API获取,也可以从控制台获取。获取项目ID

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

workspace_id

String

参数解释:

工作空间id。

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

policy_id

String

参数解释:

策略id

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

用户Token,通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。获取用户Token

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

Content-Type

String

参数解释:

内容类型

  • application/json;charset=UTF-8 普通API请求的类型

约束限制:

不涉及

取值范围:

  • application/json;charset=UTF-8

默认取值:

不涉及

X-Secmaster-Version

String

服务版本,例如25.5.0

响应参数

状态码:200

表3 响应Body参数

参数

参数类型

描述

code

String

返回编码

message

String

返回信息

data

Array of strings

返回数据

request_id

String

请求ID

success

Boolean

成功状态

状态码:400

表4 响应Body参数

参数

参数类型

描述

code

String

参数解释:

错误码

取值范围:

不涉及

message

String

参数解释:

错误描述

取值范围:

不涉及

请求示例

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

响应示例

状态码:200

查询策略视图对象返回值

{
  "code" : "00000000",
  "message" : "",
  "data" : [ {
    "create_time" : null,
    "data_object" : {
      "policy_id" : "41eb9024-1fa2-4e43-9721-e09ec426ce00",
      "block_age" : {
        "is_block_ageing" : false,
        "block_ageing" : null
      },
      "description" : "",
      "policy_task_id" : "45aa650b-b32c-42ab-acf4-4d156420dff7",
      "domain_id" : "94aee09081c649cfa9eef5d25200ec50",
      "workspace_id" : "42713b38-d753-4365-8b4a-50d179e15747",
      "domain_name" : "test_domain_name",
      "update_time" : "2025-10-22T20:18:52.701Z+0800",
      "is_deleted" : false,
      "block_target" : "1.1.1.1",
      "project_id" : "3bb27e024693436da46b5f5aaf499060",
      "workflow_instance" : {
        "workflow_instance_id" : "1eee9e32-57ea-42fc-973c-6b8d71c62c00",
        "workflow_instance_name" : "1eee9e32-57ea-42fc-973c-6b8d71c62c00",
        "workflow_instance_status" : null
      },
      "dataobject_id" : null,
      "policy_automation" : "AUTOMATION",
      "region_name" : null,
      "id" : "1ea4045a-4540-4e29-ac41-612d4842e4a0",
      "policy_direction" : "INGRESS",
      "defense_policy_list" : [ {
        "target_project_name" : "RegionName",
        "defense_connection_name" : "CFW云服务认证凭据",
        "defense_type" : "CFW",
        "defense_policy_list" : null,
        "defense_failure_description" : null,
        "target_enterprise_id" : "0",
        "defense_connection_region_id" : "RegionId",
        "defense_creator_id" : "b6566bce94194f3d9dc6d397c72e40b2",
        "description" : null,
        "defense_policy_name" : null,
        "defense_creator_name" : "test_domain_name",
        "defense_connection_id" : "84b273d3-47a8-3aba-bd00-7bdd1431d635",
        "defense_id" : "a76ab1ab-faf8-43d6-953c-6bde4d19f6dc",
        "defense_connection_region_name" : "RegionName",
        "target_enterprise_name" : "default",
        "dataobject_id" : null,
        "defense_block_status" : "SENDING",
        "defense_block_action" : "BLOCK",
        "target_project_id" : "3bb27e024693436da46b5f5aaf499060",
        "defense_policy_id" : null
      } ],
      "create_time" : "2025-10-22T20:18:52.701Z+0800",
      "region_id" : "RegionId",
      "dataclass_id" : "a110ef4d-b406-3526-a569-745029cc082f",
      "policy_task_name" : "test_domain_name-CFW-20251022201852",
      "environment" : {
        "domain_id" : "94aee09081c649cfa9eef5d25200ec50",
        "domain_name" : "test_domain_name",
        "project_id" : "3bb27e024693436da46b5f5aaf499060",
        "region_id" : "RegionId",
        "region_name" : "RegionName",
        "vendor_type" : "Cloud"
      },
      "trigger_flag" : true,
      "policyrecord_type" : {
        "policy_type" : "Source Ip",
        "id" : "bc9ea975de7aece562c6029918cdb8e5",
        "category" : "阻断方向"
      },
      "policy_category" : "BLOCK"
    },
    "dataclass_ref" : null,
    "format_version" : 0,
    "id" : "",
    "project_id" : "",
    "type" : null,
    "update_time" : null,
    "version" : 0,
    "workspace_id" : ""
  } ],
  "request_id" : "",
  "success" : true
}

状态码

状态码

描述

200

查询策略视图对象返回值

400

查询策略视图对象错误返回body体

错误码

请参见错误码

相关文档