华为云用户手册

  • 请求示例 POST https://{endpoint}/v2/agreement { "agreements" : [ { "agreement_name" : "agreement AAA", "agreement_version" : "v1" }, { "agreement_name" : "agreement BBB", "agreement_version" : "v1" } ] }
  • 响应示例 状态码:400 Bad Request { "error_code" : "common.01000001", "error_msg" : "failed to read http request, please check your input, code: 400, reason: Type mismatch., cause: TypeMismatchException" } 状态码:401 Unauthorized { "error_code": 'APIG.1002', "error_msg": 'Incorrect token or token resolution failed' } 状态码:403 Forbidden { "error" : { "code" : "403", "message" : "X-Auth-Token is invalid in the request", "error_code" : null, "error_msg" : null, "title" : "Forbidden" }, "error_code" : "403", "error_msg" : "X-Auth-Token is invalid in the request", "title" : "Forbidden" } 状态码:404 Not Found { "error_code" : "common.01000001", "error_msg" : "response status exception, code: 404" } 状态码:408 Request Timeout { "error_code" : "common.00000408", "error_msg" : "timeout exception occurred" } 状态码:500 Internal Server Error { "error_code" : "common.00000500", "error_msg" : "internal error" }
  • 请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 否 String 租户token。 表2 请求Body参数 参数 是否必选 参数类型 描述 agreements 否 Array of TenantAgreement objects 租户协议列表。 表3 TenantAgreement 参数 是否必选 参数类型 描述 agreement_name 否 String 协议名称。只能包含字母、数字、下划线和中划线,且长度为1到64个字符。 agreement_version 否 String 协议版本号。只能包含字母和数字,且长度为1到32个字符。
  • 响应参数 状态码:200 表4 响应Header参数 参数 参数类型 描述 X-request-id String 请求ID,定位辅助信息。 状态码:400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 common_error_code String CBC公共错误码。 solution_msg String 解决方案描述。 状态码:401 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 common_error_code String CBC公共错误码。 solution_msg String 解决方案描述。 状态码:403 表7 响应Body参数 参数 参数类型 描述 error Error object 错误信息。 error_code String 错误码。 error_msg String 错误描述。 title String 标题。 表8 Error 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 title String 标题。 message String 错误信息。 code String 状态码。 状态码:404 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 common_error_code String CBC公共错误码。 solution_msg String 解决方案描述。 状态码:408 表10 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 common_error_code String CBC公共错误码。 solution_msg String 解决方案描述。 状态码:500 表11 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 common_error_code String CBC公共错误码。 solution_msg String 解决方案描述。
  • 请求示例 收集外部告警数据的请求体内容 POST https://{endpoint}/v1/external-alarm { "signature" : "OeJ5QozBXn4lI+S+rklNSg7jX85hLFsYMdLfkh07NMOdJXIxq8eGkI+io1lUgJlxKYAIE98m8nXII0+IrlEe5ovVjaFIYkg7f0+qKL+jyfZv5lyJwPAE+WXQuHPRPy7ZBr1fnzXJpnTeDT7Js9LNLnSF7I3RkA0i+pggZv36jhC0ZGaYr8cnlekpnw7hQgGDWf48ZA57f1OP5LbsisL4KmyW3y2mf5/UPnhBK+s1SfiLarGJkFqOKGDn4MPxO81iGUDokGQQr6MpmWL9mHGACKkymnyEQcsZQnKoFsNjtJ/oGM8D14I3r4K20n0GvWPDxZou6wpbN6dvmSmtuqI0Rw==", "subject" : "[紧急告警] 云监控 通知:API网关专享版-APIG实例 “dalf-d67f-f9d7dce4-60d8-4566-9d66-82503cb92d88” 的接口调用次数已触发告警。", "topic_urn" : "urn:smn:cn-north-7:a41e18612c054a4c994bb7a837a91ebe: CES _notification_group_aKan6BAzR", "message_id" : "cfd477a2441b45179ba0dcfbd22f2c88", "signature_version" : "v1", "type" : "Notification", "message" : "{\n \"message_type\": \"alarm\",\n \"alarm_id\": \"al1695796819449Pv80VlkvN\",\n \"alarm_name\": \"DALF_APIC_requests_EMERGENCY\",\n \"alarm_status\": \"alarm\",\n \"time\": 1695797165992,\n \"namespace\": \"SYS.APIC\",\n \"metric_name\": \"requests\",\n \"dimension\": \"instance_id:af042c1def5b41389ab88c676ba275a4\",\n \"period\": 1,\n \"filter\": \"Raw data\",\n \"comparison_operator\": \"\\u003e=\",\n \"value\": 50,\n \"unit\": \"\",\n \"count\": 1,\n \"alarmValue\": [\n {\n \"time\": 1695796980000,\n \"value\": 99\n }\n ],\n \"sms_content\": \"[华北-xxxxxxxx][紧急告警]尊敬的xxx:API网关专享版-APIG实例 “dalf-xxxx-xxxxxxx-xxxx-4eac-8b89-4bededd47e9d” (ID:af042c1def5b41389ab88c676ba275a4)的接口调用次数连续1次原始值 \\u003e= 50次/分钟,当前数据:99.00次/分钟,于2023/09/27 14:46:05 GMT+08:00触发告警,触发规则:DALF_APIC_requests_EMERGENCY,详情请访问 云监控服务 。\",\n \"default_content\": \"[华北-乌兰察布-二零三][紧急告警]尊敬的xxx:API网关专享版-APIG实例 “dalf-xxxx-xxxxxxxx-xxxx-4eac-8b89-4bededd47e9d” (ID:af042c1def5b41389ab88c676ba275a4)的接口调用次数连续1次原始值 \\u003e= 50次/分钟,当前数据:99.00次/分钟,于2023/09/27 14:46:05 GMT+08:00触发告警,触发规则:DALF_APIC_requests_EMERGENCY,详情请访问云监控服务。\"\n }", "unsubscribe_url" : "https: //example.com/smn/subscription/unsubscribe?region=cn-north-7®ion_id=cn-north-7&subscription_urn=urn:smn:cn-north-7:a41e18612c054a4c994bb7a837a91ebe:CES_notification_group_aKan6BAzR:93b74d59e4364e8e9ea0167b8bf0d2f6", "signing_cert_url" : "https://example.com/smn/ SMN _cn-north-7_94f7b4675c6a45f282b7d8e3ea30713e.pem", "timestamp" : "2023-09-15T06:46:07Z" }
  • 响应参数 状态码:400 表2 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 common_error_code String CBC公共错误码。 solution_msg String 解决方案描述。 状态码:401 表3 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 common_error_code String CBC公共错误码。 solution_msg String 解决方案描述。 状态码:403 表4 响应Body参数 参数 参数类型 描述 error Error object 错误信息。 error_code String 错误码。 error_msg String 错误描述。 title String 标题。 表5 Error 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 title String 标题。 message String 错误信息。 code String 状态码。 状态码:404 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 common_error_code String CBC公共错误码。 solution_msg String 解决方案描述。 状态码:408 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 common_error_code String CBC公共错误码。 solution_msg String 解决方案描述。 状态码:500 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 common_error_code String CBC公共错误码。 solution_msg String 解决方案描述。
  • 响应示例 状态码:401 Unauthorized { "error_code": 'APIG.1002', "error_msg": 'Incorrect token or token resolution failed' } 状态码:403 Forbidden { "error" : { "code" : "403", "message" : "X-Auth-Token is invalid in the request", "error_code" : null, "error_msg" : null, "title" : "Forbidden" }, "error_code" : "403", "error_msg" : "X-Auth-Token is invalid in the request", "title" : "Forbidden" } 状态码:404 Not Found { "error_code" : "common.01000001", "error_msg" : "response status exception, code: 404" } 状态码:408 Request Timeout { "error_code" : "common.00000408", "error_msg" : "timeout exception occurred" } 状态码:500 Internal Server Error { "error_code" : "common.00000500", "error_msg" : "internal error" }
  • 请求参数 表1 请求Body参数 参数 是否必选 参数类型 描述 signature 否 String 完整性签名。 subject 否 String 告警主题。 topic_urn 否 String 通知组。 message_id 否 String 消息id。 message 否 String 消息内容。 signature_version 否 String 签名版本号。 type 否 String 通知类型。Notification:事件通知;SubscriptionConfirmation:确认订阅;UnsubscribeConfirmation:退订确认。 subscribe_url 否 String 订阅链接,未确认订阅时存在此字段。 unsubscribe_url 否 String 退订链接,已确认订阅时存在此字段。 signing_cert_url 否 String 证书链接。 timestamp 否 String 发生时间。 auth 否 String 授权信息。
  • 前提条件 当前实例已创建存储迁移元数据的Catalog。 待操作用户具有OBS相关操作权限、具有已创建存储迁移元数据的Catalog的操作权限。 已创建了用于存储迁移数据的OBS并行文件系统。 表的Owner只能包含字母、数字和下划线(_),且长度为1~49个字符。不能包含中划线(-)等其他字符。 如果需要迁移多个 MRS 集群中的元数据到同一个LakeFormation实例,MRS集群之间的Database名称不能重复。 如果需要进行多次迁移,表的列更新需要满足列排序和列类型一致的兼容性要求。
  • 数据权限概述 数据湖 权限支持配置数据库、数据表、函数等维度的权限。 云服务管理员可针对不同的管理对象配置不同用户组的权限,统一对数据湖资源进行管理。 对于 IAM 用户/用户组,也可以通过关联LakeFormation服务的细粒度权限策略进行特性权限场景的授权,参见创建LakeFormation自定义IAM策略。当湖内数据资源较多时,建议通过LakeFormation管理控制台对数据湖内的资源进行统一权限管理。 LakeFormation配置权限时需要包含如下要素: 表1 LakeFormation权限要素 权限要素 描述 授权主体 被授予权限的对象,使其具备针对某数据资源的指定访问权限的用户组、角色、IAM用户、委托用户等身份,如某一用户组、某一角色等。 授权主体(用户组、角色、IAM用户、委托用户)名称中不能包含中划线(-),否则可能造成操作失败。 授权类型 数据湖中管理的资源: 数据目录(Catalog) 数据库(Database) 数据表(Table) 数据列(Column) 函数(Function) OBS路径。 操作类型 主体对授权类型的访问权限,不同授权类型支持的操作类型各不相同,可参见表2。 赋予授权权限 是否赋予授权权限,赋予授权权限后,授权主体便可以将拥有将权限授权给其他授权主体。 表2 不同授权类型的操作权限 授权类型 操作类型 权限说明 Catalog ALL Catalog的所有操作权限。 ALTER 修改Catalog。 CREATE_DATABASE 创建数据库。 DROP 删除Catalog。 DESCRIBE 查看Catalog的元数据信息或切换Catalog。 LIST_DATABASE 查看Catalog下资源列表。 数据库 ALL 数据库的所有操作权限。 ALTER 修改数据库。 DROP 删除数据库。 DESCRIBE 查看数据库的元数据信息或切换数据库。 LIST_TABLE 查看数据库下资源列表。 LIST_FUNC 查看某一数据库下的函数。 CREATE_TABLE 在数据库中创建表。 CREATE_FUNC 在数据库中创建函数。 表 ALL 表的所有操作权限。 ALTER 修改表。 DROP 删除表。 DESCRIBE 查看表的元数据信息。 UPDATE 更新表数据。 INSERT 插入表数据。 SELECT 查询表内数据。 DELETE 删除表的数据。 列 SELECT 查询表内的列数据。 函数 ALL 函数的所有操作权限。 ALTER 修改函数。 DROP 删除函数。 DESCRIBE 查看函数的元数据信息。 EXEC 执行函数。 路径 READ 路径下文件的读权限。 WRITE 路径下文件的写权限。 权限管理员通常分为系统权限管理员与业务权限管理员,需要具备的IAM权限与权限管理范围不同。 系统权限管理员 需要拥有以下IAM操作权限:lakeformation:policy:describe、lakeformation:policy:create、lakeformation:policy:drop。 权限管理范围:可将任意元数据权限授予给其他授权主体,可撤销任意元数据权限。 业务权限管理员 需要拥有以下IAM操作权限: lakeformation:policy:describe、lakeformation:policy:delegate。 权限管理范围:需要被业务管理员赋予授权权限,才能将元数据权限授予其他授权主体,或撤销元数据权限。 例如:系统中存在系统权限管理员User A、业务权限管理员User B、普通用户User C。User A将Catalog1的ALL权限授予User B并同时赋予授权权限后,User B可将Catalog1的DESC等权限授予User C。但User B无法将其他Catalog的权限授予User C。 父主题: 管理数据权限
  • LakeFormation服务权限说明 默认情况下,管理员创建的IAM用户没有任何权限,需要将其加入用户组,并给用户组授予策略或角色,才能使得用户组中的用户获得对应的权限,这一过程称为授权。授权后,用户就可以基于被授予的权限对云服务进行操作。 权限根据授权精细程度分为角色和策略。 角色:IAM最初提供的一种根据用户的工作职能定义权限的粗粒度授权机制。该机制以服务为粒度,提供有限的服务相关角色用于授权。由于各服务之间存在业务依赖关系,因此给用户授予角色时,可能需要一并授予依赖的其他角色,才能正确完成业务。角色并不能满足用户对精细化授权的要求,无法完全达到企业对权限最小化的安全管控要求。 IAM项目只读授权指导:当租户管理员需要给某个子用户分配LakeFormation服务在某个IAM项目下的只读权限。可以给该用户创建一个用户组,同时在用户组将LakeFormation ReadOnlyAccess系统策略授权给指定IAM项目即可。 企业项目授权指导:当租户管理员需要给某个子用户分配LakeFormation服务在某个企业项目下的所有操作权限。可以给该用户创建一个用户组,同时在用户组中将LakeFormation CommonAccess授权给全局,将LakeFormation FullAccess授权给指定企业项目即可。 策略:IAM最新提供的一种细粒度授权的能力,可以精确到具体服务的操作、资源以及请求条件等。基于策略的授权是一种更加灵活的授权方式,能够满足企业对权限最小化的安全管控要求。多数细粒度策略以API接口为粒度进行权限拆分,LakeFormation的自定义IAM策略操作可参考创建LakeFormation自定义IAM策略。 表1 LakeFormation系统策略 系统角色/策略名称 描述 类别 依赖关系 LakeFormation FullAccess LakeFormation管理员权限,拥有该权限的用户可以操作并使用所有LakeFormation服务功能。 系统策略 IAM AgencyFullAccess OBS OperateAccess VPC FullAccess VPCEndpoint FullAccess LakeFormation ReadOnlyAccess LakeFormation只读权限,拥有该权限的用户可以执行LakeFormation所有查询类功能。 系统策略 IAM ReadOnlyAccess OBS ReadOnlyAccess VPC ReadOnlyAccess VPCEndpoint ReadOnlyAccess LakeFormation CommonOperations LakeFormation基础权限,包含LakeFormation服务协议查看/授权/取消,以及OBS、TMS等周边依赖服务的基础权限集合。 系统策略 IAM ReadOnlyAccess OBS ReadOnlyAccess VPC FullAccess VPCEndpoint FullAccess 表2 LakeFormation的IAM权限列表 操作类型 操作项 描述 只读权限 lakeformation:access:describe 查询接入客户端。 只读权限 lakeformation:agency:describe 查询委托。 只读权限 lakeformation:catalog:describe 查询Catalog元数据。 只读权限 lakeformation:configuration:describe 查询配置。 只读权限 lakeformation:credential:describe 查询认证信息。 只读权限 lakeformation:database:describe 查询数据库元数据。 只读权限 lakeformation:function:describe 查询函数元数据。 只读权限 lakeformation:group:describe 查询用户组以及关联角色关系。 只读权限 lakeformation:instance:describe 查询实例。 只读权限 lakeformation:instanceJob:describe 查询实例级任务。 只读权限 lakeformation:job:describe 查询任务。 只读权限 lakeformation:obs:describe 查询OBS桶列表。 只读权限 lakeformation:policy:describe 查询权限策略。 只读权限 lakeformation:policy:export 批量查询权限策略。 只读权限 lakeformation:role:describe 查询角色。 只读权限 lakeformation:table:describe 查询表元数据。 只读权限 lakeformation:tag:describe 查询资源标签。 只读权限 lakeformation:user:describe 查询用户以及关联角色关系。 只读权限 lakeformation:dataset:describe 查询数据集元数据。 只读权限 lakeformation:dataset:describeFile 查询数据集文件元数据。 只读权限 lakeformation:dataset:describeFileGroup 查询数据集文件组元数据。 只读权限 lakeformation:model:describe 查询模型元数据。 只读权限 lakeformation:model:describeFile 查询模型文件元数据。 写权限 lakeformation:access:create 创建接入客户端。 写权限 lakeformation:access:delete 删除接入客户端。 写权限 lakeformation:agency:create 创建委托。 写权限 lakeformation:agency:drop 删除委托。 写权限 lakeformation:catalog:alter 修改Catalog元数据。 写权限 lakeformation:catalog:create 创建Catalog元数据。 写权限 lakeformation:catalog:drop 删除Catalog元数据。 写权限 lakeformation:database:alter 修改数据库元数据。 写权限 lakeformation:database:create 创建数据库元数据。 写权限 lakeformation:database:drop 删除数据库元数据。 写权限 lakeformation:dataset:create 创建数据集元数据。 写权限 lakeformation:file:create 创建文件。 写权限 lakeformation:file:drop 删除文件。 写权限 lakeformation:file:alter 修改文件。 写权限 lakeformation:function:alter 修改函数元数据。 写权限 lakeformation:function:create 创建函数元数据 写权限 lakeformation:function:drop 删除函数元数据。 写权限 lakeformation:group:alter 修改用户组以及关联角色关系。 写权限 lakeformation:instance:access 申请接入服务。 写权限 lakeformation:instance:alter 修改实例。 写权限 lakeformation:instance:create 创建实例。 写权限 lakeformation:instance:drop 删除实例。 写权限 lakeformation:instanceJob:alter 修改实例级任务。 写权限 lakeformation:instanceJob:create 创建实例级任务。 写权限 lakeformation:instanceJob:drop 删除实例级任务。 写权限 lakeformation:instanceJob:exec 执行实例级任务。 写权限 lakeformation:instance:createSubscriber 创建元数据事件订阅者。 写权限 lakeformation:instance:deleteSubscriber 删除元数据事件订阅者。 写权限 lakeformation:job:alter 修改非实例级任务。 写权限 lakeformation:job:create 创建非实例级任务。 写权限 lakeformation:job:drop 删除非实例级任务。 写权限 lakeformation:job:exec 执行非实例级任务。 写权限 lakeformation:model:create 创建模型元数据。 写权限 lakeformation:metadata:restore 恢复元数据。 写权限 lakeformation:part:alter 修改分区。 写权限 lakeformation:part:drop 删除分区。 写权限 lakeformation:part:create 创建分区。 写权限 lakeformation:policy:create 创建权限策略。 写权限 lakeformation:policy:drop 删除权限策略。 写权限 lakeformation:role:alter 修改角色以及关联用户组关系。 写权限 lakeformation:role:create 创建角色。 写权限 lakeformation:role:drop 删除角色。 写权限 lakeformation:table:alter 修改表元数据。 写权限 lakeformation:table:create 创建表元数据。 写权限 lakeformation:table:drop 删除表元数据。 写权限 lakeformation:tableFile:alter 修改表文件。 写权限 lakeformation:tableFile:create 创建表文件。 写权限 lakeformation:tableFile:drop 删除表文件。 写权限 lakeformation:tableFileGroup:alter 修改表文件组元数据。 写权限 lakeformation:tableFileGroup:create 创建表文件组元数据。 写权限 lakeformation:tableFileGroup:drop 删除表文件组元数据。 写权限 lakeformation:transaction:operate 操作事务。 写权限 lakeformation:user:alter 修改用户以及关联角色关系。 权限管理 lakeformation:accessService:grant 授权接入服务。 权限管理 lakeformation:accessTenant:grant 授权接入租户。 权限管理 lakeformation:accessAgency:describe 查询接入委托信息。 权限管理 lakeformation:accessService:describe 查看接入服务。 权限管理 lakeformation:agreement:describe 查询服务协议授权。 权限管理 lakeformation:agreement:cancel 取消服务协议授权。 权限管理 lakeformation:agreement:grant 授权服务协议授权。 权限管理 lakeformation:instance:authorizeLocation 授权将OBS路径授权给LakeFormation服务。 权限管理 lakeformation:instance:cancelAuthorizeLocation 取消授权OBS路径。 权限管理 lakeformation:policy:delegate 将权限策略委托给其他授权主体。
  • 操作流程 图1 给用户授权LakeFormation权限流程 创建用户组并授权 在IAM控制台创建用户组,并授予LakeFormation服务对应权限。 创建用户并加入用户组 在IAM控制台创建用户,并将其加入1.创建用户组并授权中创建的用户组。 用户登录并验证权限 以新创建的用户登录云服务控制台,切换至授权区域,验证权限是否生效。 例如: 在“服务列表”中选择LakeFormation服务,进入总览界面,单击右上角“购买实例”,实例创建界面正常展示,表示“lakeformation:role:create”权限已生效。
  • 前提条件 已参考元数据迁移完成元数据迁移。 当前用户具有OBS相关操作权限,且已创建用于存储数据的OBS并行文件系统。 需将待迁移的权限策略文件导出,并上传至OBS并行文件系统中。权限导出操作可联系对应服务支持人员。 权限策略中授权主体(除角色外)需要提前创建,且名称需保持一致;权限策略中包含的元数据已存在,且名称一致。 如果迁移类型为DLF,其对应关系及迁移策略如下: RAM 用户:IAM用户(如果对应的IAM用户不存在,该权限策略不进行迁移) RAM角色:IAM用户组(如果对应的IAM用户组不存在,该权限策略不进行迁移) DLF角色:LakeFormation角色(不存在会自动创建) 如果迁移类型为Ranger,则仅支持Ranger的allow权限迁移,不支持deny权限迁移。
  • 约束与限制 xDM-F提供了多个版本的事务型接口,各版本间的具体约束和限制如下: 不支持跨租户或跨数据源使用事务型功能。 不支持非数据库操作,例如文件上传。如需进行文件上传,请使用预签名URL上传的方式,具体操作请参见使用预签名URL分块上传文件。 v1、v2和v3版本的事务型接口不可混合使用。 v1版本事务型任务接口,最多支持执行5个原子接口。 v2版本事务型任务接口,取消了异步提交事务型任务时原子接口的数量限制。 v3版本事务型接口,最多支持执行10个原子接口。 在同一v3版本事务中,重复提交或回滚事务将不会生效。 在同一台设备(即同一个IP地址)上,每秒最多可以开启30个v3版本事务。 v3版本事务型接口采用数据库长连接方式构建。使用时,请合理管理事务生命周期,并及时提交事务,以防止数据库锁长时间未释放导致系统吞吐量下降。
  • 操作流程 表1 基线管理操作流程 主要操作流程 操作目的 开启事务 用于创建一个事务上下文,将后续所有操作绑定到同一事务中,确保这些操作要么全部成功,要么全部回滚。 执行iDME原子接口 在事务上下文中,执行一个或多个iDME原子接口的创建、读取、更新和删除(CRUD)操作。这些操作的结果将被设置为待提交的中间状态,根据最终的事务状态(提交或回滚),来确定是否使这些更改永久生效。 提交事务/回滚事务 提交事务:在确保事务内的所有操作都执行成功后,通过提交事务的方式,将中间状态为待提交的变更永久保存至应用数据库,并释放事务所占用的资源。 回滚事务:当事务未能成功完成时,回滚事务可以撤销事务中所有未提交的变化,使数据恢复到事务启动前的状态,并释放相关资源,以此防止由于异常情况或业务规则未被满足而导致的数据混乱。 在整个调用过程中,如出现任何异常情况,系统会自动触发事务的回滚机制。
  • SHA256值比较操作步骤 1.在"App SDK下载"章节中,“表1 Android/iOS/Windows/Mac/Electron UI SDK资源下载路径”中下载的SDK的包; 2.下载SDK包到本地; 3.打开本地命令提示符框,输入如下命令,在本地生成已下载的SDK包的SHA256值,其中,“D:\hwmsdk-win-80.12.7.zip”为SDK包的本地存放路径和SDK包名,请根据实际情况修改。 certutil -hashfile D:\hwmsdk-win-80.12.7.zip SHA256 命令执行结果示例,如下所示: SHA256 的 D:\hwmsdk-win-80.12.7.zip 哈希: 85a691c46a56572ea092945e9565f7927e6c1b4c612b35d01b1c8a9524f8c498 CertUtil: -hashfile 命令成功完成。 对比查询的SDK包的SHA256值和下载后的SDK包的SHA256值。如果一致,则表示下载过程不存在篡改和丢包。
  • 数字签名CMS文件验签操作步骤 1.在"App SDK下载"章节中,“表1 Android/iOS/Windows/Mac/Electron UI SDK资源下载路径”中下载的SDK的包; 2.下载SDK包到本地; 3.从华为support官网https://support.huawei.com/additionalres/pki 下载根CA证书和4个吊销证书,文件如下: CA文件:Huawei Software Integrity Protection Root CA.der CRL文件:HuaweiRootCA.crl、HuaweiCodeSigningCA.crl、HuaweiCodeSigningCA 2.crl、HuaweiCodeSigningCA 3.crl 4.转换CA证书与CRL文件格式从DER到PEM CRL文件: openssl crl -inform DER -in "HuaweiRootCA.crl" -out HuaweiRootCaCrl.pem openssl crl -inform DER -in "HuaweiCodeSigningCA 3.crl" -out HuaweiCodeSigningCA3.pem openssl crl -inform DER -in "HuaweiCodeSigningCA 2.crl" -out HuaweiCodeSigningCA2.pem openssl crl -inform DER -in HuaweiCodeSigningCA.crl -out HuaweiCodeSigningCA.pem CA文件: openssl x509 -inform DER -in "Huawei Software Integrity Protection Root CA.der" -out HuaweiRootCA.pem 5. 记事本打开步骤4中的文件,将HuaweiRootCaCrl.pem、HuaweiCodeSigningCA3.pem、HuaweiCodeSigningCA2.pem和HuaweiCodeSigningCA.pem 4个文件内容依次粘贴到HuaweiRootCA.pem文件内容后面 6.CMS验证 openssl cms -verify -inform DER -crl_check_all -in hmwsdk-win-demo-win32.zip.cms -content hmwsdk-win-demo-win32.zip -CAfile HuaweiRootCA.pem -out cmsVerifiedData -binary -purpose any -certsout tmpCertChain.pem 命令执行结果示例,如下所示表示验签成功: CMS Verification successful
  • 参数描述 表1 HWMSDKPoorNetWorkQualityInfoModel参数说明 参数 类型 描述 userId NSUInteger 用户id nickName NSString * 会中昵称 thirdUserId NSString * 三方账号 accountId NSString * 账号信息 number NSString * sip号码 isLocal BOOL 是否本地 audioStatus HWMSDKLowNetWorkStatusInfoModel * 音频状态 videoStatus HWMSDKLowNetWorkStatusInfoModel * 视频状态 shareStatus HWMSDKLowNetWorkStatusInfoModel * 共享状态 corpId NSString * 企业ID 表2 HWMSDKLowNetWorkStatusInfoModel 参数说明 参数 类型 描述 packetLoss NSUInteger 丢包 delay NSUInteger 延迟 jitter NSUInteger 抖动 status HWMLowNetWorkStatus 状态 表3 枚举HWMLowNetWorkStatus说明 枚举值 描述 HWMLowNetWorkStatusNormal 网络正常 HWMLowNetWorkStatusBad 网络差 HWMLowNetWorkStatusVeryBad 网络非常差
  • queryContactAvatarWithAccount:thirdUserId:number:completionBlock: 接口描述 该接口用于定制登录后的会中头像显示。 注意事项 未登录的头像不支持自定义。 方法定义 1 2 - (void)queryContactAvatarWithAccount:(NSString *)account thirdUserId:(NSString *)thirdUserId number:(NSString *)number completionBlock:(void(^)(NSError * _Nullable error, UIImage * _Nullable avatarImage))completionBlock; 参数描述 表2 参数 类型 描述 account NSString * 账号密码登录场景下优先使用此字段 thirdUserId NSString * appid登录场景下优先使用此字段 number NSString * 跨企业场景优先使用此字段 返回值 无 示例代码 1 2 3 4 5 6 7 /// 拦截头像显示 - (void)queryContactAvatarWithAccount:(NSString *)account thirdUserId:(NSString *)thirdUserId number:(nonnull NSString *)number completionBlock:(void(^)(NSError * _Nullable error, UIImage * _Nullable avatarImage))completionBlock { /// 根据account或者thirdUserId 设置图片,下面的仅为示例代码 UIImage *image = [UIImage imageNamed:@"custom_conf_setting"]; completionBlock(nil, image); }
  • queryContactAvatarWithAvatarModel:completionBlock: 接口描述 该接口用于定制登录后的会中头像显示。 图1 生效后拦截头像显示效果 注意事项 未登录的头像不支持自定义。 方法定义 - (void)queryContactAvatarWithAvatalModel:(HWMConfQueryAvatarModel *)model completionBlock:(void(^)(NSError * _Nullable error, UIImage * _Nullable avatarImage))completionBlock; 参数描述 表1 HWMConfQueryAvatarModel参数说明 参数 类型 描述 account NSString * 账号密码登录场景下优先使用此字段 thirdUserId NSString * appid登录场景下优先使用此字段 number NSString * 跨企业场景优先使用此字段 orgId NSString * 企业ID 返回值 无 示例代码 /// 拦截头像显示 - (void)queryContactAvatarWithAvatalModel:(HWMConfQueryAvatarModel *)model completionBlock:(void(^)(NSError * _Nullable error, UIImage * _Nullable avatarImage))completionBlock{ /// 根据account或者thirdUserId 设置图片,下面的仅为示例代码 UIImage *image = [UIImage imageNamed:@"custom_conf_setting"]; completionBlock(nil, image); }
  • 数字签名CMS文件验签操作步骤 1.在"Demo安装包下载"章节中,“表1 Android/Windows/Mac/Electron Demo资源下载路径”中下载的Demo包; 2.下载Demo包到本地; 3.从华为support官网https://support.huawei.com/additionalres/pki 下载根CA证书和4个吊销证书,文件如下: CA文件:Huawei Software Integrity Protection Root CA.der CRL文件:HuaweiRootCA.crl、HuaweiCodeSigningCA.crl、HuaweiCodeSigningCA 2.crl、HuaweiCodeSigningCA 3.crl 4.转换CA证书与CRL文件格式从DER到PEM CRL文件: openssl crl -inform DER -in "HuaweiRootCA.crl" -out HuaweiRootCaCrl.pem openssl crl -inform DER -in "HuaweiCodeSigningCA 3.crl" -out HuaweiCodeSigningCA3.pem openssl crl -inform DER -in "HuaweiCodeSigningCA 2.crl" -out HuaweiCodeSigningCA2.pem openssl crl -inform DER -in HuaweiCodeSigningCA.crl -out HuaweiCodeSigningCA.pem CA文件: openssl x509 -inform DER -in "Huawei Software Integrity Protection Root CA.der" -out HuaweiRootCA.pem 5. 记事本打开步骤4中的文件,将HuaweiRootCaCrl.pem、HuaweiCodeSigningCA3.pem、HuaweiCodeSigningCA2.pem和HuaweiCodeSigningCA.pem 4个文件内容依次粘贴到HuaweiRootCA.pem文件内容后面 6.CMS验证 openssl cms -verify -inform DER -crl_check_all -in hmwsdk-win-demo-win32.zip.cms -content hmwsdk-win-demo-win32.zip -CAfile HuaweiRootCA.pem -out cmsVerifiedData -binary -purpose any -certsout tmpCertChain.pem 命令执行结果示例,如下所示表示验签成功: CMS Verification successful
  • SHA256值比较操作步骤 1.在"Demo安装包下载"章节中,“表1 Android/Windows/Mac/Electron Demo资源下载路径”中下载的Demo包; 2.下载Demo包到本地; 3.打开本地命令提示符框,输入如下命令,在本地生成已下载的Demo包的SHA256值,其中,“D:\hmwsdk-win-demo-win32.zip”为SDK包的本地存放路径和SDK包名,请根据实际情况修改。 certutil -hashfile D:\hmwsdk-win-demo-win32.zip SHA256 命令执行结果示例,如下所示: SHA256 的 D:\hmwsdk-win-demo-win32.zip 哈希: 67244236887ae862adbe2c8ee2f4612e5d483d0562087c7f084484318655d702 CertUtil: -hashfile 命令成功完成。 对比查询的Demo包的SHA256值和下载后的SDK包的SHA256值。如果一致,则表示下载过程不存在篡改和丢包。
  • StartP2pConf 接口描述 该接口用于发起立即会议。 注意事项 该接口为异步接口,返回值只代表接口是否调用成功,实际业务处理结果在对应的回调函数中返回。 方法定义 1 HWM_SDK_AGENT_API hwmsdk::HwmErrCode StartP2pConf(const HwmP2PStartCallInfo *startCallInfo); 回调函数 1 virtual void OnStartP2pConfResult(hwmsdk::HwmErrCode ret, const char* reason, HwmConfInfo *confInfo) {}; 参数描述 参数 是否必须 类型 描述 startCallInfo 是 HwmP2PStartCallInfo 发起立即会议信息。 表1 结构体HwmP2PStartCallInfo参数说明 参数 是否必须 类型 描述 callerInfo 是 HwmCallerInfo 主叫信息。 calleeInfo 是 HwmCalleeInfo 被叫信息。 mediaType 是 HwmMediaType 媒体类型。 isGuestJoinConfWithoutPwd 否 bool 是否来宾免密。 callInRestriction 否 HwmJoinConfPermissionType 呼入限制。 表2 结构体HwmCallerInfo参数说明 参数 是否必须 类型 描述 nickName 否 char[] 主叫名称。 表3 结构体HwmCalleeInfo参数说明 参数 是否必须 类型 描述 nickName 否 char[] 被叫名称。 number 是 char[] 号码。如果填分配给账号的sip号码(如+99111244216210249)则呼叫该账号的App;如果填PSTN号码(如18700000000),则通过VoIP网关呼叫该号码,前提是该企业已开通PSTN呼叫权限。与thirdUserId二选一,账号密码鉴权时使用。 thirdUserId 是 char[] 第三方用户ID。与number二选一,App ID鉴权时使用。 userUuid 否 char[] 与会者uuid。 type 否 HwmConfAttendeeType 会议用户类型。 orgId 否 char[] 企业id。 返回值 表4 返回值 类型 描述 HwmErrCode 成功返回0,其他值表示失败。失败返回值见错误码参考。 HwmConfInfo 会议信息。 示例代码 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 /** * 发起立即会议 */ int demoStartP2pConfDlg::clickStartP2pConf() { hwmsdkagent::HwmP2PStartCallInfo data{}; //设置主叫信息 string callerNickName = CTools::UNICODE2UTF( CS tring("主叫名称")); strncpy_s(data.callerInfo.nickName, callerNickName.c_str(), HWM_MAX_DISPLAY_NAME_LEN); //设置被叫信息 string calleeNickName = CTools::UNICODE2UTF(CString("被叫名称")); strncpy_s(data.calleeInfo.nickName, calleeNickName.c_str(), HWM_MAX_DISPLAY_NAME_LEN); string calleeNumber = CTools::UNICODE2UTF(CString("123456")); strncpy_s(data.calleeInfo.number, calleeNumber.c_str(), HWM_MAX_NUMBER_LEN); string calleeThirdUserId = CTools::UNICODE2UTF(CString("123456")); strncpy_s(data.calleeInfo.calleeThirdUserId, calleeThirdUserId.c_str(), HWM_MAX_USER_ID_LEN); //设置媒体类型 data.mediaType = hwmsdkagent::HWM_MEDIA_TYPE_VIDEO //调用SDK接口 int ret = hwmsdkagent::StartP2pConf(&data); return ret; }
  • 参数描述 表1 结构体HwmAddAttendeeResultList参数说明 参数 类型 描述 addAttendeeResultSize unsigned int 添加与会者结果长度。 addAttendeeResults HwmAddAttendeeResult* 添加与会者结果列表。 表2 结构体HwmAddAttendeeResult参数说明 参数 类型 描述 number char[] 号码。 thirdUserId char[] 第三方账号。 resultCode HwmErrCode 错误码。 orgId char[] 企业id。
  • 头像拦截显示 接口描述 该接口用于定制登录后的头像显示。 调用场景: 图1 画中画模式 图2 画廊模式 图3 会中与会者列表 图4 悬浮窗 注意事项 未登录的头像不支持自定义。 方法定义 1 public Bitmap queryContactAvatar(ContactInfo contactInfo) 参数描述 表1 ContactInfo参数说明 参数 类型 描述 account String 账号密码登录场景下优先使用此字段 thirdUserId String appid登录场景下优先使用此字段 sipNumber String 跨企业场景优先使用此字段 orgId String 企业ID 返回值 表2 参数 类型 描述 bitmap Bitmap 头像位图类 示例代码 sdkConfig.setQueryContactAvatarStrategy(new IQueryContactAvatarStrategy() { @Override public Bitmap queryContactAvatar(ContactInfo contactInfo) { String extendedField = contactInfo.getExtendedField(); HCLog.i(TAG, "setQueryContactInfoStrategy account: " + StringUtil.formatString(contactInfo.getAccount()) + " thirdUserId: " + StringUtil.formatString(contactInfo.getThirdUserId()) + " sipNumber: " + StringUtil.formatString(contactInfo.getSipNumber()) + " extendedField: " + StringUtil.formatString(extendedField) + " realNameAccount : " + StringUtil.formatName(contactInfo.getRealNameAccount())); // 第三方查询通讯录,返回对应用户的头像图片,这里返回一张默认图片作为示例代码 return BitmapFactory.decodeResource(resources, R.mipmap.ic_launcher); } }); 父主题: 界面定制
  • 修订记录 表1 修订记录 日期 版本 修订内容 2025-4-18 110.3.9 1. 支持企业池通讯录查询及邀请入会能力,新增企业ID字段。 2. 新增设置头像风格接口setAvatarStyle。 具体使用请见110.3.9更新内容 2025-3-27 110.3.5 1. 新增等候室成员列表变更通知onWaitingListChanged。 2. 新增设置管理面 域名 对应的保底ip地址接口setGlobalGuaranteedIpAddresses。 3. 新增获取自己开启共享状态接口getSelfShareState。 4. 新增结束共享接口stopShare。 5. 新增双击与会者项通知onDoubleClickParticipantListItemNotify。 6. 开启功能接口新增隐藏邀请结果提示枚举值HWM_CAPABILITY_HIDE_INVITE_RESULT_TOAST、隐藏与会者列表未入会标签枚举值HWM_CAPABILITY_SUPPORT_HIDE_OFFLINE_PARTICIPANT_LIST、是否支持自动接受远程控制(仅对win平台生效)HWM_CAPABILITY_SUPPORT_AUTO_ACCEPT_REMOTE_CONTROL。 7. 本地录制状态更新通知新增参数录制开始时间startTime。 8. 预约会议、编辑会议、周期会议新增会议开始时间startTimeStamp 、会议结束时间endTimeStamp,废弃原有字段startTime 、endTime。 9. 会议结束通知新增参数会议id confId。 具体使用请见110.3.5更新内容 2025-3-14 100.12.16 1. 问题修复,体验更稳定。 具体使用请见100.12.16更新内容 2025-2-28 100.12.13 1. 问题修复,体验更稳定。 具体使用请见100.12.13更新内容 2025-1-2 100.12.5 1. 新增接受会议邀请接口(仅win支持)、拒绝会议邀请接口(仅win支持)。 2. 新增本地录制状态更新通知(仅Mac支持)。 3. 发起立即会议接口新增参数是否来宾免密isGuestJoinConfWithoutPwd、允许入会范围限制confAllowJoinUser。 具体使用请见100.12.5更新内容 2024-12-3 100.10.7 1. 问题修复,体验更稳定。 具体使用请见100.10.7更新内容 2024-11-27 100.10.6 1. 问题修复,体验更稳定。 具体使用请见100.10.6更新内容 2024-11-18 100.10.5 1. Mac新增支持苹果自研M系列芯片版ElectronSDK。 2. 新增设置会控栏自动隐藏接口(仅win支持)。 3. 新增自定义指定场景文案接口。 4. 新增自定义指定场景图标接口(仅win支持)。 具体使用请见100.10.5更新内容 2024-10-31 100.9.7 1. 问题修复,体验更稳定。 具体使用请见100.9.7更新内容 2024-10-12 100.9.5 1. 新增会议开始时间startTimeStamp 、会议结束时间endTimeStamp,废弃原有字段startTime 、endTime。 2. 新增添加与会者结果通知OnAddAttendeeNotify。 3. 新增与会者列表全部呼叫注入通知OnClickInjectCallAllBtnNotify。 4. 新增用户数据路径变化通知OnUserSavePathChanged。 5. 会议来电信息新增thirdUserId第三方用户ID。 6. 点击注入按钮类型ClickInjectBtn新增与会者列表全部呼入HWM_CLICK_INJECT_BTN_CALL_ALL。 具体使用请见100.9.5更新内容 2024-10-12 100.7.13 1. 问题修复,体验更稳定。 具体使用请见100.7.13更新内容 2024-8-23 100.7.8 1. 问题修复,体验更稳定。 具体使用请见100.7.8更新内容 2024-8-16 100.7.6 1. 问题修复,体验更稳定。 具体使用请见100.7.6更新内容 2024-8-5 100.7.5 1. 新增设置登录服务器信息接口setServerAddress。 2. 新增设置代理信息接口setProxy。 3. 新增设置证书校验信息接口setCAVerifyInfo。 4. 新增设置屏幕共享中需透明的窗口接口setTransparentWnd。 5. 新增发起投屏接口startProjection。 6. 新增会中信息更新通知onMeetingInfoChanged。 7. 主窗口信息新增handle字段。 8. 预约会议、编辑会议、创建会议、获取会议详情新增autoMuteMode软终端是否自动静音、hardTerminalAutoMuteMode硬终端是否自动静音、defaultSummaryState会议云录制是否包含纪要。 9. 会议来电信息新增isP2pConf是否立即会议。 10. 企业配置通知新增corpEnableSummary企业是否支持会议纪要。 具体使用请见100.7.5更新内容 2024-6-13 100.5.5 1. 新增音频码流帧数据通知onAudioFrameNotify。 2. 新增音频码流开关接口setAudioRawDataOutputConfig。 3. 与会者基础信息新增userUUID字段。 具体使用请见100.5.5更新内容 2024-5-9 100.3.7 1. Mac平台修复会中不显示自定义头像问题,体验更稳定。 具体使用请见100.3.7更新内容 2024-4-23 100.3.6 1. 功能配置开关接口enableCapability新增是否支持与会者邀请枚举值HWM_CAPABILITY_SUPPORT_GUEST_INVITE。 2. 问题修复,体验更稳定。 具体使用请见100.3.6更新内容 2024-2-17 90.12.7 1. 问题修复,体验更稳定。 具体使用请见90.12.7更新内容 2024-1-5 90.12.5 1. 新增显示提示信息接口showToast。 2. 新增获取主窗口信息接口getMainWindowInfo。 3. 创建会议、预约会议新增参数会议资源类型confResType。 4. 新增共享vmr信息通知onShareVmrInfoNotify。 5. 新增获取错误提示接口getErrorMessage,文案可用于提示。 6. 新增设置(会控)保底ip地址接口setGuaranteedIpAddresses,支持下沉企业数据不上云或断网逃生。 7. config接口新增配置字段copy_audience_conf_info,支持网络研讨会中观众链接的复制按钮可注入。 具体使用请见90.12.5更新内容 2023-12-13 90.10.8 1. 问题修复,体验更稳定。 具体使用请见90.10.8更新内容 2023-11-23 90.10.5 1. 新增MMR立即会议记录回调onP2PConfRecordNotify。 2. ElectronSDK支持node文件与Electron版本解耦,集成方不用再重新编译node文件。 3. ElectronSDK工程包删除编译node文件的相关脚本。 具体使用请见90.10.5更新内容 2023-10-9 90.9.5 1. 新增concurrentParticipants 会议方数,会议最大与会人数限制。 2. 新增日志路径设置接口setLogPath。 3. 新增会议来电通知onConfIncomingNotify。 具体使用请见90.9.5更新内容 2023-8-24 90.7.5 windows平台问题修复,体验更稳定。 2023-8-10 90.7.5 1. 新增发起立即会议接口startP2pConf。 2. 新增获取用户保存路径接口getUserSavePath。 3. Random入会新增参数域名domain,离线入会场景使用。 具体使用请见90.7.5更新内容 2023-6-1 90.6.5 1. 发起呼叫接口StartCall废弃 2. 预约会议、编辑会议、创建会议、获取会议详情、会议信息通知新增用户自定义信息字段customInfo。 3. Init接口新增是否支持同终端多应用登录字段isSupportMultiAppLogin。 4. 新增弱网信息通知OnPoorNetworkQualityInfoNotify。 5. 新增错误码412100044(服务器降级),接入方收到该错误码时,可以继续调用入会接口离线入会(该错误码的适配方式请参考Demo)。 具体使用请见90.6.5更新内容 2023-5-11 80.15.21 1. 问题修复,体验更稳定。 具体使用请见80.15.21更新内容 2023-3-29 80.15.5 1. 设置网络模式接口setNetworkMode新增参数isForcedVpn。 具体使用请见80.15.5更新内容 2023-2-23 80.13.6 1. 问题修复,体验更稳定。 具体使用请见80.13.6更新内容 2023-2-7 80.13.5 1. 设置语言接口setLanguage新增自定义语言功能。 具体使用请见80.13.5更新内容 2023-1-17 80.12.7 1. 问题修复,体验更稳定。 具体使用请见80.12.7更新内容 2023-1-9 80.12.6 1. 功能配置开关接口enableCapability新增是否显示录制安全提示窗枚举值HWM_CAPABILITY_CONFIRM_RECORD。 2. 问题修复,体验更稳定。 具体使用请见80.12.6更新内容 2022-12-24 80.12.5 1.上传头像接口上传条件变更(增加类型和大小判断),win支持上传头像接口。 2. 问题修复,体验更稳定。 具体使用请见80.12.5更新内容 2022-11-16 80.10.5 1. 获取VMR列表接口和修改云会议室信息接口新增参数confAllowJoinUser、isOpenWaitingRoom。 2. 新增设置共享权限接口SetShareScreenPermission。 3. 加入会议接口新增参数isStopConflictConf。 4. 获取会议详情新增参数vmrConfIdType。 5. AppId登录接口新增参数deptCode。 具体使用请见80.10.5更新内容 2022-10-8 80.9.5 1. Mac补充获取会议详情、编辑会议接口新增参数allowLive。 2. 新增周期会议相关接口。 3. 功能配置开关接口新增分组讨论功能开关枚举值HWM_CAPABILITY_BREAKOUT_CONF。 4. 会议信息通知新增参数isInBreakoutSubConf。 5. Electron SDK补充常见错误码。 具体使用请见80.9.5更新内容 2022-9-2 80.8.5 1. 获取会议详情、编辑会议接口新增参数allowLive。 2. 会议信息通知新增参数isCreator。 3. 预约会议、编辑会议支持设置“来宾在主持人之前加入会议”,并可设置提前入会时间(allowGuestStartConf、allowGuestStartConfTime)。 具体使用请见80.8.5更新内容 2022-7-30 80.7.5 1. 新增显示设置界面接口showSettingWindow。 2. 会议信息通知OnConfInfoNotify新增参数isOtherCorpConf。 3. 与会者列表子项注入点击通知OnClickInjectParticipantItemBtnNotify新增与会者详情按钮类型HWM_CLICK_INJECT_PARTICIPANT_ITEM_BTN_PARTICIPANT_DETAIL,新增华为云会议账号参数accountId。 4. Config接口新增字段participant_detail,支持与会者头像点击注入。 具体使用请见80.7.5更新内容 2022-6-17 80.5.11 1.config接口新增字段statusBar,支持录制状态栏按钮可隐藏。 2.新增禁用提示音接口disableVoicePrompts。 具体使用请见80.5.11更新内容 2022-5-18 80.5.5 1. Mac补充exit接口。 2. Mac创建会议、预约会议、编辑会议、获取会议详情接口补充等候室开关功能。 3. 功能配置开关接口新增隐藏非视频与会者配置。 4. 会议结束通知新增服务器异常错误码。 具体使用请见80.5.5 更新内容 2022-04-16 70.16.5 首次发布 父主题: Electron SDK
  • 接口功能 该接口用于预约周期会议。注意事项:1、该接口在已登录状态下才能调用。2、该接口为异步接口,返回值只代表接口是否调用成功,实际业务处理结果在对应的回调函数中返回。 3、会议开始时间必须晚于当前时间,会议时长应大于15分钟。4、携带与会者入会的时候需要传入attendees。5、周期会议最大跨度一年,会议数量不超过50,超过则只预约前50个会议。 6、回调函数中会返回预约成功后的会议详情,详见HwmConfDetail结构体表。如果参数内只有会议id有值则获取会议详情失败。
  • 界面定制 用户可以根据需求自定义一些会控菜单。 本章节自定义菜单示例代码为SDK默认,根据自己需求增加(增加的type值不能与SDK中HWMConfCtrlType的定义重复)或者减少。 界面配置 清除界面配置 社交分享定制 底部工具栏定制 与会者列表菜单定制 会议页面顶部titlebar菜单定制 联系人UI定制 头像拦截显示 自定义会中水印 录制按钮操作定制 获取错误提示 自定义指定场景文案 自定义指定场景图标 自定义虚拟背景图片添加按钮事件 呼叫其他号码列表定制 拦截发起共享定制 设置与会者头像风格 父主题: 接口参考
  • 界面定制 用户可以根据需求自定义一些界面 界面配置 清除界面配置 底部工具栏定制 共享工具栏定制 底部工具栏更多菜单定制 共享工具栏更多菜单定制 社交分享定制 选择联系人定制 头像拦截显示 其它UI定制 自定义会中水印 自定义设置界面 联系人信息定制 录制按钮操作定制 显示设置窗口 与会者列表子项定制 显示提示信息 获取主窗口信息 获取错误提示 设置支持显示会控助手 自定义指定场景文案 呼叫其他号码列表定制 拦截发起共享定制 设置头像风格 父主题: 接口参考
  • 参数描述 表1 结构体HwmPoorNetWorkQualityInfo参数说明 参数 类型 描述 nickName char[] 与会者名称。 number char[] 号码。如果填分配给账号的sip号码(如+99111244216210249)则呼叫该账号的App;如果填PSTN号码(如18700000000),则通过VoIP网关呼叫该号码,前提是该企业已开通PSTN呼叫权限。与thirdUserId二选一,账号密码鉴权时使用。 thirdUserId char[] 第三方用户ID。与number二选一,App ID鉴权时使用。 accountId char[] 华为云会议账号 orgId char[] 企业id isLocal bool 是否本端 audioStatus HwmLowNetWorkStatusInfo 音频网络状态 videoStatus HwmLowNetWorkStatusInfo 视频网络状态 shareStatus HwmLowNetWorkStatusInfo 共享网络状态 表2 结构体HwmLowNetWorkStatusInfo参数说明 参数 类型 描述 packetLoss unsigned int 丢包 delay unsigned int 延迟 jitter unsigned int 抖动 status HwmLowNetWorkStatus 状态 表3 枚举HwmLowNetWorkStatus说明 枚举值 描述 LOW_NET_WORK_STATUS_NORMAL 网络正常 LOW_NET_WORK_STATUS_BAD 网络差 LOW_NET_WORK_STATUS_VERY_BAD 网络非常差
共100000条
提示

您即将访问非华为云网站,请注意账号财产安全