华为云用户手册

界面定制 用户可以根据需求自定义一些会控菜单。 本章节自定义菜单示例代码为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 网络非常差

downloadHeadPortraitWithThirdAccount: account: number: completionBlock: 接口描述 该接口用于定制登录后的头像显示。 图2 生效后拦截头像显示效果 注意事项 未登录的头像不支持自定义。 头像支持两种情况：一种主动上传，见上传个人头像接口；一种为注入实现，若两种都实现只会进行拦截的实现，不会从服务端下载上传的头像。 方法定义 1 - (void)downloadHeadPortraitWithThirdAccount:(NSString *)thirdAccount account:(NSString *)account number:(NSString *)number completionBlock:(void (^)(NSError * _Nullable, NSString * _Nullable))completionBlock 参数描述 表2 参数说明 参数 类型 描述 thirdAccount NSString appid登录场景下优先使用此字段 account NSString 账号密码登录场景下 优先使用此字段 number NSString 跨企业场景优先使用此字段 返回值 无 示例代码 - (void)downloadHeadPortraitWithThirdAccount:(NSString *)thirdAccount account:(NSString *)account number:(NSString *)number completionBlock:(void (^)(NSError * _Nullable, NSString * _Nullable))completionBlock { if (completionBlock) { /// 将图片路径返回给SDK NSInteger index = arc4random() % 3; NSString *path = [[NSBundle bundleForClass:[self class]] pathForResource:[NSString stringWithFormat:@"head_icon_%lu", index] ofType:@"png"]; completionBlock(nil, path); } }

queryContactAvatarWithContactInfo: completionBlock: 接口描述 该接口用于定制登录后的头像显示。 图1 生效后拦截头像显示效果 注意事项 未登录的头像不支持自定义。 头像支持两种情况：一种主动上传，见上传个人头像接口；一种为注入实现，若两种都实现只会进行拦截的实现，不会从服务端下载上传的头像。 方法定义 1 2 - (void)queryContactAvatarWithContactInfo:(HWMUISDKContactInfoModel *)contactInfo completionBlock:(void (^)(NSError *_Nullable error, NSString *_Nullable headImagePath))completionBlock; 参数描述 表1 HWMUISDKContactInfoModel 参数说明 参数 类型 描述 thirdUserId NSString appid登录场景下优先使用此字段 accountId NSString 账号密码登录场景下 优先使用此字段 number NSString 跨企业场景优先使用此字段 corpId NSString 企业ID 返回值 无 示例代码 - (void)downloadHeadPortraitWithThirdAccount:(HWMUISDKContactInfoModel *)contactInfo completionBlock:(void (^)(NSError * _Nullable, NSString * _Nullable))completionBlock { if (completionBlock) { /// 将图片路径返回给SDK NSInteger index = arc4random() % 3; NSString *path = [[NSBundle bundleForClass:[self class]] pathForResource:[NSString stringWithFormat:@"head_icon_%lu", index] ofType:@"png"]; completionBlock(nil, path); } }

startP2PConf 接口描述 该接口用于发起立即会议。 注意事项 1. 实际业务处理结果在对应的callback回调中。 方法定义 - (void)startP2PConf:(HWMStartP2PConfParam *)param callback:(_Nonnull HWMSDKCreateConfCompleteHandler)callback; 参数描述 参数 是否必须 类型 描述 param 是 HWMStartP2PConfParam * 发起立即会议信息。 表1 HWMStartP2PConfParam 说明 参数 是否必须 类型 描述 calleeInfo 是 HWMCalleeInfo * 被叫信息。 callerInfo 是 HWMCallerInfo * 主叫信息。 mediaType 是 HWMMediaType 媒体类型。 isGuestJoinConfWithoutPwd 是 BOOL 是否来宾免密码入会。默认NO。 confAllowJoinUser 是 HWMJoinConfRestrictionType 允许入会的用户类型。默认HWMJoinConfRestrictionAll。 表2 HWMCallerInfo 说明 参数 是否必须 类型 描述 nickName 否 NSString * 主叫姓名。 表3 HWMCalleeInfo 说明 参数 是否必须 类型 描述 nickName 否 NSString * 被叫姓名。 number 是 NSString * 被叫号码。如果填分配给账号的sip号码（如+99111244216210249）则呼叫该账号的App；如果填PSTN号码（如18700000000），则通过VoIP网关呼叫该号码，前提是该企业已开通PSTN呼叫权限。与thirdUserId二选一，账号密码鉴权时使用。 thirdUserId 是 NSString * 第三方用户ID。与number二选一，App ID鉴权时使用。 type 是 HWMConfAttendeeType 用户类型。默认 HWMConfAttendeeTypeNormal。 orgId 否 NSString * 企业ID。 表4 枚举HWMConfAttendeeType说明 枚举值 描述 HWMConfAttendeeTypeNormal 会议软终端用户。 HWMConfAttendeeTypeMobile 用户手机号码。 返回值 无 示例代码 - (void)startP2PConf { // 设置被叫信息 HWMCalleeInfo *calleeInfo = [[HWMCalleeInfo alloc] init]; calleeInfo.nickName = @"被叫姓名"; calleeInfo.number = @"123456"; calleeInfo.thirdUserId = @"123456"; // 设置主叫信息 HWMCallerInfo *callerInfo = [[HWMCallerInfo alloc] init]; callerInfo.nickName = @"主叫姓名"; HWMStartP2PConfParam *param = [[HWMStartP2PConfParam alloc] init]; // 设置媒体类型 param.mediaType = HWMMediaTypeVideo; param.calleeInfo = calleeInfo; param.callerInfo = callerInfo; // 调用SDK接口 [[HWMSdk getOpenApi] startP2PConf:param callback:^(NSError * _Nullable error, HWMCreateConfResult * _Nullable result) { if (error) { [UIUtil showMessageWithError:error]; } else { [UIUtil showMessage:[NSString stringWithFormat:@"会议ID：%@, isP2PConf:%@", result.confId, result.isP2PConf?@"YES":@"NO"]]; } }]; }

110.3.9更新内容 1.支持企业池通讯录查询及邀请入会能力，与会者HwmConfAttendee、被叫信息HwmCalleeInfo、qos弱网提示信息HwmPoorNetWorkQualityInfo、邀请与会者结果信息HwmAddAttendeeResult、与会者列表子项信息HwmParticipantItemInfo新增字段orgId企业id，详见表1，表3，表1，表2，表1 2.新增接口SetAvatarStyle设置头像风格，详见设置头像风格 父主题： 版本更新内容

110.3.9更新内容 1. 支持企业池通讯录查询及邀请入会能力，新增企业ID字段，具体请见HWMAttendeeInfo参数说明、HWMUISDKCalleeInfoModel参数说明、HWMUISDKContactInfoModel参数说明、HWMSDKPoorNetWorkQualityInfoModel参数说明、HWMSDKAddAttendeeInfoModel参数说明。 2. 新增设置头像风格接口setAvatarStyle，具体请见设置头像风格。 父主题： 版本更新内容

110.3.9更新内容 新增设置与会者头像风格接口 setParticipantAvatarStyle，详见设置与会者头像风格。 新增企业ID字段，详见HWMConfQueryAvatarModel参数说明、HWMCreateConfMember参数说明、HWMContactSelectedModel 说明、HWMCalleeInfo 说明、HWMAttendeeInfo 参数说明。 父主题： 版本更新内容

调用API示例 在工程中引入sdk（signer.go）。 import "apig-sdk/go/core" 生成一个新的Signer，输入AppKey和AppSecret。 本示例以AK和SK保存在环境变量中为例，运行本示例前请先在本地环境中设置环境变量HUAWEICLOUD_SDK_AK和HUAWEICLOUD_SDK_SK。以Linux系统为例在本地将已获取的AK/SK设置为环境变量。 打开终端，输入以下命令打开环境变量配置文件。 vi ~/.bashrc 设置环境变量，保存文件并退出编辑器。 export HUAWEICLOUD_SDK_AK="已获取AK值" export HUAWEICLOUD_SDK_SK="已获取SK值" 输入以下命令使配置文件生效。 source ~/.bashrc 生成一个新的Signer，填入已设置的环境变量。 s := core.Signer{ // Directly writing AK/SK in code is risky. For security, encrypt your AK/SK and store them in the configuration file or environment variables. // In this example, the AK/SK are stored in environment variables for identity authentication. Before running this example, set environment variables HUAWEICLOUD_SDK_AK and HUAWEICLOUD_SDK_SK. Key: os.Getenv("HUAWEICLOUD_SDK_AK"), Secret: os.Getenv("HUAWEICLOUD_SDK_SK"), } 生成一个新的Request，指定 域名 、方法名、请求url、query和body。 r, _ := http.NewRequest("POST", "http://c967a237-cd6c-470e-906f-a8655461897e.apigw.exampleRegion.com/api?a=1&b=2", ioutil.NopCloser(bytes.NewBuffer([]byte("foo=bar")))) 给请求添加x-stage头，内容为环境名。如有需要，添加需要签名的其他头域。 r.Header.Add("x-stage", "RELEASE") 进行签名，执行此函数会在请求中添加用于签名的X-Sdk-Date头和Authorization头。 s.Sign(r) 访问API，查看访问结果。 resp, err := http.DefaultClient.Do(r) body, err := ioutil.ReadAll(resp.Body)

获取SDK 请在API网关控制台选择“帮助中心”，在“SDK使用指引”页签中下载对应语言所使用SDK。 或直接下载SDK的最新版本，获取“ApiGateway-cpp-sdk.zip”压缩包，解压后目录结构如下： 名称 说明 hasher.cpp SDK代码 hasher.h header.h RequestParams.cpp RequestParams.h signer.cpp signer.h Makefile Makefile文件 main.cpp 示例代码

准备环境 已在API网关控制台创建签名密钥，并绑定API，具体请参见创建并使用签名密钥。 已获取签名密钥的Key和Secret，请参见签名前准备获取。 请在API网关控制台选择“帮助中心”，在“SDK使用指引”页签中下载对应语言所使用SDK。或直接下载SDK的最新版本。 已安装Python安装包2.7.9或3.X版本，如果未安装，请至Python官方下载页面下载。 已安装IntelliJ IDEA 2018.3.5或以上版本，如果未安装，请至IntelliJ IDEA官方网站下载。 已在IntelliJ IDEA中安装Python插件，如果未安装，请按照图1所示安装。 图1 安装Python插件

调用API示例 把API信息替换到HttpClientDemo.java中对应位置。 本示例以AK和SK保存在环境变量中为例，运行本示例前请先在本地环境中设置环境变量HUAWEICLOUD_SDK_AK和HUAWEICLOUD_SDK_SK。以Linux系统为例在本地将已获取的AK/SK设置为环境变量。 打开终端，输入以下命令打开环境变量配置文件。 vi ~/.bashrc 设置环境变量，保存文件并退出编辑器。 export HUAWEICLOUD_SDK_AK="已获取AK值" export HUAWEICLOUD_SDK_SK="已获取SK值" 输入以下命令使配置文件生效。 source ~/.bashrc 把API信息和已设置的环境变量替换到HttpClientDemo.java中对应位置。 HttpClientDemo中引用以下类，可在“获取SDK”包中的“src”文件下查看： Constant：SDK包中使用的常量类。 SSLCipherSuiteUtil：tls认证配置参数的工具类，比如配置客户端不校验证书。 UnsupportProtocolException：异常处理类。 public class HttpClientDemo { private static final Logger LOG GER = LoggerFactory.getLogger(HttpClientDemo.class); public static void main(String[] args) throws Exception { // Create a new request. Request httpClientRequest = new Request(); try { // Set the request parameters. // AppKey, AppSecrect, Method and Url are required parameters. // Directly writing AK/SK in code is risky. For security, encrypt your AK/SK and store them in the configuration file or environment variables. // In this example, the AK/SK are stored in environment variables for identity authentication. // Before running this example, set environment variables HUAWEICLOUD_SDK_AK and HUAWEICLOUD_SDK_SK. httpClientRequest.setKey(System.getenv("HUAWEICLOUD_SDK_AK")); httpClientRequest.setSecret(System.getenv("HUAWEICLOUD_SDK_SK")); httpClientRequest.setMethod("POST"); // Set a request URL in the format of https://{Endpoint}/{URI}. httpClientRequest.setUrl("put your request url here"); httpClientRequest.addHeader("Content-Type", "text/plain"); // Set a body for http request. httpClientRequest.setBody("put your request body here"); } catch (Exception e) { LOGGER.error(e.getMessage()); return; } CloseableHttpClient client = null; try { // Sign the request. HttpRequestBase signedRequest = Client.sign(httpClientRequest, Constant.SIGNATURE_ALGORITHM_SDK_HMAC_SHA256); if (Constant.DO_VERIFY) { // creat httpClient and verify ssl certificate HostName.setUrlHostName(httpClientRequest.getHost()); client = (CloseableHttpClient) SSLCipherSuiteUtil.createHttpClientWithVerify(Constant.INTERNATIONAL_PROTOCOL); } else { // creat httpClient and do not verify ssl certificate client = (CloseableHttpClient) SSLCipherSuiteUtil.createHttpClient(Constant.INTERNATIONAL_PROTOCOL); } HttpResponse response = client.execute(signedRequest); // Print the body of the response. HttpEntity resEntity = response.getEntity(); if (resEntity != null) { LOGGER.info("Processing Body with name: {} and value: {}", System.getProperty("line.separator"), EntityUtils.toString(resEntity, "UTF-8")); } } catch (Exception e) { LOGGER.error(e.getMessage()); } finally { if (client != null) { client.close(); } } } } 运行HttpClientDemo.java，对请求进行签名、访问API并打印结果。 示例结果如下： [main] INFO com.huawei.apig.sdk.demo.HttpClientDemo - Print the authorization: [Authorization: SDK-HMAC-SHA256 Access=3afe***ba29, SignedHeaders=host;x-sdk-date, Signature=26b2***dbf6] [main] INFO com.huawei.apig.sdk.demo.HttpClientDemo - Print the status line of the response: HTTP/1.1 200 OK [main] INFO com.huawei.apig.sdk.demo.HttpClientDemo - Processing Header with name: Date and value: Fri, 26 Aug 2022 08:58:51 GMT [main] INFO com.huawei.apig.sdk.demo.HttpClientDemo - Processing Header with name: Content-Type and value: application/json [main] INFO com.huawei.apig.sdk.demo.HttpClientDemo - Processing Header with name: Transfer-Encoding and value: chunked [main] INFO com.huawei.apig.sdk.demo.HttpClientDemo - Processing Header with name: Connection and value: keep-alive [main] INFO com.huawei.apig.sdk.demo.HttpClientDemo - Processing Header with name: Server and value: api-gateway [main] INFO com.huawei.apig.sdk.demo.HttpClientDemo - Processing Header with name: X-Request-Id and value: 10955c5346b9512d23f3fd4c1bf2d181 [main] INFO com.huawei.apig.sdk.demo.HttpClientDemo - Processing Body with name: and value: {"200": "sdk success"} 显示{"200": "sdk success"}，表示签名成功，API成功请求到后端。 如果改变AK或SK的值，API网关将返回的错误信息error_msg。

获取SDK 请在API网关控制台选择“帮助中心”，在“SDK使用指引”页签中下载对应语言所使用SDK。 或直接下载SDK的最新版本，获取“ApiGateway-java-sdk.zip”压缩包，解压后目录结构如下： 名称 说明 libs\java-sdk-core-x.x.x.jar 签名SDK pom.xml 构建Maven工程所需，定义其他依赖包 changelog 变更日志 src 验证签名SDK的demo代码: WebSocketDemo.java OkHttpDemo.java、 LargeFileUploadDemo.java HttpClientDemo.java 引用类: Constant.java SSLCipherSuiteUtil.java UnsupportProtocolException.java

调用API示例 获取Token ，并设置成环境变量，Token用于后续调用其他接口鉴权。 获取用户Token，请求内容示例如下： curl -X POST https://{iam_endpoint}/v3/auth/tokens -H 'content-type: application/json' -d '{ "auth": { "identity": { "methods": [ "password" ], "password": { "user": { "name": "{user_name}", "domain": { "name": "{user_name}" }, "password": "{password}" } } }, "scope": { "project": { "id": "{project_id}" } } } }' -vk 上述命令中，部分参数请参见以下说明进行修改，具体请参考《 统一身份认证 服务API参考》的获取用户Token接口： {iam_endpoint}请参见地区和终端节点获取。 {user_name}和{password}分别替换为连接 IAM 服务器的用户名和密码。 {project_id}为项目ID。在管理控制台，将鼠标移至用户名，在下拉列表中单击“我的凭证”，查看“项目ID”。 请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值，如下图所示： 图1 从返回消息的Header中获取X-Subject-Token 使用如下命令将token设置为环境变量，方便后续事项。 export Token={X-Subject-Token} X-Subject-Token即为1.a获取到的token，命令示例如下： export Token=MIIDkg******BZQMEAgEwg 调用API，请参考认证前准备获取域名、请求方法和URL，并在请求消息头中增加“X-Auth-Token”，“X-Auth-Token”的取值为1中获取的Token。参数请根据实际情况填写。 curl -X 请求方法 域名+URL -H "x-auth-token: $Token" -vk

步骤3：计算签名 将APP secret和创建的待签字符串作为加密哈希函数的输入，计算签名，将二进制值转换为十六进制表示形式。 伪代码如下： signature = HexEncode(HMAC(APP secret, string to sign)) 其中HMAC指密钥相关的哈希运算，HexEncode指转十六进制。伪代码中参数说明如表1所示。 表1 参数说明 参数名称 参数解释 APP secret 签名密钥 string to sign 创建的待签字符串 假设APP secret为FWTh***XMD8，则计算得到的signature为： 5ac0b7c4035112cd840397e12d10cd1ca065328d03a6242d5cbfbbd63659c011

步骤4：添加签名信息到请求头 在计算签名后，将它添加到Authorization的HTTP消息头。Authorization消息头未包含在已签名消息头中，主要用于身份验证。 伪代码如下： Authorization header创建伪码： Authorization: algorithm Access=APP key, SignedHeaders=SignedHeaders, Signature=signature 需要注意的是算法与Access之前没有逗号，但是SignedHeaders与Signature之前需要使用逗号隔开。 得到的签名消息头为： Authorization: SDK-HMAC-SHA256 Access=FM9RLCN************NAXISK, SignedHeaders=host;x-sdk-date, Signature=01cc37e53d***e00b15822 得到签名消息头后，将其增加到原始HTTP请求内容中，请求将被发送给API网关，由API网关完成身份认证。身份认证通过后，该请求才会发送给后端服务进行业务处理。

步骤1：构造规范请求 使用APP方式进行签名与认证，首先需要规范请求内容，然后再进行签名。客户端与API网关使用相同的请求规范，可以确保同一个HTTP请求的前后端得到相同的签名结果，从而完成身份校验。 HTTP请求规范伪代码如下： CanonicalRequest = HTTPRequestMethod + '\n' + CanonicalURI + '\n' + CanonicalQueryString + '\n' + CanonicalHeaders + '\n' + SignedHeaders + '\n' + HexEncode(Hash(RequestPayload)) 通过以下示例来说明规范请求的构造步骤。 假设原始请求如下： GET https://c967a237-cd6c-470e-906f-a8655461897e.apigw.exampleRegion.com/app1?b=2&a=1 HTTP/1.1 Host: c967a237-cd6c-470e-906f-a8655461897e.apigw.exampleRegion.com X-Sdk-Date: 20191111T093443Z 构造HTTP请求方法（HTTPRequestMethod），以换行符结束。 HTTP请求方法，如GET、PUT、POST等。请求方法示例： GET 添加规范URI参数（CanonicalURI），以换行符结束。 释义： 规范URI，即请求资源路径，是URI的绝对路径部分的URI编码。 格式： 根据RFC 3986标准化URI路径，移除冗余和相对路径部分，路径中每个部分必须为URI编码。如果URI路径不以“/”结尾，则在尾部添加“/”。 举例： 示例中的URI：/app1，此时规范的URI编码为： GET /app1/ 计算签名时，URI必须以“/”结尾。发送请求时，可以不以“/”结尾。 添加规范查询字符串（CanonicalQueryString），以换行符结束。 释义： 查询字符串，即查询参数。如果没有查询参数，则为空字符串，即规范后的请求为空行。 格式： 规范查询字符串需要满足以下要求： 根据以下规则对每个参数名和值进行URI编码： 请勿对RFC 3986定义的任何非预留字符进行URI编码，这些字符包括：A-Z、a-z、0-9、-、_、.和~。 使用%XY对所有非预留字符进行百分比编码，其中X和Y为十六进制字符（0-9和A-F）。例如，空格字符必须编码为%20，扩展UTF-8字符必须采用“%XY%ZA%BC”格式。 对于每个参数，追加“URI编码的参数名称=URI编码的参数值”。如果没有参数值，则以空字符串代替，但不能省略“=”。 例如以下含有两个参数，其中第二个参数parm2的值为空。 parm1=value1&parm2= 按照字符代码以升序顺序对参数名进行排序。例如，以大写字母F开头的参数名排在以小写字母b开头的参数名之前。 以排序后的第一个参数名开始，构造规范查询字符串。 举例： 示例中包含两个可选参数：a、b GET /app1/ a=1&b=2 添加规范消息头（CanonicalHeaders），以换行符结束。 释义： 规范消息头，即请求消息头列表。包括签名请求中的所有HTTP消息头列表。消息头必须包含X-Sdk-Date，用于校验签名时间，格式为ISO8601标准的UTC时间格式：YYYYMMDDTHHMMSSZ。如果API发布到非RELEASE环境时，需要增加自定义的环境名称。 客户端须注意本地时间与时钟服务器的同步，避免请求消息头X-Sdk-Date的值出现较大误差。 API网关除了校验时间格式外，还会校验该时间值与网关收到请求的时间差，如果时间差大于15分钟，API网关将拒绝请求。 格式： CanonicalHeaders由多个请求消息头共同组成，CanonicalHeadersEntry0 + CanonicalHeadersEntry1 + ...，其中每个请求消息头（CanonicalHeadersEntry）的格式为Lowercase(HeaderName) + ':' + Trimall(HeaderValue) + '\n' Lowercase：表示将所有字符转换为小写字母的函数。 Trimall：表示删除值前后的多余空格的函数。 最后一个请求消息头也会携带一个换行符。叠加规范中CanonicalHeaders自身携带的换行符，因此会出现一个空行。 消息头名称要保持唯一性，出现多个相同消息头名称时，无法完成认证。 举例： GET /app1/ a=1&b=2 host:c967a237-cd6c-470e-906f-a8655461897e.apigw.exampleRegion.com x-sdk-date:20191111T093443Z 规范消息头需要满足以下要求： 将消息头名称转换为小写形式，并删除前导空格和尾随空格。 按照字符代码对消息头名称进行升序排序。 例如原始消息头为： Host: c967a237-cd6c-470e-906f-a8655461897e.apigw.exampleRegion.com\n Content-Type: application/json;charset=utf8\n My-header1: a b c \n X-Sdk-Date:20191111T093443Z\n My-Header2: "a b c" \n 规范消息头为： content-type:application/json;charset=utf8\n host:c967a237-cd6c-470e-906f-a8655461897e.apigw.exampleRegion.com\n my-header1:a b c\n my-header2:"a b c"\n x-sdk-date:20191111T093443Z\n 添加用于签名的消息头声明（SignedHeaders），以换行符结束。 释义： 用于签名的请求消息头列表。通过添加此消息头，向API网关告知请求中哪些消息头是签名过程的一部分，以及在验证请求时API网关可以忽略哪些消息头。X-Sdk-date必须作为已签名的消息头。 格式： SignedHeaders = Lowercase(HeaderName0) + ';' + Lowercase(HeaderName1) + ";" + ... 已签名的消息头需要满足以下要求：将已签名的消息头名称转换为小写形式，按照字符代码对消息头进行排序，并使用“;”来分隔多个消息头。 Lowercase表示将所有字符转换为小写字母。 举例： 以下表示有两个消息头参与签名：host、x-sdk-date GET /app1/ a=1&b=2 host:c967a237-cd6c-470e-906f-a8655461897e.apigw.exampleRegion.com x-sdk-date:20191111T093443Z host;x-sdk-date 基于HTTP或HTTPS请求正文中的body体（RequestPayload），使用SHA-256哈希函数创建哈希值。 释义： 请求消息体。消息体需要做两层转换：HexEncode(Hash(RequestPayload))，其中Hash表示生成消息摘要的函数，当前支持SHA-256算法。HexEncode表示以小写字母形式返回摘要的Base-16编码的函数。例如，HexEncode("m") 返回值为“6d”而不是“6D”。输入的每一个字节都表示为两个十六进制字符。 计算RequestPayload的哈希值时，对于“RequestPayload==null”的场景，直接使用空字符串""来计算。 举例： 本示例为GET方法，body体为空。经过哈希处理的body（空字符串）如下： GET /app1/ a=1&b=2 host:c967a237-cd6c-470e-906f-a8655461897e.apigw.exampleRegion.com x-sdk-date:20191111T093443Z host;x-sdk-date e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855 对构造好的规范请求进行哈希处理，算法与对RequestPayload哈希处理的算法相同。经过哈希处理的规范请求必须以小写十六进制字符串形式表示。 算法伪代码：Lowercase(HexEncode(Hash.SHA256(CanonicalRequest))) 经过哈希处理的规范请求示例： af71c5a7ef45310b8dc05ab15f7da50189ffa81a95cc284379ebaa5eb61155c0

步骤2：创建待签字符串 对HTTP请求进行规范并取得请求的哈希值后，将其与签名算法、签名时间一起组成待签名字符串。 StringToSign = Algorithm + \n + RequestDateTime + \n + HashedCanonicalRequest 伪代码中参数说明如下。 Algorithm 签名算法。对于SHA 256，算法为SDK-HMAC-SHA256。 RequestDateTime 请求时间戳。与请求消息头X-Sdk-Date的值相同，格式为YYYYMMDDTHHMMSSZ。 HashedCanonicalRequest 经过哈希处理的规范请求。 上述例子得到的待签字符串为： SDK-HMAC-SHA256 20191111T093443Z af71c5a7ef45310b8dc05ab15f7da50189ffa81a95cc284379ebaa5eb61155c0

准备环境 已获取签名密钥的Key和Secret，请参见签名前准备获取。 已在API网关控制台创建签名密钥，并绑定API，具体请参见创建并使用签名密钥。 在API网关控制台选择“帮助中心”，在“SDK使用指引”页签中下载对应语言所使用SDK。或直接下载SDK的最新版本。 已安装Visual Studio 2019 version 16.8.4或以上版本，如果未安装，请至Visual Studio官方网站下载。

生成签名 生成签名的方式和APP认证相同，用AK代替APP认证中的AppKey，SK替换APP认证中的AppSecret，即可完成签名和请求。您可使用Java、Go、Python、C#、JavaScript、PHP、C++、C、Android进行签名和访问。 客户端须注意本地时间与时钟服务器的同步，避免请求消息头X-Sdk-Date的值出现较大误差。 API网关（即API管理）除了校验时间格式外，还会校验该时间值与网关收到请求的时间差，如果时间差大于15分钟，API网关将拒绝请求。

使用场景 API网关主要涉及以下几个开发场景： API调用认证开发：API的认证方式为APP认证或IAM认证，则需要在业务系统侧进行调用认证的开发，为API请求添加认证信息。 使用APP认证（签名认证）调用API：API调用者通过API网关提供Key、Secret和SDK，对API请求进行签名认证。 使用IAM认证（Token认证）调用API：API调用者先获取云服务平台的认证Token，然后把认证Token携带到API请求中。 使用IAM认证（AK/SK认证）调用API：API调用者通过AK（Access Key ID）/SK（Secret Access Key）和API网关提供的SDK，对API请求进行签名处理。 后端服务签名校验开发：若API在API网关上绑定了签名密钥，则API网关向该API的后端服务发送请求时会携带相应的签名信息。该API的后端服务需要集成API网关提供的SDK，并对请求中的签名信息进行校验。

获取SDK 请在API网关控制台选择“帮助中心”，在“SDK使用指引”页签中下载对应语言所使用SDK。 或直接下载SDK的最新版本，获取“ApiGateway-csharp-sdk.zip”压缩包，解压后目录结构如下： 名称 说明 apigateway-signature\Signer.cs SDK代码 apigateway-signature\HttpEncoder.cs sdk-request\Program.cs 签名请求示例代码 backend-signature\ 后端签名示例工程 csharp.sln 工程文件 licenses\license-referencesource 第三方库license文件

调用API示例 在工程中引入sdk。 1 2 3 4 5 6 using System; using System.Net; using System.IO; using System.Net.Http; using System.Threading; using APIGATEWAY_SDK; 生成一个新的Signer， 填入AppKey和AppSecret。 本示例以AK和SK保存在环境变量中为例，运行本示例前请先在本地环境中设置环境变量HUAWEICLOUD_SDK_AK和HUAWEICLOUD_SDK_SK。以Linux系统为例在本地将已获取的AK/SK设置为环境变量。 打开终端，输入以下命令打开环境变量配置文件。 vi ~/.bashrc 设置环境变量，保存文件并退出编辑器。 export HUAWEICLOUD_SDK_AK="已获取AK值" export HUAWEICLOUD_SDK_SK="已获取SK值" 输入以下命令使配置文件生效。 source ~/.bashrc 生成一个新的Signer，填入已设置的环境变量。 1 2 3 4 5 Signer signer = new Signer(); // Directly writing AK/SK in code is risky. For security, encrypt your AK/SK and store them in the configuration file or environment variables. // In this example, the AK/SK are stored in environment variables for identity authentication. Before running this example, set environment variables HUAWEICLOUD_SDK_AK and HUAWEICLOUD_SDK_SK. signer.Key = Environment.GetEnvironmentVariable("HUAWEICLOUD_SDK_AK"); signer.Secret = Environment.GetEnvironmentVariable("HUAWEICLOUD_SDK_SK"); 生成一个HttpRequest对象，指定域方法名、请求url和body。 1 2 3 HttpRequest r = new HttpRequest("POST", new Uri("https://c967a237-cd6c-470e-906f-a8655461897e.apigw.exampleRegion.com/app1?query=value")); r.body = "{\"a\":1}"; 给请求添加x-stage头，内容为环境名。如有需要，添加需要签名的其他头域。 1 r.headers.Add("x-stage", "RELEASE"); 进行签名，执行此函数会生成一个新的HttpWebRequest，并在请求参数中添加用于签名的X-Sdk-Date头和Authorization头。 1 HttpWebRequest req = signer.Sign(r); 访问API，查看访问结果。 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 try { var writer = new StreamWriter(req.GetRequestStream()); writer.Write(r.body); writer.Flush(); HttpWebResponse resp = (HttpWebResponse)req.GetResponse(); var reader = new StreamReader(resp.GetResponseStream()); Console.WriteLine(reader.ReadToEnd()); } catch (WebException e) { HttpWebResponse resp = (HttpWebResponse)e.Response; if (resp != null) { Console.WriteLine((int)resp.StatusCode + " " + resp.StatusDescription); var reader = new StreamReader(resp.GetResponseStream()); Console.WriteLine(reader.ReadToEnd()); } else { Console.WriteLine(e.Message); } } Console.WriteLine("----------------");

获取SDK 请在API网关控制台，选择“帮助中心”，在“SDK使用指引”页签中下载对应语言所使用SDK。 或直接下载SDK的最新版本，获取“ApiGateway-python-sdk.zip”压缩包，解压后目录结构如下： 名称 说明 apig_sdk\__init__.py SDK代码 apig_sdk\signer.py main.py 示例代码 backend_signature.py 后端签名示例代码 licenses\license-requests 第三方库license文件

前提条件 已获取API的调用信息，具体请参见认证前准备。 已安装Python安装包2.7.9或3.X版本，如果未安装，请至Python官方下载页面下载。 Python安装完成后，在cmd/shell窗口中使用pip安装“requests”库。 pip install requests 如果pip安装requests遇到证书错误，请下载并使用Python执行此文件，升级pip，然后再执行以上命令安装。 已安装IntelliJ IDEA 2018.3.5或以上版本，如果未安装，请至IntelliJ IDEA官方网站下载。 已在IntelliJ IDEA中安装Python插件，如果未安装，请按照图1所示安装。 图1 安装Python插件

调用API示例 在工程中引入apig_sdk。 1 2 3 from apig_sdk import signer import requests import os 生成一个新的Signer，填入AppKey和AppSecret。 本示例以AK和SK保存在环境变量中为例，运行本示例前请先在本地环境中设置环境变量HUAWEICLOUD_SDK_AK和HUAWEICLOUD_SDK_SK。以Linux系统为例在本地将已获取的AK/SK设置为环境变量。 打开终端，输入以下命令打开环境变量配置文件。 vi ~/.bashrc 设置环境变量，保存文件并退出编辑器。 export HUAWEICLOUD_SDK_AK="已获取AK值" export HUAWEICLOUD_SDK_SK="已获取SK值" 输入以下命令使配置文件生效。 source ~/.bashrc 生成一个新的Signer，填入已设置的环境变量。 1 2 3 4 5 sig = signer.Signer() // Directly writing AK/SK in code is risky. For security, encrypt your AK/SK and store them in the configuration file or environment variables. // In this example, the AK/SK are stored in environment variables for identity authentication. Before running this example, set environment variables HUAWEICLOUD_SDK_AK and HUAWEICLOUD_SDK_SK. sig.Key = os.getenv('HUAWEICLOUD_SDK_AK') sig.Secret = os.getenv('HUAWEICLOUD_SDK_SK') 生成一个Request对象，指定方法名、请求uri、header和body。 1 2 3 4 r = signer.HttpRequest("POST", "https://c967a237-cd6c-470e-906f-a8655461897e.apigw.exampleRegion.com/app1?a=1", {"x-stage": "RELEASE"}, "body") 进行签名，执行此函数会在请求参数中添加用于签名的X-Sdk-Date头和Authorization头。 X-Sdk-Date是一个必须参与签名的请求消息头参数。 1 sig.Sign(r) 访问API，查看访问结果。 1 2 3 resp = requests.request(r.method, r.scheme + "://" + r.host + r.uri, headers=r.headers, data=r.body) print(resp.status_code, resp.reason) print(resp.content)

获取SDK 请在API网关控制台选择“帮助中心”，在“SDK使用指引”页签中下载对应语言所使用SDK。 或直接下载SDK的最新版本，获取“ApiGateway-android-sdk.zip”压缩包，解压后目录结构如下： 名称 说明 app\ 安卓工程代码 gradle\ gradle相关文件 build.gradle gradle配置文件 gradle.properties settings.gradle gradlew gradle wrapper执行脚本 gradlew.bat

调用API示例 在Android工程中的“app/libs”目录下，加入SDK所需jar包。其中jar包必须包括： java-sdk-core-x.x.x.jar commons-logging-1.2.jar joda-time-2.10.jar 在“build.gradle”文件中加入okhttp库的依赖。 在“build.gradle”文件中的“dependencies”下加入“implementation 'com.squareup.okhttp3:okhttp:3.14.2'”。 dependencies { ... ... implementation 'com.squareup.okhttp3:okhttp:3.14.3' } 创建request，输入AppKey和AppSecret，并指定域名、方法名、请求uri和body。 本示例以AK和SK保存在环境变量中为例，运行本示例前请先在本地环境中设置环境变量HUAWEICLOUD_SDK_AK和HUAWEICLOUD_SDK_SK。以Linux系统为例在本地将已获取的AK/SK设置为环境变量。 打开终端，输入以下命令打开环境变量配置文件。 vi ~/.bashrc 设置环境变量，保存文件并退出编辑器。 export HUAWEICLOUD_SDK_AK="已获取AK值" export HUAWEICLOUD_SDK_SK="已获取SK值" 输入以下命令使配置文件生效。 source ~/.bashrc 创建request，填入已设置的环境变量，并指定域名、方法名、请求uri和body。 Request request = new Request(); try { // Directly writing AK/SK in code is risky. For security, encrypt your AK/SK and store them in the configuration file or environment variables. // In this example, the AK/SK are stored in environment variables for identity authentication. Before running this example, set environment variables HUAWEICLOUD_SDK_AK and HUAWEICLOUD_SDK_SK. request.setKey(System.getenv("HUAWEICLOUD_SDK_AK")); request.setSecret(System.getenv("HUAWEICLOUD_SDK_SK")); request.setMethod("POST"); request.setUrl("https://c967a237-cd6c-470e-906f-a8655461897e.apigw.exampleRegion.com/app1"); request.addQueryStringParam("name", "value"); request.addHeader("Content-Type", "text/plain"); request.setBody("demo"); } catch (Exception e) { e.printStackTrace(); return; } 对请求进行签名，生成okhttp3.Request对象来访问API。 okhttp3.Request signedRequest = Client.signOkhttp(request); OkHttpClient client = new OkHttpClient.Builder().build(); Response response = client.newCall(signedRequest).execute();

前提条件 已在API网关控制台创建签名密钥，并绑定API，具体请参见创建并使用签名密钥。 已获取签名密钥的Key和Secret，请参见签名前准备获取。 请在API网关控制台选择“帮助中心”，在“SDK使用指引”页签中下载对应语言所使用SDK。或直接下载SDK的最新版本。 已获取apigateway-backend-signature-demo。 已安装IntelliJ IDEA 2018.3.5或以上版本，如果未安装，请至IntelliJ IDEA官方网站下载。 已安装Java Development Kit 1.8.111或以上版本，如果未安装，请至Oracle官方下载页面下载。暂不支持Java Development Kit 17或以上版本。