华为云用户手册

  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 result result object 返回的具体结果信息 表5 result 参数 参数类型 描述 data Array of ReleaseFileVersionDo objects 符合条件的结果列表 total_records Integer 符合条件的结果总数 最小值:1 最大值:1000 total_pages Integer 符合条件的结果总页数 最小值:1 最大值:10000 表6 ReleaseFileVersionDo 参数 参数类型 描述 version String 发布库文件的版本 最小长度:0 最大长度:100 path String 发布库文件的路径 最小长度:0 最大长度:100 download_url String 发布库文件的下载链接 最小长度:1 最大长度:10000 状态码: 403 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度:0 最大长度:1000 error_msg String 错误信息 最小长度:0 最大长度:1000 状态码: 500 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度:0 最大长度:1000 error_msg String 错误信息 最小长度:0 最大长度:1000
  • 响应消息体 响应消息体通常以结构化格式返回,与响应消息头中Content-type对应,传递除响应消息头之外的内容。 对于获取用户Token接口,返回如下消息体。为篇幅起见,这里只展示部分内容。 { "token": { "expires_at": "2019-02-13T06:52:13.855000Z", "methods": [ "password" ], "catalog": [ { "endpoints": [ { "region_id": "cn-north-1", ...... 当接口调用出错时,会返回错误码及错误信息说明,错误响应的Body体格式如下所示。 { "error_msg": "The format of message is error", "error_code": "AS.0001" } 其中,error_code表示错误码,error_msg表示错误描述信息。
  • 调用API取项目ID 项目ID还用通过调用查询指定条件下的项目信息API获取。 获取项目ID的接口为“GET https://{Endpoint}/v3/projects/”,其中“{Endpoint}”为 IAM 的终端节点,可以从终端节点获取。接口的认证鉴权请参见认证鉴权。 响应示例如下,其中“projects”下的“id”即为项目ID。 { "projects": [ { "domain_id": "65382450e8f64ac0870cd180d14e684b", "is_domain": false, "parent_id": "65382450e8f64ac0870cd180d14e684b", "name": "cn-north-4", "description": "", "links": { "next": null, "previous": null, "self": "https://www.example.com/v3/projects/a4a5d4098fb4474fa22cd05f897d6b99" }, "id": "a4a5d4098fb4474fa22cd05f897d6b99", "enabled": true } ], "links": { "next": null, "previous": null, "self": "https://www.example.com/v3/projects" } }
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 result result object 返回的具体结果信息 表5 result 参数 参数类型 描述 data Array of ReleaseFileVersionDo objects 符合条件的结果列表 total_records Integer 符合条件的结果总数 最小值:1 最大值:1000 total_pages Integer 符合条件的结果总页数 最小值:1 最大值:10000 表6 ReleaseFileVersionDo 参数 参数类型 描述 version String 发布库文件的版本 最小长度:0 最大长度:100 path String 发布库文件的路径 最小长度:0 最大长度:100 download_url String 发布库文件的下载链接 最小长度:1 最大长度:10000 状态码: 403 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度:0 最大长度:1000 error_msg String 错误信息 最小长度:0 最大长度:1000 状态码: 500 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度:0 最大长度:1000 error_msg String 错误信息 最小长度:0 最大长度:1000
  • URI GET /v2/{project_id}/release/files 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 华为云devcloud的项目id 最小长度:0 最大长度:32 表2 Query参数 参数 是否必选 参数类型 描述 file_name 是 String 文件名称,模糊搜索 最小长度:1 最大长度:10000 limit 否 Integer 每页显示的条目数量 最小值:1 最大值:100 缺省值:10 offset 否 Integer 偏移量,表示从此偏移量开始查询, offset大于等于0 最小值:0 最大值:10000000 缺省值:0
  • 请求参数 表2 参数说明 参数 是否必须 类型 位置 描述 conferenceID 是 String Query 会议ID。 participantID 是 String Query 与会者标识。 X-Conference-Authorization 是 String Header 会控Token,通过获取会控token接口获得。 applyChair 是 Integer Body 1:申请主持人 0:释放主持人 chairmanPwd 否 String Body 当申请主持人时,携带主持人密码。
  • 响应消息示例 HTTP/1.1 200 Date: Wed, 18 Dec 2019 06:20:40 GMT Content-Type: application/json;charset=UTF-8 Content-Length: 39 Connection: keep-alive http_proxy_id: 8e6fe9e1d0a45e33398f426a227e855a Server: api-gateway X-Request-Id: 8957e54c2881f52125edd6439995fbf7
  • CURL命令示例 curl -k -i -H 'content-type: application/json' -X PUT -H 'X-Conference-Authorization:stb39b3f21898d4972fed86b3f22ac70914a77303def15e126a' -d '{"applyChair":0}' https://api.meeting.huaweicloud.com/v1/mmc/control/conferences/participants/role?conferenceID=914083136&participantID=d2c3ae64216e11eabc510dc9b62e3a80
  • 请求消息示例 PUT /v1/mmc/control/conferences/participants/role?conferenceID=914083136&participantID=d2c3ae64216e11eabc510dc9b62e3a80 Connection: keep-alive X-Conference-Authorization:stbaf8fa2ea8a1b0e3ab2e007a85a75f88c55d5f6d5c1912dfb Content-Type: application/json user-agent: WeLink -desktop Content-Length: 22 Host: api.meeting.huaweicloud.com User-Agent: Apache-HttpClient/4.5.3 (Java/1.8.0_191) { "applyChair": 1, "chairmanPwd": "******" }
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Conference-Authorization 是 String 会控Token,通过获取会控token接口获得。 表3 请求Body参数 参数 是否必选 参数类型 描述 participantID 否 String 等候室成员标志。通过监听会议级事件推送中的“等候室成员列表信息”事件获得。 allowAll 否 Boolean 允许所有等候者入会。 false:指定等候者 true:所有等候者入会
  • 响应消息示例 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: Mon, 17 May 2021 08:45:41 GMT Pragma: no-cache Server: api-gateway Strict-Transport-Security: max-age=16070400; includeSubDomains X-APIG-Latency: 85 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: 84 X-Content-Type-Options: nosniff X-Download-Options: noopen X-Envoy-Upstream-Service-Time: 59 X-Frame-Options: SAMEORIGIN X-Request-Id: 48e47dc2e65e3bf85e00a60e2cba5ce7 X-Xss-Protection: 1;mode=block { "fileId": "61B5D9E1DE8D411F98630AD018370C54", "imageModeration": { "suggestion": "pass", "category_suggestions": { "politics": "pass", "terrorism": "pass", "porn": "pass" } } }
  • 请求参数 表2 参数说明 参数 是否必须 类型 位置 描述 X-Access-Token 是 String Header 授权令牌。获取“执行App ID鉴权”响应的accessToken。 X-Request-Id 否 String Header 请求requestId,用来标识一路请求,用于问题跟踪定位,建议使用UUID,若不携带,则后台自动生成。 Accept-Language 否 String Header 语言参数,默认为中文zh-CN,英文为en-US。 Content-Type 否 String Header Body的媒体格式。取值为multipart/form-data。 file 是 File formData 需要上传的图片文件。
  • 响应参数 表4 响应参数 参数 类型 描述 fileId String 文件Id。 imageModeration ImageModerationResult object 图片审核结果。 表5 ImageModerationResult数据结构 参数 类型 描述 suggestion String 审核情况。 category_suggestions category_suggestions object 各项内容的审核结果。 表6 category_suggestions数据结构 参数 类型 描述 politics String 政治 内容审核 结果。 terrorism String 暴恐内容审核结果。 porn String 色情内容审核结果。
  • 请求消息示例 PUT /v1/wss/webinar/open/res/file HTTP/1.1 Host: 251ba26eef46472d97fa4462d514b044.APIG.cn-north-7.huaweicloudapis.com User-Agent: APIGatewayDebugClient/1.0 Accept: */* Content-Type: multipart/form-data X-Access-Token: cnr1519y4i5r5ikKZYTGqR5b2ybEJORGdm3EcPzU X-APIG-Mode: debug { "file":[binary] }
  • CURL命令示例 curl -k -i -H 'content-type: application/json' -X PUT -H 'X-Conference-Authorization:stb39b3f21898d4972fed86b3f22ac70914a77303def15e126a' https://api.meeting.huaweicloud.com/v1/mmc/control/conferences/participants/hands?conferenceID=914083136&participantID=d2c3ae64216e11eabc510dc9b62e3a80
  • 请求消息示例 PUT /v1/mmc/control/conferences/participants/hands?conferenceID=914083136&participantID=d2c3ae64216e11eabc510dc9b62e3a80 Connection: keep-alive X-Conference-Authorization:stbaf8fa2ea8a1b0e3ab2e007a85a75f88c55d5f6d5c1912dfb content-type: application/json user-agent: WeLink-desktop Host: api.meeting.huaweicloud.com User-Agent: Apache-HttpClient/4.5.3 (Java/1.8.0_191) { "handsState":1 }
  • 响应消息示例 HTTP/1.1 200 Date: Wed, 18 Dec 2019 06:20:40 GMT Content-Type: application/json;charset=UTF-8 Content-Length: 39 Connection: keep-alive http_proxy_id: efa7d0090ee1d5dbcb54aa9f3cfafa96 Server: api-gateway X-Request-Id: f78b007ec2dabf1498620131c7bc19e0
  • 请求参数 表2 参数说明 参数 是否必须 类型 位置 描述 conferenceID 是 String Query 会议ID。 participantID 是 String Query 与会者标识。 X-Conference-Authorization 是 String Header 会控Token,通过获取会控token接口获得。 handsState 是 Integer Body 0:放下手 1:举手
  • 请求消息示例 PUT /v1/mmc/control/conferences/stop?conferenceID=914044873 Connection: keep-alive X-Conference-Authorization:stbaf8fa2ea8a1b0e3ab2e007a85a75f88c55d5f6d5c1912dfb Content-Type: application/json Content-Length: 24 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: 39 Connection: keep-alive http_proxy_id: 46df973984b4ce317502460cd4860600 Server: api-gateway X-Request-Id: 0c4d9e9ce2dc2dca8cac816cad7c42d6
  • CURL命令示例 curl -k -i -H 'content-type: application/json' -X PUT -H 'X-Conference-Authorization:stb39b3f21898d4972fed86b3f22ac70914a77303def15e126a' 'https://api.meeting.huaweicloud.com/v1/mmc/control/conferences/stop?conferenceID=914044873'
  • 请求参数 表2 参数说明 参数 是否必须 类型 位置 描述 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 激活码的唯一标识列表。
  • 请求消息示例 DELETE /v1/usg/dcs/corp/vision/activecode Connection: keep-alive X-Access-Token: stbWbWSIgzfOQ8JnbmPIoBIR3ig8xnVScQOD Content-Type: application/json Host: api.meeting.huaweicloud.com User-Agent: Apache-HttpClient/4.5.3 (Java/1.8.0_191) ["6d35397d67504dd1b7e1766a25f1be12"]
  • 响应消息示例 HTTP/1.1 200 Date: Wed, 18 Dec 2019 06:20:40 GMT Content-Type: application/json;charset=UTF-8 Connection: keep-alive Pragma: No-cache Cache-Control: no-cache Server: api-gateway X-Request-Id: 3d1aeb8cafbbaa7bbbdc7b1c76bba8as
  • CURL命令示例 curl -k -i -H 'content-type: application/json' -X DELETE -H 'X-Access-Token: stbWbWSIgzfOQ8JnbmPIoBIR3ig8xnVScQOD' -d '["6d35397d67504dd1b7e1766a25f1be12"]' https://api.meeting.huaweicloud.com/v1/usg/dcs/corp/vision/activecode
  • 请求参数 表2 参数说明 参数 是否必须 类型 位置 描述 offset 否 Integer Query 查询偏移量。 取值:大于等于0,默认值为0。 大于等于最大条目数量,则返回最后一页的数据。 limit 否 Integer Query 查询的条目数量。 取值:1-500,默认值为20。 searchKey 否 String Query 查询条件。会议主题、会议预约人和会议ID等可作为搜索内容。长度限制为1-512个字符。 X-Access-Token 是 String Header 授权令牌。获取“执行App ID鉴权”响应的accessToken。
  • 响应消息示例 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": 1, "limit": 10, "offset": 0, "data": [{ "confUUID": "a3d9a31c8af211eb8075a12479434adb", "conferenceID": "98909587", "subject": "研发晨会", "scheduserName": "深圳分部秘书", "deptName": "XXXXX", "alarm": "YES", "audioAlarm": "NO", "videoAlarm": "YES", "screenAlarm": "NO", "cpuAlarm": "NO", "timeZoneID": "56", "startTime": 1618220740926, "endTime": 1618222194202, "duration": 32, "participants": 52, "webinar": false }] }
  • 请求消息示例 GET​ /v1/metrics/conferences/online?offset=0&limit=20&searchKey=深圳分部 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 请求Header参数 参数 是否必选 参数类型 描述 X-Conference-Authorization 是 String 会控Token,通过获取会控token接口获得。 表3 请求Body参数 参数 是否必选 参数类型 描述 restPicLayout 否 RestPicLayout object 会议多画面布局信息。 表4 RestPicLayout 参数 是否必选 参数类型 描述 switchTime 否 Integer 多画面轮询时间,单位秒。 最小值:10 picNum 否 Integer 多画面画面数量。 最小值:1 layOutName 否 String 多画面布局名称。 imageType 否 String 画面类型。 uuid 否 String 布局UUID。 subscriberInPics 否 Array of PicInfoNotify objects 子画面列表。 表5 PicInfoNotify 参数 是否必选 参数类型 描述 index 否 Integer 多画面中每个画面的编号,编号从1开始。 id 否 Array of strings 每个画面中的与会者SIP号码。SIP号码可以通过查询企业通讯获取。 share 否 Integer 是否为辅流。 0: 不是辅流 1: 是辅流
  • 请求示例 PUT https://{endpoint}/v1/mmc/control/conferences/layOut?conferenceID=914370850 { "restPicLayout" : { "imageType" : "Two", "switchTime" : 10, "layOutName" : "my_saved_layout", "subscriberInPics" : [ { "index" : 1, "id" : [ "+99111221231895886" ], "share" : 0 }, { "index" : 2, "id" : [ "+99111221231894887" ], "share" : 0 } ] } }
共100000条