云服务器内容精选

  • 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" }
  • 响应参数 状态码: 200 表4 响应Header参数 参数 参数类型 描述 X-Request-Id String 请求的唯一标识 表5 响应Body参数 参数 参数类型 描述 total Integer 总数 limit Integer 查询结果限制 offset Integer 查询偏移量 room_info_list Array of RtcServerRoomInfo objects 房间列表信息 表6 RtcServerRoomInfo 参数 参数类型 描述 domain String 域名 app String 应用标识 room_id String 房间ID state String 房间状态,取值如下: RUNNING:开启中 CLOSED:已关闭 duration Integer 房间持续时长,单位:秒 start_time String 房间开始时间,即第一个用户加入房间时间,UTC时间,格式:YYYY-MM-DDThh:mm:ssZ,如2020-04-23T07:00:00Z end_time String 房间关闭时间,即最后一个room_uuid关闭的时间,UTC时间,格式:YYYY-MM-DDThh:mm:ssZ,如2020-04-23T07:00:00Z,若房间未关闭,则返回 “-” 状态码: 400 表7 响应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相同。
  • 响应示例 状态码: 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 StreamCountData objects 采样数据列表。 表6 StreamCountData 参数 参数类型 描述 value Integer 采样时间点的推流路数。 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/stream-count 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID,获取方法请参考获取项目ID。 表2 Query参数 参数 是否必选 参数类型 描述 publish_domains 是 Array 推流域名列表,最多支持查询100个域名,多个域名以逗号分隔,若查询多个域名,则返回的是多个域名合并数据。 start_time 否 String 起始时间。日期格式按照ISO8601表示法,并使用UTC时间。 格式为:YYYY-MM-DDThh:mm:ssZ。最大查询跨度31天,最大查询周期1年。 若参数为空,默认查询7天数据。 end_time 否 String 结束时间。日期格式按照ISO8601表示法,并使用UTC时间。 格式为:YYYY-MM-DDThh:mm:ssZ。 若参数为空,默认为当前时间,最大查询跨度31天, 最大查询跨度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 查询成功返回。 { "total" : "1,", "limit" : "10,", "offset" : 0, "users" : [ { "domain" : "603f71bdfa163e500aff1106c8bxxxxx.sparkrtc.myhuaweicloud.com", "app" : "603f71bdfa163e500aff1106c8xxxxx", "room_id" : "ac146d0f27799161917160702xxxxx", "uid" : "xxxxx", "session" : "0afa1af5a41a11eb802b7d4bc77xxxxx", "state" : "ONLINE", "nick_name" : "xxxxx", "ip" : "113.140.81.xx", "region" : "陕西", "isp" : "CTCC", "device_model" : "iphone", "platform" : "web-Mac10_15_4", "sdk" : "1.4.0", "join_time" : "2021-04-23T09:55:32Z", "leave_time" : "-" } ]} 状态码: 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相同。
  • URI GET /v1/{project_id}/rtc/users 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID,获取方法请参考获取项目ID。 表2 Query参数 参数 是否必选 参数类型 描述 app 是 String 应用id room_id 否 String 房间id uid 否 String 用户id nickname 否 String 用户昵称 region 否 Array 用户省份,支持省份名或缩写,如广东或者GD isp 否 Array 用户接入运营商 state 否 Array 用户状态,取值如下: FAIL:加入失败 ONLINE:在线 OFFLINE:离开 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-23T06:00:00Z,不写默认为当前时间。 limit 否 Integer 查询结果限制 offset 否 Integer 查询偏移量 type 否 String 查询模式,取值如下: detail:会话级 summary:用户级(默认)
  • 响应参数 状态码: 200 表4 响应Header参数 参数 参数类型 描述 X-Request-Id String 请求的唯一标识 表5 响应Body参数 参数 参数类型 描述 total Integer 总数 limit Integer 查询结果限制 offset Integer 查询偏移量 users Array of RtcUser objects 用户列表 表6 RtcUser 参数 参数类型 描述 domain String 域名 app String 应用标识 room_id String 房间ID uid String 用户id session String 会话id state String 用户状态 FAIL: 加入失败 ONLINE:在线 OFFLINE:离开 nick_name String 用户昵称 ip String 用户接入IP region String 用户接入IP所在省份 isp String 用户接入IP所在运营商 device_model String 用户设备型号 platform String 用户设备平台 sdk String 用户sdk版本 join_time String 用户加入房间时间。格式为:YYYY-MM-DDThh:mm:ssZ leave_time String 用户离开房间时间。格式为:YYYY-MM-DDThh:mm:ssZ,若用户未离开,则返回 “-” 状态码: 400 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。