更新时间:2025-12-12 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

Object

返回数据

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" : {
    "aggs_data_objects" : [ ],
    "create_time" : "2025-12-04T14:58:50.256Z+0800",
    "data_object" : {
      "modifier_name" : "l00644738",
      "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" : "scc_soc_l00492109",
      "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云服务认证凭据",
        "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" : "l00644738",
        "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" : "l00644738-VPC-20251204145850",
      "labels" : "",
      "environment" : {
        "domain_id" : "ac7438b990ef4a37b741004eb45e8bf4",
        "domain_name" : "scc_soc_l00492109",
        "project_id" : "15645222e8744afa985c93dab6341da6",
        "region_id" : "cn-north-7",
        "region_name" : "cn-north-7",
        "project_name" : "cn-north-7",
        "vendor_type" : "Huawei Cloud"
      },
      "policy_type" : {
        "policy_type" : "Source Ip",
        "id" : "4d67fe756fcefbf60337e5c8debdff6d",
        "category" : "阻断方向"
      },
      "trigger_flag" : true,
      "policy_category" : "BLOCK",
      "creator_id" : "b40b54b1f27a4224aa0c95ede5b5a46a",
      "modifier_id" : "b40b54b1f27a4224aa0c95ede5b5a46a",
      "creator_name" : "l00644738"
    },
    "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
}

状态码

状态码

描述

200

查询策略视图对象返回值

400

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

错误码

请参见错误码

相关文档