云服务器内容精选

  • 响应示例 状态码: 200 处理成功返回。 { "data_list" : [ { "time" : "2020-06-04T07:00:00Z", "value" : 0 }, { "time" : "2020-06-04T07:05:00Z", "value" : 325 } ] } 状态码: 400 参数错误。 { "error_code" : "LIVE.100011001", "error_msg" : "Invalid request parameter: domain" }
  • 响应参数 状态码: 200 表4 响应Header参数 参数 参数类型 描述 X-Request-Id String 请求的唯一标识。 表5 响应Body参数 参数 参数类型 描述 data_list Array of V2BandwidthData objects 采样数据列表 表6 V2BandwidthData 参数 参数类型 描述 value Long 带宽值,单位为bps。 time String 采样时间。日期格式按照ISO8601表示法,并使用UTC时间。 格式为:YYYY-MM-DDThh:mm:ssZ。 状态码: 400 表7 响应Header参数 参数 参数类型 描述 X-Request-Id String 请求的唯一标识。 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。
  • URI GET /v2/{project_id}/stats/up-bandwidth/detail 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID,获取方法请参考获取项目ID。 表2 Query参数 参数 是否必选 参数类型 描述 publish_domains 是 Array 推流 域名 列表,最多支持查询100个域名, 多个域名 以逗号分隔,若查询多个域名,则返回的是多个域名合并数据。 app 否 String 应用名称。 stream 否 String 流名。 region 否 Array 区域列表。具体取值请参考省份名称缩写,不填写查询所有区域。 isp 否 Array 运营商列表,取值如下: CMCC :移动 CTCC : 电信 CUCC :联通 OTHER :其他 不填写查询所有运营商。 interval 否 Integer 查询数据的时间粒度。支持300(默认值),3600和86400秒。不传值时,使用默认值300秒。 type 否 String 查询带宽类型,取值如下: RELAY:转推 不填默认查询推流带宽。 start_time 否 String 起始时间。日期格式按照ISO8601表示法,并使用UTC时间。 格式为:YYYY-MM-DDThh:mm:ssZ。 最大查询跨度31天,最大查询周期1年。 若参数为空,默认查询7天数据。 end_time 否 String 结束时间。日期格式按照ISO8601表示法,并使用UTC时间。 格式为:YYYY-MM-DDThh:mm:ssZ。 若参数为空,默认为当前时间,最大查询跨度31天,最大查询周期1年。结束时间需大于起始时间。
  • 请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 否 String 用户Token。使用Token鉴权方式时必选。 通过调用 IAM 服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 Authorization 否 String 使用AK/SK方式认证时必选,携带的鉴权信息。 X-Sdk-Date 否 String 使用AK/SK方式认证时必选,请求的发生时间。 X-Project-Id 否 String 使用AK/SK方式认证时必选,携带项目ID信息, 与路径参数中的项目ID相同。
  • 响应参数 状态码: 200 表4 响应Header参数 参数 参数类型 描述 X-Request-Id String 请求的唯一标识。 表5 响应Body参数 参数 参数类型 描述 time String 采样时间。日期格式按照ISO8601表示法,并使用UTC时间。 格式为:YYYY-MM-DDThh:mm:ssZ。 data_list Array of PlayDomainStreamInfo objects 采样数据列表 表6 PlayDomainStreamInfo 参数 参数类型 描述 play_domain String 播放域名 stream String 播放流名 protocol String 播放协议,支持FLV、HLS和RTMP。 bandwidth Long 1分钟粒度的带宽值,单位为bps。 online Long 1分钟粒度的在线人数。 状态码: 400 表7 响应Header参数 参数 参数类型 描述 X-Request-Id String 请求的唯一标识。 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。
  • 请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 否 String 用户Token。使用Token鉴权方式时必选。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 Authorization 否 String 使用AK/SK方式认证时必选,携带的鉴权信息。 X-Sdk-Date 否 String 使用AK/SK方式认证时必选,请求的发生时间。 X-Project-Id 否 String 使用AK/SK方式认证时必选,携带项目ID信息, 与路径参数中的项目ID相同。
  • URI GET /v2/{project_id}/stats/stream/play-info 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID,获取方法请参考获取项目ID。 表2 Query参数 参数 是否必选 参数类型 描述 play_domains 否 Array 播放域名列表,最多支持查询10个域名,多个域名以逗号分隔。 如果不传入域名,则查询租户下所有播放域名的流数据。 time 是 String 查询数据的时间点,精确到分钟。 日期格式按照ISO8601表示法,并使用UTC时间。 格式为:YYYY-MM-DDThh:mm:ssZ,最大查询周期七天。 时间必须为时间粒度整时刻点,如:2024-02-02T08:01:00Z。
  • 响应示例 状态码: 200 处理成功返回。 { "time" : "2024-06-06T08:00:00Z", "data_list" : [ { "play_domain" : "play.example.com", "stream" : "test_stream_01", "bandwidth" : 1245, "online" : 123, "protocol" : "hls" }, { "play_domain" : "play.example.com", "stream" : "test_stream_02", "bandwidth" : 1025, "online" : 60, "protocol" : "hls" }, { "play_domain" : "play.example01.com", "stream" : "test_stream_03", "bandwidth" : 3242, "online" : 546, "protocol" : "flv" } ] } 状态码: 400 处理失败返回。 { "error_code" : "LIVE.100011001", "error_msg" : "Invalid request parameter: domains" }
  • 响应示例 状态码: 200 查询成功返回。 { "usage" : [ { "date" : "2020-06-04", "video_sd" : 1, "video_hd" : 1, "video_hdp" : 1, "audio" : 1, "total_duration" : 4 } ] } 状态码: 400 查询失败返回 { "error_code" : "DATA.100011001", "error_msg" : "Required String parameter 'app' is not present" }
  • 请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 否 String 用户Token。使用Token鉴权方式时必选。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 Authorization 否 String 使用AK/SK方式认证时必选,携带的鉴权信息。 X-Sdk-Date 否 String 使用AK/SK方式认证时必选,请求的发生时间。 X-Project-Id 否 String 使用AK/SK方式认证时必选,携带项目ID信息,与路径参数中的项目ID相同。
  • 响应参数 状态码: 200 表4 响应Header参数 参数 参数类型 描述 X-Request-Id String 请求的唯一标识 表5 响应Body参数 参数 参数类型 描述 usage Array of RtcHistoryUsage objects 时间戳及相应时间的指标数值列表 表6 RtcHistoryUsage 参数 参数类型 描述 date String 采样时间。日期格式按照ISO8601表示法,并使用UTC时间。格式为YYYY-MM-DD video_sd Long 标清视频时长,单位秒 video_hd Long 高清视频时长,单位秒 video_hdp Long 超高清视频时长,单位秒 audio Long 音频时长,单位秒 total_duration Long 音视频总时长,单位秒 状态码: 400 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。
  • URI GET /v1/{project_id}/rtc/history/usage 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID,获取方法请参考获取项目ID。 表2 Query参数 参数 是否必选 参数类型 描述 app 是 String 应用标识 metric 是 String 查询的数据类型 CommunicationDuration:音视频通话时长 start_date 是 String 查询起始时间。UTC时间,格式:YYYY-MM-DD,如2020-04-23,不写默认读取过去1天数据数据。 end_date 是 String 查询结束时间。UTC时间,格式:YYYY-MM-DD,如2020-04-23。
  • 请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 否 String 用户Token。使用Token鉴权方式时必选。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 Authorization 否 String 使用AK/SK方式认证时必选,携带的鉴权信息。 X-Sdk-Date 否 String 使用AK/SK方式认证时必选,请求的发生时间。 X-Project-Id 否 String 使用AK/SK方式认证时必选,携带项目ID信息,与路径参数中的项目ID相同。
  • URI GET /v1/{project_id}/rtc/rooms 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID,获取方法请参考获取项目ID。 表2 Query参数 参数 是否必选 参数类型 描述 app 是 String 应用标识 room_id 否 String 房间id state 否 String 房间状态,取值如下: RUNNING:开启中 CLOSED:已关闭 start_time 否 String 查询起始时间。UTC时间,格式:YYYY-MM-DDThh:mm:ssZ,如2020-04-23T06:00:00Z,不写默认读取过去1小时数据数据。 end_time 否 String 查询结束时间。UTC时间,格式:YYYY-MM-DDThh:mm:ssZ,如2020-04-23T07:00:00Z,不写默认为当前时间。 limit 否 Integer 查询结果条数 offset 否 Integer 查询偏移量
  • 响应示例 状态码: 200 查询成功返回。 { "total" : 1, "room_info_list" : [ { "domain" : "603f71bdfa163e500aff1106c8xxxxxx.sparkrtc.myhuaweicloud.com", "app" : "603f71bdfa163e500aff1106c8xxxxxx", "room_id" : "ac146d0f2779916191716070xxxxxx", "state" : "RUNNING", "start_time" : "2021-04-23T09:55:30Z", "end_time" : "-" } ], "offset" : 0, "limit" : 2 } 状态码: 400 查询失败返回 { "error_code" : "DATA.100011001", "error_msg" : "Required String parameter 'app' is not present" }