华为云用户手册

  • 响应消息示例 HTTP/1.1 200 OK Transfer-Encoding: chunked Cache-Control: no-cache Connection: keep-alive Content-Security-Policy: connect-src 'self' *.huaweicloud.com ;style-src 'self' 'unsafe-inline' 'unsafe-eval';object-src 'self'; font-src 'self' data:; Content-Type: application/json; charset=UTF-8 Date: Fri, 23 Apr 2021 07:44:58 GMT Pragma: no-cache Server: api-gateway Strict-Transport-Security: max-age=16070400; includeSubDomains X-APIG-Latency: 87 X-APIG-Ratelimit-Api: remain:99,limit:100,time:1 minute X-APIG-Ratelimit-Api-Allenv: remain:199,limit:200,time:1 second X-APIG-Upstream-Latency: 86 X-Content-Type-Options: nosniff X-Download-Options: noopen X-Envoy-Upstream-Service-Time: 32 X-Frame-Options: SAMEORIGIN X-Request-Id: 11379ed26a172206cf67e6288b0d73db X-Xss-Protection: 1;mode=block { "conferenceId": "982311022", "corpId": "314765464", "subject": "网络研讨会", "description": "", "startTime": "2021-04-29 11:00", "duration": 120, "timeZoneId": 56, "state": "schedule", "scheduserId": "bb05917f7363407ea6b1df019fdf257a", "scheduserName": "user", "vmrPkgName": "网络研讨会_1000方观众", "callRestriction": false, "scope": 0, "audienceScope": 0, "chairJoinUri": "https://meeting.huaweicloud.com/#/j/982311022/f78c393cad974a812828342da591f11cab00da91a2c43c3d", "chairPasswd": "116817", "guestJoinUri": "https://meeting.huaweicloud.com/#/j/982311022/8e057f959576587f9778a65a16a28a89be7a50793d10014d", "guestPasswd": "352218", "audienceJoinUri": "https://meeting.huaweicloud.com/#/j/982311022/aab78ec3fffcf54313802455d58449efa9617824aac4d7e5", "audiencePasswd": "441168", "notifySetting": { "enableCalendar": "N", "enableSms": "N", "enableEmail": "N" }, "attendees": ["user"], "enableRecording": "Y" }
  • 请求消息示例 POST /v1/usg/sss/meeting-files/save-to-personal-space Connection: keep-alive X-Access-Token: cnrCAod6XrUexF5jUWmyxlyEcRStV8AsLwVI Content-Type: application/json Host: api.meeting.huaweicloud.com User-Agent: Apache-HttpClient/4.5.3 (Java/1.8.0_191) { "uuid": "42b8e80be5044513ae20edd4ad705272" }
  • 响应消息示例 HTTP/1.1 200 Date: Wed, 18 Dec 2019 06:20:40 GMT Content-Type: application/json;charset=UTF-8 Content-Length: 1329 Connection: keep-alive Pragma: No-cache Cache-Control: no-cache Server: api-gateway X-Request-Id: 270221481fc694f03628e85edf24a0b7
  • CURL命令示例 curl -k -i -H 'content-type: application/json' -X POST -H 'X-Access-Token: cnrCAod6XrUexF5jUWmyxlyEcRStV8AsLwVI' -d '{"uuid": "42b8e80be5044513ae20edd4ad705272"}' https://api.meeting.huaweicloud.com/v1/usg/sss/meeting-files/save-to-personal-space
  • 响应消息示例 HTTP/1.1 200 Date: Tue, 17 Dec 2019 09:32:47 GMT Content-Type: application/json;charset=UTF-8 Connection: keep-alive Pragma: No-cache Cache-Control: no-cache Server: api-gateway X-Request-Id: 539e8b710378987ffc5eb844b5e5c290
  • 请求参数 表2 参数说明 参数 是否必须 类型 位置 描述 X-Access-Token 是 String Header 授权令牌。获取“执行App ID鉴权”响应的accessToken。 X-Request-Id 否 String Header 请求requestId,用来标识一路请求,用于问题跟踪定位,建议使用UUID,若不携带,则后台自动生成。 Accept-Language 否 String Header 语言参数,默认为中文zh-CN,英文为en-US。 address 否 String Body 企业所在地,最大长度为255个字符。 autoUserCreate 否 Boolean Body 企业自动开户开关。
  • 请求消息示例 PUT /v1/usg/dcs/corp Connection: keep-alive X-Access-Token: stbdOWTjFFPAoDfJaWFGWnOTtepUlEsfhQSC Content-Type: application/json Content-Length: 27 Host: api.meeting.huaweicloud.com User-Agent: Apache-HttpClient/4.5.3 (Java/1.8.0_191) { "address": "string" }
  • 响应消息示例 HTTP/1.1 200 Date: Wed, 18 Dec 2019 06:20:40 GMT Content-Type: application/json;charset=UTF-8 Content-Length: 2450 Connection: keep-alive Expires: 0 Pragma: No-cache Cache-Control: no-cache http_proxy_id: 6fba0eff9f832b463580fb06c5b0ff9c Server: api-gateway X-Request-Id: ac9f75ec3c97c823f128526a924532b2 { "count": 2, "limit": 10, "offset": 0, "data": [{ "time": "2021-03-02", "confCount": "122", "confDuration": "1124", "attendeeCount": "261", "confConcurrentUsedCount": "11" }, { "time": "2021-03-03", "confCount": "122", "confDuration": "1124", "attendeeCount": "261", "confConcurrentUsedCount": "11" } ] }
  • CURL命令示例 curl -k -i -X GET -H 'X-Access-Token:stbX5ElstO5QwOwPB9KGQWUZ1DHoFrTsQjjC' -s "https://api.meeting.huaweicloud.com/v1/metrics/dashboard/statistic/conference/info?timeUnit=D&startTime=2021-03-02&endTime=2021-03-03&category=conference_info&offset=0&limit=20"
  • 请求消息示例 GET /v1/metrics/dashboard/statistic/conference/info?timeUnit=D&startTime=2021-03-02&endTime=2021-03-03&category=conference_info&offset=0&limit=20 Connection: keep-alive X-Access-Token: stbX5ElstO5QwOwPB9KGQWUZ1DHoFrTsQjjC user-agent: WeLink -desktop Host: api.meeting.huaweicloud.com User-Agent: Apache-HttpClient/4.5.3 (Java/1.8.0_191)
  • 请求参数 表2 参数说明 参数 是否必须 类型 位置 描述 offset 否 Integer Query 查询偏移量。 取值:大于等于0,默认值为0 若offset大于等于最大条目数量,则返回最后一页数据,页数根据总条目数和limit计算得出 limit 否 Integer Query 查询的条目数量。 取值:1-500,默认值为20 timeUnit 是 String Query 查询时间维度,取值: D: 按日查询 M: 按月查询 startTime 是 String Query 查询时间范围的开始时间,格式根据timeUnit的取值而定。 timeUnit = D,格式:yyyy-MM-dd,此情况下startTime与endTime间隔最多31日 timeUnit = M,格式:yyyy-MM,此情况下startTime与endTime间隔最多12个月 endTime 是 String Query 查询时间范围的结束时间,格式根据timeUnit的取值而定。 timeUnit = D,格式:yyyy-MM-dd,此情况下startTime与endTime间隔最多31日 timeUnit = M,格式:yyyy-MM,此情况下startTime与endTime间隔最多12个月 category 是 String Query 查询分类,取值: conference_info: 会议总体数据 conference_hourly_info: 单日内会议总体数据 category = conference_hourly_info时,timeUnit只能取值'D',且startTime与endTime必须为同一天 X-Access-Token 是 String Header 授权令牌。获取“执行App ID鉴权”响应的accessToken。
  • 请求示例 PUT https://{endpoint}/v1/mmc/control/conferences/setAttendeeLanChannel?conferenceID=968835906 { "listenLanChannel": "en", "speakLanChannel": "en", "participantIDs": ["13d2bf6895b211eea02cb5aed5470e35"] }
  • 响应消息示例 HTTP/1.1 200 Date: Wed, 18 Dec 2019 06:20:40 GMT Content-Type: application/json;charset=UTF-8 Content-Length: 2450 Connection: keep-alive Expires: 0 Pragma: No-cache Cache-Control: no-cache http_proxy_id: 6fba0eff9f832b463580fb06c5b0ff9c Server: api-gateway X-Request-Id: ac9f75ec3c97c823f128526a924532b2 { "count": 3, "limit": 10, "offset": 0, "data": [{ "time": "2021-03-18", "recordUsedSize": "0.23" }, { "time": "2021-03-19", "recordUsedSize": "4035.24" }, { "time": "2021-03-20", "recordUsedSize": "4036.24" } ] }
  • CURL命令示例 curl -k -i -X GET -H 'X-Access-Token:stbX5ElstO5QwOwPB9KGQWUZ1DHoFrTsQjjC' -s "https://api.meeting.huaweicloud.com/v1/metrics/dashboard/statistic/resource/info?timeUnit=D&startTime=2021-03-18&endTime=2021-03-20&category=used_record_info&offset=0&limit=10"
  • 请求消息示例 GET /v1/metrics/dashboard/statistic/resource/info?timeUnit=D&startTime=2021-03-18&endTime=2021-03-20&category=used_record_info&offset=0&limit=10 Connection: keep-alive X-Access-Token: stbX5ElstO5QwOwPB9KGQWUZ1DHoFrTsQjjC user-agent: WeLink-desktop Host: api.meeting.huaweicloud.com User-Agent: Apache-HttpClient/4.5.3 (Java/1.8.0_191)
  • 请求参数 表2 参数说明 参数 是否必须 类型 位置 描述 offset 否 Integer Query 查询偏移量。 取值:大于等于0,默认值为0 若offset大于等于最大条目数量,则返回最后一页数据,页数根据总条目数和limit计算得出 limit 否 Integer Query 查询的条目数量。 取值:1-500,默认值为20 timeUnit 是 String Query 查询时间维度,取值: D: 按日查询 M: 按月查询 startTime 是 String Query 查询时间范围的开始时间,格式根据timeUnit的取值而定。 timeUnit = D,格式:yyyy-MM-dd,此情况下startTime与endTime间隔最多31日 timeUnit = M,格式:yyyy-MM,此情况下startTime与endTime间隔最多12个月 endTime 是 String Query 查询时间范围的结束时间,格式根据timeUnit的取值而定。 timeUnit = D,格式:yyyy-MM-dd,此情况下startTime与endTime间隔最多31日 timeUnit = M,格式:yyyy-MM,此情况下startTime与endTime间隔最多12个月 category 是 String Query 查询分类,取值: used_vmr_info: 已购VMR资源使用统计数据 used_live_info: 已购直播端口资源使用统计数据 used_record_info: 已购录播资源使用统计数据 used_pstn_info: 已购电话外呼资源使用统计数据 X-Access-Token 是 String Header 授权令牌。获取“执行App ID鉴权”响应的accessToken。
  • 响应参数 表4 响应参数 参数 类型 描述 count Integer 总记录数。 limit Integer 查询条目数量。 offset Integer 查询偏移量。 data Array of StatisticResourceDataItem objects 会议已购资源使用数据按时间点统计的查询结果数组。 表5 StatisticResourceDataItem数据结构 参数名称 参数类型 描述 time String 日期/月份。 vmrParties String VMR方数。 category = used_vmr_info时有效。 maxConcurrencyVmrCount String VMR并发使用数。 category = used_vmr_info时有效。 livePortUsedCount String 直播端口并发使用数。 category = used_live_info时有效。 recordUsedSize String 录播使用空间(G)。 category = used_record_info时有效。 pstnUsedDuration String PSTN外呼时长(分钟)。 category = used_pstn_info时有效。
  • 请求参数 表2 参数说明 参数 是否必须 类型 位置 描述 corp_id 是 String Path 企业id。 X-Access-Token 是 String Header 授权令牌。获取“执行App ID鉴权”响应的accessToken。 X-Request-Id 否 String Header 请求requestId,用来标识一路请求,用于问题跟踪定位,建议使用UUID,若不携带,则后台自动生成。 Accept-Language 否 String Header 语言参数,默认为中文zh-CN,英文为en-US。 [数组元素] 是 Array of ResourceDTO objects Body 待添加的资源列表,最多支持批量处理100个。
  • 请求消息示例 POST /v1/usg/dcs/sp/corp/818803911/resource Connection: keep-alive X-Access-Token: stbvmKo5lr6vT7QIzKHg4iqicUBcYMb3qlki Content-Type: application/json Content-Length: 31 Host: api.meeting.huaweicloud.com User-Agent: Apache-HttpClient/4.5.3 (Java/1.8.0_191) [ { "count": 10, "expireDate": 2549030400000, "type": "VMR", "typeId": "ff808081699b56cb0169c411a0980152" } ]
  • CURL命令示例 curl -k -i -H 'content-type: application/json' -X POST -H 'X-Access-Token: stbvmKo5lr6vT7QIzKHg4iqicUBcYMb3qlki' -d '[{"count": 10,"expireDate": 2549030400000,"id": "733ff391f2a14360af3b93bd1325f9f9","type": "VMR","typeId": "ff808081699b56cb0169c411a0980152"}]' https://api.meeting.huaweicloud.com/v1/usg/dcs/sp/corp/818803911/resource
  • 响应消息示例 HTTP/1.1 200 Date: Wed, 18 Dec 2019 06:20:40 GMT Content-Type: application/json;charset=UTF-8 Content-Length: 143 Connection: keep-alive Pragma: No-cache Cache-Control: no-cache Server: api-gateway X-Request-Id: 702639ba08cda213b2699300e7f166e8
  • CURL命令示例 curl -k -i -H 'content-type: application/json' -X PUT -H 'X-Access-Token: stbVbWSIgzfOQ8JnbmPIoBIR3ig8xnVScQOF' -d '["asdasfscasd"]' https://api.meeting.huaweicloud.com/v1/usg/dcs/corp/device/status/0
  • 请求参数 表2 参数说明 参数 是否必须 类型 位置 描述 value 是 Integer Path 状态。 0:启用 1:停用 X-Access-Token 是 String Header 授权令牌。获取“执行App ID鉴权”响应的accessToken。 X-Request-Id 否 String Header 请求requestId,用来标识一路请求,用于问题跟踪定位,建议使用UUID,若不携带,则后台自动生成。 Accept-Language 否 String Header 语言参数,默认为中文zh-CN,英文为en-US。 [数组元素] 是 Array of strings Body 终端序列号列表,当SN对应的终端状态一致的,则忽略该记录。 maxLength:100 minLength:1
  • 请求消息示例 PUT /v1/usg/dcs/corp/device/status/0 Connection: keep-alive X-Access-Token: stbVbWSIgzfOQ8JnbmPIoBIR3ig8xnVScQOF Content-Type: application/json Content-Length: 47 Host: api.meeting.huaweicloud.com User-Agent: Apache-HttpClient/4.5.3 (Java/1.8.0_191) ["asdasfscasd"]
  • 请求消息示例 GET /v1/usg/dcs/corp/vmr?searchKey=6767&offset=0&limit=10 Connection: keep-alive X-Access-Token: stbVbWSIgzfOQ8JnbmPIoBIR3ig8xnVScQOF Content-Type: application/json Host: api.meeting.huaweicloud.com User-Agent: Apache-HttpClient/4.5.3 (Java/1.8.0_191)
  • 响应消息示例 HTTP/1.1 200 Date: Wed, 18 Dec 2019 06:20:40 GMT Content-Type: application/json;charset=UTF-8 Content-Length: 308 Connection: keep-alive Pragma: No-cache Cache-Control: no-cache Server: api-gateway X-Request-Id: fbbc91569f0efed914e0427fc2a9c4ac { "count" : 1, "data" : [ { "device" : { "id" : "22c1804004374b558084c50e44e77085", "mark" : "13456789" }, "id" : "ff8080816c52e2a6016c53878f030030", "member" : { "id" : "nhl", "mark" : "nhl(nhl)" }, "status" : 0, "vmrId" : "9*******7", "vmrName" : "云会议室", "vmrPkgName" : "小型云会议室-10方", "vmrPkgParties" : 10, "maxAudienceParties": 1000, "commercialMaxAudienceParties": 1000, "expireDate": 1666195200000 } ], "limit" : 10, "offset" : 0 }
  • 请求参数 表2 参数说明 参数 是否必须 类型 位置 描述 offset 否 Integer Query 查询偏移量,若超过最大数量,则返回最后一页的数据。 默认值:0 limit 否 Integer Query 查询数量。 默认值:10 searchKey 否 String Query 搜索条件。支持云会议室名称、ID及分配的用户、硬终端名称模糊搜索。 status 否 Integer Query 云会议室状态。不填则查询所有。 0:正常 1:停用 2:未分配 vmrMode 否 Integer Query VMR模式。不填则默认为云会议室。 1:云会议室 2:网络研讨会 X-Access-Token 是 String Header 授权令牌。获取“执行App ID鉴权”响应的accessToken。 X-Request-Id 否 String Header 请求requestId,用来标识一路请求,用于问题跟踪定位,建议使用UUID,若不携带,则后台自动生成。 Accept-Language 否 String Header 语言参数,默认为中文zh-CN, 英文为en-US。
  • 响应参数 表4 响应参数 参数 类型 描述 count Integer 总数量。 limit Integer 每页显示的条目数量。 默认值:10 offset Integer 页面起始页,从0开始。 data Array of QueryOrgVmrResultDTO objects 查询到的云会议室列表。 表5 QueryOrgVmrResultDTO数据结构 参数 类型 描述 device IdMarkDTO object 云会议室绑定硬终端的华为云会议账号。 id String 云会议室的ID。 说明: 对应创建会议接口中的vmrID。 member IdMarkDTO object 云会议室绑定用户的华为云会议账号。 status Integer 云会议室状态。 0:正常 1:停用 2:未分配 vmrId String 云会议室的固定会议ID。 说明: 对应创建会议接口返回数据的vmrConferenceID。 vmrName String 云会议室名称。 vmrPkgName String 云会议室套餐名称。 vmrPkgParties Integer 云会议室套餐会议并发方数。 maxAudienceParties Integer 最大观众与会方数(仅网络研讨会有效)。 expireDate Long 到期时间的时间戳,单位毫秒。 commercialMaxAudienceParties Integer 按次资源转商后,商用规格最大观众与会方数(仅网络研讨会有效)。 表6 IdMarkDTO数据结构 参数 类型 描述 id String 唯一标识。 mark String 用于返回id对应的回显描述,一般为名称等。
  • 请求消息示例 GET /v1/usg/sss/publications?offset=0&limit=10&searchKey= Connection: keep-alive X-Access-Token: cnrfzn5OLRjwoaOf2F7PfMwVjJ6zScFogbDE Content-Type: application/json Host: api.meeting.huaweicloud.com User-Agent: Apache-HttpClient/4.5.3 (Java/1.8.0_191)
  • 响应参数 表4 响应参数 参数 类型 描述 count Integer 总数量。 limit Integer 每页显示的条目数量。 默认值:10。 offset Integer 页面起始页,从0开始。 data Array of PublicationResponseBase objects 发布响应信息。 表5 PublicationResponseBase 数据结构 参数 类型 描述 createTime Long 创建时间。 endTime Long 结束时间。 id String 发布ID。 lastUpdatedBy String 更新者。 publishName String 发布名称。 publishScope String 发布范围。 publishStatus String 根据当前时间确定发布状态。 NOT_ONLINE - 未上线 PUBLISHING - 发布中 ALREADY_OFFLINE - 已下线 startTime Long 开始时间。 updateTime Long 更新时间
共100000条