云服务器内容精选

  • 响应参数 状态码: 200 表6 响应Body参数 参数 参数类型 描述 result Array of DashboardSimpleVO objects 统计结果 status String 请求状态 message String 请求失败信息 表7 DashboardSimpleVO 参数 参数类型 描述 category String 工作项类型,系统设备类项目可选值为:RR/SF/IR/SR/AR/Task/Bug,独立软件类项目可选值为:RR/SF/IR/US/Task/Bug,云服务类项目可选值为:RR/Epic/FE/US/Task/Bug total Integer 工作项总数 processing Integer 处理中的工作项数量 completed Integer 已完成的工作项数量 expired Integer 已超期的工作项数量 remain_di Double 缺陷的遗留DI,统计范围为该项目下所有非关闭态、非草稿态的缺陷 DI计算规则: DI=提示0.1 + 一般1 +严重3 + 致命10 category_name String 统计面板名称 状态码: 400 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述
  • 响应示例 状态码: 200 统计成功响应 { "status" : "success", "message" : null, "result" : [ { "category" : "RR", "total" : 0, "processing" : 0, "completed" : 0, "expired" : 0, "category_name" : "原始需求" }, { "category" : "SF", "total" : 2, "processing" : 1, "completed" : 0, "expired" : 0, "category_name" : "系统特性" }, { "category" : "IR", "total" : 2, "processing" : 1, "completed" : 0, "expired" : 1, "category_name" : "初始需求" }, { "category" : "SR", "total" : 1, "processing" : 0, "completed" : 0, "expired" : 0, "category_name" : "系统需求" }, { "category" : "AR", "total" : 1, "processing" : 0, "completed" : 0, "expired" : 0, "category_name" : "分配需求" }, { "category" : "Task", "total" : 1, "processing" : 0, "completed" : 0, "expired" : 0, "category_name" : "任务" }, { "category" : "Bug", "total" : 5, "processing" : 0, "completed" : 0, "expired" : 0, "category_name" : "缺陷" } ] } 状态码: 400 统失败响应 { "error_code" : "PM.02175302", "error_msg" : "服务繁忙:ISSUE_SERVICE" }
  • URI POST /v1/ipdprojectservice/projects/{project_id}/statistic/dashboard 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目Id 表2 Query参数 参数 是否必选 参数类型 描述 classification 是 String 标识统计类型,可选值为requirement,bug classification=requirement 查询需求统计 classification=bug 查询缺陷统计
  • 请求参数 表3 请求Body参数 参数 是否必选 参数类型 描述 plan 否 PlanFilter object 统计概览按PI迭代过滤条件 created_date 否 DateFilter object 按创建时间统计时,起止时间过滤条件 表4 PlanFilter 参数 是否必选 参数类型 描述 plan_pi 否 String 按PI统计时,被统计的PI的id plan_iteration 否 String 按PI下迭代统计时,迭代的id 表5 DateFilter 参数 是否必选 参数类型 描述 start_date 否 String 工作项创建时间不早于此时间,日期d的0点时间戳 end_date 否 String 工作项创建时间不晚于此时间,日期d+1的0点时间戳
  • 响应示例 状态码: 200 OK { "bug_statistics" : [ { "critical_num" : 0, "defect_index" : 1, "module" : "统计分数", "normal_num" : 1, "serious_num" : 0, "tip_num" : 0, "total" : 1 } ] }
  • URI GET /v4/projects/{project_id}/bug-statistic 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 参数解释:项目的32位uuid,项目唯一标识,可以通过ListProjectsV4接口查询项目列表 约束限制:正则表达式, ^[A-Za-z0-9]{32}$ 取值范围:字符串,最小长度:32,最大长度:32 默认取值:不涉及
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 bug_statistics Array of BugStatisticResponseV4 objects 当前项目下bug统计信息 表4 BugStatisticResponseV4 参数 参数类型 描述 critical_num Integer 重要程度为关键的缺陷数,重要程度为关键对应id为10 defect_index Double DI值,不同重要程度的缺陷对应不同的分值 module String 模块 normal_num Integer 重要程度为一般的缺陷数,重要程度为一般对应id为12 serious_num Integer 重要程度为严重的缺陷数,重要程度为严重对应id为11 tip_num Integer 重要程度为提示的缺陷数,重要程度为提示对应id为13 total Integer 当前项目下bug统计总数 状态码: 400 表5 响应Body参数 参数 参数类型 描述 error_msg String 错误描述 error_code String 错误码 状态码: 401 表6 响应Body参数 参数 参数类型 描述 error_msg String 错误描述 error_code String 错误码
  • URI GET /v2/{project_id}/statistics/metrics/trend 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。 表2 Query参数 参数 是否必选 参数类型 描述 start_time 是 String 开始时间。 end_time 是 String 结束时间。 dim 否 String 指标维度 | 目前最大支持3个维度,必须从0开始;维度格式为dim.{i}=key,value,key的最大长度32,value的最大长度为256。 单维度:dim.0=instance_id,6f3c6f91-4b24-4e1b-b7d1-a94ac1cb011d 多维度:dim.0=key,value&dim.1=key,value。 metric_names 是 Array of strings 指标名称列表,支持的指标名称参考Workspace运维监控指标。 period 否 String 数据周期 | MIN - 分钟级 5MIN - 5分钟级 DAY - 天级数据 HOUR - 小时级数据。
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 [数组元素] Array of MetricsWithTime objects 查询指标趋势响应。 表5 MetricsWithTime 参数 参数类型 描述 time String 时间。 metrics Array of Metric objects 指标值。 表6 Metric 参数 参数类型 描述 metric_name String 指标名称。 metric_value Double 指标值。 状态码: 400 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 状态码: 401 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 状态码: 500 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。
  • URI GET /v2/{project_id}/statistics/metrics/desktops 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。 表2 Query参数 参数 是否必选 参数类型 描述 start_time 是 String 查询起始时间(0时区) 云服务每天凌晨02:00进行聚合运算前一天00:00:00~23:59:59的使用时长,并将周期范围内的数据聚合到周期边界上 跨天的记录会按照统计周期进行计算 假设一天内桌面登录多次,09:00~12:00,13:00~21:00,22:00~01:00(次日): 则当天的累计使用时长数据会被汇聚到23:59:59这个点;总使用时长为 3hours(09:00~12:00)+8hours(13:00~21:00)+2hours(22:00~00:00) 如果查询的from-to不足一个周期内,可能造成查询到数据为空; end_time 是 String 查询截至时间(0时区)。 resource_name 否 String 资源名称(模糊匹配)。 min_idle_days 否 Integer 最小空闲天数。 max_idle_days 否 Integer 最大空闲天数 min_idle_days、max_idle_days都非空时,max_idle_days必须大于等于min_idle_days否则可能查询不到数据 usage_min_hours 否 Integer 使用时长(hour)最小值。 usage_max_hours 否 Integer 使用时长(hour)最大值(必须大于等于usage_min_hours)。 sort_field 否 String 按照指标进行排序 desktop_usage - 按照桌面使用时长排序 desktop_idle_duration - 按照桌面空闲周期排序 sort_type 否 String 按照指标进行排序的方向;需配合sort_field一起使用 DESC - 降序返回数据 ASC - 升序返回数据 offset 否 Integer 查询的偏移量,默认值0。 limit 否 Integer limit范围[1-100],默认值0。
  • 功能介绍 查询桌面使用统计信息; 云服务每天凌晨02:00进行聚合运算前一天00:00:00~23:59:59的使用时长,并将周期范围内的数据聚合到周期边界上 跨天的记录会按照统计周期进行计算 假设一天内桌面登录多次,09:00~12:00,13:00~21:00,22:00~01:00(次日): 则当天的累计使用时长数据会被汇聚到23:59:59这个点;总使用时长为 3hours(09:00~12:00)+8hours(13:00~21:00)+2hours(22:00~00:00) 仅能查询最近180天已进行汇聚计算的数据
  • 响应示例 状态码: 200 响应成功。 { "count" : 0, "items" : [ { "resource_id" : "xxx-xxx-xxx", "resource_pool_id" : "xxx-xxx-xxx", "resource_name" : "xxxx", "metric" : [ { "metric_name" : "desktop_state", "metric_value" : 10 } ] } ] }
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 count Integer 总数。 items Array of DesktopMetric objects 桌面统计指标。 表5 DesktopMetric 参数 参数类型 描述 resource_id String 桌面ID。 resource_pool_id String 桌面池ID(仅桌面池中的桌面存在该字段)。 resource_name String 桌面名称。 metric Array of Metric objects 统计信息 desktop_usage - 桌面使用时长(单位:秒) desktop_idle_duration - 桌面空闲时长(单位:秒) 表6 Metric 参数 参数类型 描述 metric_name String 指标名称。 metric_value Double 指标值。 状态码: 400 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 状态码: 401 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 状态码: 500 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。
  • 响应示例 状态码: 200 响应成功。 { "rule_id" : "xxxx-xxxx-xxxx", "metric_name" : "desktop_idle_duration", "threshold" : 30, "comparison_operator" : "", "interval" : 1, "enable" : true, "notify_object" : "urn:smn:REGION_ID:XXX-XXX-XXX:topicName" }
  • 响应示例 状态码: 200 状态统计响应。 { "total_num" : 0, "attach_statistics" : { "attached_num" : 0, "unattached_num" : 0, "attaching_num" : 0, "attach_error_num" : 0 }, "run_state_statistics" : { "stop_num" : 0, "active_num" : 5, "error_num" : 0, "hibernated_num" : 0 }, "login_state_statistics" : { "in_use_num" : 0, "stop_num" : 0, "unregistered_num" : 0, "unable_to_connect_num" : 0, "ready_num" : 0, "disconnected_num" : 0 }, "desktop_pool_statistics" : [ { "desktop_pool_id" : 0, "desktop_pool_name" : 0, "total_num" : 0, "attach_statistics" : { "attached_num" : 0, "unattached_num" : 0, "attaching_num" : 0, "attach_error_num" : 0 }, "run_state_statistics" : { "stop_num" : 0, "active_num" : 5, "error_num" : 0, "hibernated_num" : 0 }, "login_state_statistics" : { "in_use_num" : 0, "stop_num" : 0, "unregistered_num" : 0, "unable_to_connect_num" : 0, "ready_num" : 0, "disconnected_num" : 0 } } ] }