# 获取数据服务总览-GetDataServiceOverviewInfo #### 功能介绍 获取数据服务总览 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-octopus/Permission.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | octopus:dataOverview:get | Read | workspace \* | - | - | - | #### URI GET /v1.0/{project_id}/data/overview 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释**： 项目ID，获取方法请参见[获取项目ID](https://support.huaweicloud.com/api-octopus/octopus-10-0020.html)。 **约束限制**： 不涉及 **取值范围**： 不涉及 **默认取值**： 不涉及 | 表2Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | workspace_id | 否 | String | **参数解释**： 工作空间ID **约束限制**： 不涉及 **取值范围**： 不涉及 **默认取值**： 0 | #### 请求参数 表3请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | **参数解释**： 用户Token，通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值） **约束限制**： 不涉及 **取值范围**： 不涉及 **默认取值**： 不涉及 | | Content-Type | 是 | String | **参数解释**： 内容类型。填application/json **约束限制**： 不涉及 **取值范围**： 不涉及 **默认取值**： 不涉及 | #### 响应参数 **状态码：200** 表4响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | payload | [DataOverviewPayload] object | **参数解释**： 实际返回信息 | | meta_info | [RespMetaInfo] object | **参数解释**： 元数据 | 表5DataOverviewPayload | 参数 | 参数类型 | 描述 | |:---|:---|:---| | item | [DataOverview] object | **参数解释**： 总览信息 | 表6DataOverview | 参数 | 参数类型 | 描述 | |:---|:---|:---| | today_jobs_info | [DataTodayJobsInfo] object | **参数解释**： 今日作业信息 | | vehicle_statistics | [VehicleStatistics] object | **参数解释**： 车辆统计信息 | | collected_data_statistics | [CollectedDataStatistics] object | **参数解释**： 采集数据统计 | 表7DataTodayJobsInfo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | failed_jobs | [FailedJobs] object | **参数解释**： 异常作业信息 | | total_job_num | [TotalJobsNum] object | **参数解释**： 今日作业总数 | 表8FailedJobs | 参数 | 参数类型 | 描述 | |:---|:---|:---| | processor_jobs | Array of [DataTaskVo] objects | **参数解释**： 算子处理任务信息 | | system_jobs | Array of [DataTaskVo] objects | **参数解释**： 内部处理任务信息 | | resim_jobs | Array of [DataTaskVo] objects | **参数解释**： 回放仿真任务信息 | | processor_job_page_info | [DataOverviewPageInfo] object | **参数解释**： 算子任务分页信息 | | resim_job_page_info | [DataOverviewPageInfo] object | **参数解释**： 回放仿真任务分页信息 | | system_job_page_info | [DataOverviewPageInfo] object | **参数解释**： 内部任务分页信息 | 表9DataTaskVo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | Long | **参数解释**： 作业ID **取值范围**： 不涉及 | | job_type | String | **参数解释**： 输出类型 **取值范围**： - DATA_MARK：数据标记 - OPEN_DATA：数据回放 - DATA_SET：数据集 - REPLAY_SIM：回放仿真 - PLOT_DATA：数据图表 - ,PACKAGE_IMPORT：数据包导入 - PACKAGE_DELETE：数据包删除 - SCENARIO_AUTO_MINING：场景挖掘 - SCENARIO_TO_SIM：转仿真场景 - FRAME_EXTRACT：数据抽帧 - SCENARIO_EXTRACT：场景提取 | | data_id | String | **参数解释**： 数据ID **取值范围**： 不涉及 | | status | String | **参数解释**： 作业状态 **取值范围**： - SUBMIT_FAILED：提交失败 - RUN_FAILED：运行异常 - UPLOAD_FAILED：上传失败 | 表10DataOverviewPageInfo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | offset | Integer | **参数解释**： 查询偏移量 **取值范围**： 不涉及 | | limit | Long | **参数解释**： 返回个数上限 **取值范围**： 不涉及 | | total | Long | **参数解释**： 资源总数 **取值范围**： 不涉及 | 表11TotalJobsNum | 参数 | 参数类型 | 描述 | |:---|:---|:---| | processor_jobs | Integer | **参数解释**： 算子任务数量 **取值范围**： 不涉及 | | system_jobs | Integer | **参数解释**： 内部处理任务数量 **取值范围**： 不涉及 | | resim_jobs | Integer | **参数解释**： 回放仿真任务数量 **取值范围**： 不涉及 | 表12VehicleStatistics | 参数 | 参数类型 | 描述 | |:---|:---|:---| | fleet_total_num | Integer | **参数解释**： 车队总数 **取值范围**： 不涉及 | | vehicle_total_num | Integer | **参数解释**： 车辆总数 **取值范围**： 不涉及 | | vehicle_fleet_info | Array of [DataTypeSubtotal] objects | **参数解释**： 已关联车辆的车队信息(只返回关联车辆数前10的车队) | 表13DataTypeSubtotal | 参数 | 参数类型 | 描述 | |:---|:---|:---| | fleet_name | String | **参数解释**： 车队名称 **取值范围**： 不涉及 | | vehicle_num | Integer | **参数解释**： 车辆数 **取值范围**： 不涉及 | 表14CollectedDataStatistics | 参数 | 参数类型 | 描述 | |:---|:---|:---| | total_duration | Double | **参数解释**： 总采集时长 **取值范围**： 不涉及 | | data_statistics_in_last_30_days | Array of [DataDailyDataSize] objects | **参数解释**： 近30天采集数据 | | total_storage_size | Long | **参数解释**： 采集数据总量 **取值范围**： 不涉及 | 表15DataDailyDataSize | 参数 | 参数类型 | 描述 | |:---|:---|:---| | date | String | **参数解释**： 日期，示例：2020-01-01 **取值范围**： 不涉及 | | size | Long | **参数解释**： 数据量，单位(byte) **取值范围**： 不涉及 | 表16RespMetaInfo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | current_time | String | **参数解释**： 请求时间，UTC时间格式，时间为UTC标准时间 **取值范围**： 不涉及 | #### 请求示例 获取数据服务总览 ``` GET https://{endpoint}/v1.0/{project_id}/data/overview ``` #### 响应示例 **状态码：200** 查询成功 ``` { "meta_info" : { "current_time" : "2022-01-01T08:08:29Z" }, "payload" : { "item" : { "today_jobs_info" : { "failed_jobs" : { "processor_jobs" : [ { "id" : 2, "job_type" : "DATA_DESENSITIZATION", "data_id" : "DPK0000002", "status" : "SUBMIT_FAILED" } ], "system_jobs" : [ ], "resim_jobs" : [ { "id" : 1, "job_type" : "REPLAY_SIM", "data_id" : "DPK0000001", "status" : "SUBMIT_FAILED" } ] }, "total_jobs_num" : { "processor_jobs" : 3, "system_jobs" : 2, "resim_jobs" : 1 } }, "vehicle_statistics" : { "fleet_total_num" : 5, "vehicle_total_num" : 10, "vehicle_fleet_info" : [ { "fleet_name" : "myFleet1", "vehicle_num" : 1 }, { "fleet_name" : "myFleet2", "vehicle_num" : 3 } ] }, "collected_data_statistics" : { "total_duration" : 300000, "total_storage_size" : 2000000, "data_statistics_in_last30_days" : [ { "date" : "2022-01-01", "size" : 1000 }, { "date" : "2023-01-02", "size" : 1000 }, { "date" : "2023-01-22", "size" : 1000 }, { "date" : "2023-01-23", "size" : 1000 } ] } } } } ``` #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 查询成功 | | 400 | 请求参数错误 | | 403 | 权限校验失败 | | 500 | 系统内部错误 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-octopus/ErrorCode.html)。