文档首页/ 数据安全中心 DSC/ API参考/ API/ 数据总览/ 查询云服务全景图接口 - ListPanoramas
更新时间:2026-11-13 GMT+08:00
分享

查询云服务全景图接口 - ListPanoramas

功能介绍

功能介绍:查询云服务全景图接口

接口约束

  • 无特殊约束。

调用方法

请参见如何调用API。

授权信息

账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
  • 如果使用身份策略授权,当前API调用无需身份策略权限。

URI

GET /v1/{project_id}/dsg/cloud-service/panorama

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释:

项目ID。可参考获取项目ID获取。

约束限制:

不涉及

取值范围:

以IAM服务接口返回值为准,长度为32个字符,满足正则匹配"^[a-z0-9]{32}$"

默认取值:

不涉及

表2 Query参数

参数

是否必选

参数类型

描述

tag

否

String

参数解释:

标签类型,用于按标签筛选全景图数据

约束限制:

不涉及

取值范围:

不涉及

默认取值:

ALL

type

是

String

参数解释:

云服务类型,用于按类型过滤全景图

约束限制:

取值必须为 OBS、BIG_DATA、DATABASES、ALL 之一(大小写不敏感)

取值范围:

  • OBS-对象存储服务

  • BIG_DATA-大数据服务

  • DATABASES-数据库服务

  • ALL-全部

默认取值:

不涉及

instance_name

否

String

参数解释:

实例名称。

约束限制:

不涉及

取值范围:

长度为1-256个字符,可包含中文字符、英文字母、数字及下划线(_)、短横线(-)

默认取值:

不涉及

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释:

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

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

cloud_services

Array of Map<String,Array> objects

参数解释:

云服务分类映射列表,数组元素为 Map(键为云服务类型名称,值为该类型下的云服务实例列表)

取值范围:

不涉及

表5 PanoramaCloudServiceArray

参数

参数类型

描述

[数组元素]

Array of PanoramaCloudService objects

参数解释:

云服务全景信息,描述一个云服务在全景图中的展示内容

取值范围:

不涉及

表6 PanoramaCloudService

参数

参数类型

描述

instance_id

String

参数解释:

实例ID

取值范围:

不涉及

instance_name

String

参数解释:

实例名称

取值范围:

不涉及

instance_type

String

参数解释:

实例类型

取值范围:

不涉及

object_num

Integer

参数解释:

对象数量

取值范围:

不涉及

status

String

参数解释:

操作结果状态

取值范围:

  • "NEED" 待处理

  • "CONFIRM" 确认

  • "MIS" 误判

  • "EXCLUDE" 排除

sensitive_object_num

Integer

参数解释:

敏感对象数量

取值范围:

不涉及

scan_status

Boolean

参数解释:

是否存在数据扫描任务

取值范围:

true-是,false-否

mask_status

Boolean

参数解释:

是否存在数据脱敏任务

取值范围:

true-是,false-否

cts_status

Boolean

参数解释:

云审计服务(CTS)开启状态

取值范围:

true-是,false-否

grant_status

Boolean

参数解释:

授权状态

取值范围:

true-是,false-否

ecs_id

String

参数解释:

弹性云服务器ID

取值范围:

不涉及

ecs_ip

String

参数解释:

弹性云服务器IP地址

取值范围:

不涉及

region_id

String

参数解释:

区域ID

取值范围:

不涉及

version

String

参数解释:

版本号

取值范围:

不涉及

sub_data_type

String

参数解释:

细分数据类型

取值范围:

不涉及

job_name

String

参数解释:

任务名称

取值范围:

不涉及

请求示例

无

响应示例

状态码:200

{
  "cloud_services" : [ {
    "DBSS" : [ {
      "instance_id" : "826314dd-1b5b-4037-b976-5f9b7a17df46",
      "instance_name" : "dbss-instance-01",
      "instance_type" : "DBSS",
      "object_num" : 45,
      "status" : "CONFIRM",
      "sensitive_object_num" : 12,
      "scan_status" : true,
      "mask_status" : true,
      "cts_status" : true,
      "grant_status" : true,
      "ecs_id" : "826314dd-1b5b-4037-b976-5f9b7a17df46",
      "ecs_ip" : "192.168.0.1",
      "region_id" : "cn-north-7",
      "version" : "1.0.0",
      "sub_data_type" : "OBS",
      "job_name" : "scan-job-credential-01"
    }, {
      "instance_id" : "0d2468ac-3a9e-4b2f-8c5d-1f7a2b3c4d5e",
      "instance_name" : "dbss-instance-01",
      "instance_type" : "DBSS",
      "object_num" : 45,
      "status" : "CONFIRM",
      "sensitive_object_num" : 12,
      "scan_status" : true,
      "mask_status" : true,
      "cts_status" : true,
      "grant_status" : true,
      "ecs_id" : "0d2468ac-3a9e-4b2f-8c5d-1f7a2b3c4d5e",
      "ecs_ip" : "192.168.0.1",
      "region_id" : "cn-north-7",
      "version" : "1.0.0",
      "sub_data_type" : "OBS",
      "job_name" : "scan-job-credential-01"
    } ]
  } ]
}

状态码

状态码

描述

200

查询成功

错误码

请参见错误码。

相关文档