华为云用户手册

注意事项 服务监管流程未完成的订单，订单状态为“处理中”，待用户确认验收后3个小时内，订单状态会同步为“已完成”，代表订单全流程已完成。 License类商品，根据服务监管状态出账。服务监管状态为已完成的订单，次月结算时系统自动出账。服务监管状态未完成的订单，结算时不出账。 License类商品订单涉及服务监管流程，包周期（包年、包月）订单的资源开始时间为用户验收成功时间，即用户验收后，资源才开始计时。 如：用户购买某包周期商品1年，于2020年01月01日提交订单并支付完成，于2020年03月01日完成服务监管验收，则该订单的资源开始时间为2020年03月01日，有效期1年。

注意事项 服务监管流程未完成的订单，订单状态为“处理中”，待用户确认验收后3个小时内，订单状态会同步为“已完成”，代表订单全流程已完成。 服务监管状态为已完成的订单，次月结算时系统自动出账。服务监管状态未完成的订单，结算时不出账。 商家线下交付包周期（包年、包月）SaaS 商品订单的资源开始时间为用户验收成功时间，即用户验收后，资源才开始计时。 如：用户购买某包周期商品1年，于2020年01月01日提交订单并支付完成，于2020年03月01日完成服务监管验收，则该订单的资源开始时间为2020年03月01日，有效期1年。

注意事项 服务监管流程未完成的订单，订单状态为“处理中”，待用户确认验收后3个小时内，订单状态会同步为“已完成”，代表订单全流程已完成，次月出账结算。 如用户对已完成服务监管的商品订单进行续费，新续费的订单将不涉及服务监管流程。 商家线下交付包周期（包年、包月）License 商品订单的资源开始时间为用户验收成功时间，即用户验收后，资源才开始计时。 如：用户购买某包周期商品1年，于2020年01月01日提交订单并支付完成，于2020年03月01日完成服务监管验收，则该订单的资源开始时间为2020年03月01日，有效期1年。

新增客户级转售折扣授权 商家进入“卖家中心-销售管理-转售商务授权-经销商转售（客户级）”页签。 点击新增授权，输入项目信息、经销商账号、客户账户，对应的客户账号，须为经销商的转售类客户。客户级折扣仅适用指定客户消费。 添加商品并输入正确的转售折扣值和商家分成比例，选择有效期，确定。 若平台费比例低于标准分成，将触发云商店决策，决策审批通过后，授权折扣生效。云商店标准分成比例查询。 客户级转售授权折扣申请成功

公司名称变更指引 操作流程 商家在账号中心实名认证中进行变更公司名称，具体操作请参考《如何变更企业名称》； 商家在云商店卖家中心提交商家信息修改申请，更新公司名称以及相关信息，具体操作请参考商家信息更新； 商家按照步骤2提交申请后，将会收到云商店邮件通知，需按照邮件要求提供更名材料：1）企业变更通知书；2）更名承诺书；3）供应商银行函信息表；4）变更后的营业执照； 云商店运营经理将商家邮件反馈的更名材料反馈给伙伴中心商业信息认证审核人员进行商业信息变更； 伙伴中心将商业信息变更后，云商店运营经理将审核通过商家信息修改申请，公司名称变更流程完成。 审核结果将以邮件及短信的形式通知到入驻信息中填写的客服邮箱及联系人手机中，请耐心等待并注意查收。

准入条件 企业入驻华为云云商店需要符合以下条件： 符合国家相关法律、法规规定，拥有正规的公司资质。 具有5人以上的技术及客服团队。 可提供不少于5*8小时的客服在线服务。 接受并签署云商店相关协议及管理规范，并按照协议及管理规范的条款和条件开展业务合作。 企业成立至少1年以上，且注册资金50万元以上。 接受并签订《云商店通用商品商家合作协议》并按照协议约束的条款开展业务合作。 接受华为云要求满足的其他条件（含伙伴政策要求的条件）。 个人开发者入驻华为云云商店需要符合以下条件： 1. 可提供不少于5*8小时的客服在线服务。 2. 接受并签署云商店相关协议及管理规范，并按照协议及管理规范的条款和条件开展业务合作。 3. 个人开发者需通过华为云平台的实名认证，年龄需满足18周岁以上。 4. 接受并签订《云商店通用商品商家合作协议》并按照协议约束的条款开展业务合作。 5. 接受华为云要求满足的其他条件（含伙伴政策要求的条件）。 父主题： 商家入驻

管理频道 频道新增完成后，您还可以根据实际需要进行如下操作。 启用频道 频道创建完成后，若您需要使用，请单击操作列的“启动”，启用频道。 停用频道 如果频道需要停止，请单击操作列的“停止”，停用频道。 修改频道配置 如果需要修改频道，请单击操作列的“管理”，修改频道的配置项。如果修改的频道是启用状态，那么修改完成后，自动重启，重启耗时约30s。频道重启过程中，音视频流会中断，待重启完成后，自动恢复。 删除频道 如果频道需要删除，需要先停用，再单击操作列的“删除”，删除频道。

使用限制 一个租户最多支持创建500个频道。如果有更多的频道需求，请提交工单扩容。 所有频道仅支持单码率入流，且必须经过转码后，才能提供多码率出流。 RTMP_PUSH类型的频道需要配置RTMP协议的推流 域名 。SRT_PUSH类型的频道需要配置SRT协议的推流域名。 所以同一个域名，不支持同时创建“SRT_PUSH”和“RTMP_PUSH”类型的频道。 “SRT_PUSH”输入类型的频道，为了保障可靠性，必须满足下述条件： “SRT_PUSH”输入类型的频道支持主备双URL，编码器要同时向主备双URL推流。 如果编码器支持streamid，默认只返回一个输入URL，示例如图1所示。 如果需要主备Region同时双推，请提交工单处理。 图1 频道详情 如果编码器不支持streamid，会同时返回主备输入URL，示例如图2所示。 图2 频道详情 编码器推流断链时，需具备主动重推能力。建议断链重推周期小于一个分片时长。 频道DRM加密使用FunctionGraph函数时，不会携带FunctionGraph版本信息，默认使用最新版本。 如果DRM故障会返回404，此问题华为侧无法解决，建议用户直接关闭DRM。

内容审核 媒体直播不支持接入违反相关法律法规的域名，包括但不限于： 涉黄、涉赌、涉毒、涉诈、侵权内容的网站 游戏私服类 盗版游戏/软件/盗版视频网站 P2P类金融网站 彩票类网站 违规医院和药品类网站 无法正常访问或内容不含有任何实质信息 如果您的直播加速域名含有以上违规的内容，您将自行承担相关风险。 如果发现涉黄、涉赌、涉毒、涉诈等违规行为，媒体直播将执行域名封禁策略（删除相关加速域名且不允许再次接入，与违规域名使用相同源站的加速域名同样执行域名封禁策略），账号加速域名配额降为0。

准入流程 注册域名：若您还未有自有域名，您可以在华为云购买或注册域名，具体请参见 域名注册服务 。。 一级域名不能直接作为推流域名或播放域名，若您的域名为“example.com”，则您可以使用子域名“test-push.example.com”和“test-play.example.com”作为推流域名和播放域名。 实名认证：您可以登录华为云官网，根据提示信息完成个人或企业账号实名认证，详细操作请参见实名认证。 备案域名：自有域名需要在工信部完成备案，您可以在华为云备案中心完成。备案时长大概需要几个工作日，建议您提前进行备案，待能在工信部备案查询网站上查询到您的备案域名后，再到直播控制台添加已备案的域名。

注意事项 如果需要删除转码模板，需要同步从所有频道中手工删除，否则频道中仍会生效。 频道的转码规则生效配置为频道启动播放时的配置内容，若修改了转码配置，需要重启频道后才能生效。 若转码模板中选择高清低码，那么直播转码将按高清低码标准计费，价格详情请参见产品价格详情。 暂不支持上采样转码，若转码模板中设置的分辨率高于推流分辨率，对应分辨率的播放地址可以成功播放，但播放视频的分辨率为原始分辨率。转码帧率也不支持上采样。

管理转码 转码模板配置完成后，您还可以根据实际需要进行如下操作。 修改转码模板 转码模板创建完成后，若您需要修改部分参数，可以通过单击操作列的“修改”，修改转码模板中的相关参数。如果转码模板所在频道已经启用，需要重启频道，修改才能生效。频道重启流程耗时约30s。频道重启过程中，音视频流转码流程会中断，待频道重启完成后，转码流程自动恢复。 删除转码模板 转码模板创建完成后，若您需要删除转码模板，可以通过单击操作列的“删除”，删除该转码模板。

前提条件 已 注册华为账号 并开通华为云，完成实名认证。 具备用于媒体直播的域名，且域名已完成备案。PUSH类型的频道需要一个推流域名和一个播放域名，且两个域名不能相同。PULL类型的频道，不需要推流域名。 若您需要购买自有域名，您可以在华为云的域名注册中购买。您也可以在其它域名服务商处购买。 若您已有域名，但还未根据国家工信部规定完成备案，您可以在华为云的备案中心完成备案。 新增 IAM 用户首次使用媒体直播服务时，需要配置创建域名的权限。

添加媒体直播域名 您需要将自有的已备案的推流域名、播放域名分别添加到 视频直播 服务中。下面以添加推流域名为例，播放域名的添加步骤与此相同。 登录视频直播控制台。 在左侧导航树中选择“域名管理”，进入域名管理页面。 单击“添加域名”。在右侧弹出的“添加域名”页面，输入已申请的播放域名或推流域名。 PUSH类型的频道，需同时新增一个推流域名和一个播放域名；PULL类型的频道，仅需新增一个播放域名。 注意：若您的域名未备案，将添加失败，并提示“添加域名失败：ICP编号不存在”。 图1 添加媒体直播播放域名 图2 添加媒体直播推流域名 表1 参数说明 参数 说明 域名 输入二级推流域名或播放域名。示例：“test-push.example.com”。 说明： 域名长度限制为64个字符，暂不支持大写的域名。 推流域名与播放域名不能相同，不支持添加泛域名。 默认每个账号下最多可创建64个域名。如需增加域名，请提交工单处理。 企业项目 将域名加入到企业项目中统一管理。 在企业项目页面创建企业项目，默认为default企业项目，然后将用户组添加到该企业项目。这时用户组内用户将获得用户组授权的该企业项目下的域名的相关操作权限。 说明： 仅企业账号能够配置企业项目。 域名类型 若“域名”中输入的是推流域名则选择推流域名，否则，选择播放域名。域名类型配置后不可更改。 子服务类型 直播服务的子服务类型。 包括如下选项： 云直播：流式直播服务，提供灵活易用，功能丰富的直播加速能力，适用娱乐、电商、教育等场景。 媒体直播：广播级直播服务，支持频道管理、内容加密等特性，适用于媒资，广电等场景。 请选择“媒体直播”。 直播源站 直播源站所在地域，可参考如何选择直播源站和加速区域？选择。直播源站配置后不可更改，建议您选择业务就近的源站。 目前支持如下区域： 中国站北京四入口，支持区域：华北-北京四。 国际站新加坡入口，支持区域：亚太-新加坡、中东-利雅得、中国-香港、非洲-约翰内斯堡。 中东-利雅得、中国-香港、非洲-约翰内斯堡区域默认不开放，如需使用，请提交工单与华为云技术客服联系。 加速区域 播放域名可执行加速的地域，可参考如何选择直播源站和加速区域？选择。仅对播放域名有效，推流域名不支持设置。设置完成后，不支持修改。 如果在所选加速区域之外播放，将无法保证功能和质量，请您根据实际业务，选择有效的加速区域。 包含如下选项： 中国大陆 当观众在中国大陆时，应选择此项。 域名需要在工信部备案，推荐您在华为云备案中心备案。 中国大陆境外 当观众在海外、中国香港、中国澳门、中国台湾时，应选择此项。 全球加速 当观众在中国大陆、中国香港、中国澳门、中国台湾或其他国家和地区时，应选择此项。 域名需要在工信部备案，推荐您在华为云备案中心备案。 推流协议 如果添加的是媒体直播的推流域名，才会展示当前配置项。 媒体直播的推流协议。 包含如下选项： RTMP：RTMP_PUSH类型的频道需要配置RTMP协议的推流域名。 SRT：SRT_PUSH类型的频道需要配置SRT协议的推流域名。 单击“确定”。 在“域名管理”页面的列表中会新增一条“状态”为“配置中”的域名记录。大概3-5分钟时间，当“状态”为“正常”时，域名添加成功。 执行步骤1-步骤4，完成对播放域名的添加。

CDN下行并发数 支持查询最近90天的历史数据。 查询的时间跨度最长为31天。 支持选择 多个域名 同时查询，单次查询的域名总数不能超过20个。 最小统计粒度为5分钟。如2020-11-06 8:00:00~2020-11-06 8:04:59时间段内的数据，会统计展示在2020-11-06 8:00:00这个统计点上，其中，展示的数据为用户所选粒度时间段内的最大值。 时间粒度的限制说明：当查询时间跨度小于等于2天时，不支持“一天粒度”；当查询时间跨度大于2天，小于等于7天时，不支持“五分钟粒度”；当查询时间跨度大于7天时，仅支持选择“一天粒度”。 选择需要查看的时间、播放域名、区域和时间粒度，即可查看下行并发数的趋势图。 趋势图中呈现的是服务端接收播放域名的请求数。 图4 下行并发数趋势图

CDN下行带宽/流量 支持查询最近90天的历史数据。 查询的时间跨度最长为31天。 支持选择多个域名同时查询，单次查询的域名总数不能超过20个。 最小统计粒度为5分钟。如2020-11-06 8:00:00~2020-11-06 8:04:59时间段内的数据，会统计展示在2020-11-06 8:00:00这个统计点上，其中，展示的数据为用户所选粒度时间段内的最大值。 时间粒度的限制说明：当查询时间跨度小于等于2天时，不支持“一天粒度”；当查询时间跨度大于2天，小于等于7天时，不支持“五分钟粒度”；当查询时间跨度大于7天时，仅支持选择“一天粒度”。 选择需要查看的时间、播放域名、区域及时间粒度。单击界面右侧的“带宽”或“流量”，可以切换查看带宽、流量趋势图。 带宽用量趋势呈现的是所选域名的总带宽趋势，如图1所示。其中，“下行带宽：2.00 Mbps”为所选域名在查询时间段内的下行带宽峰值。 图1 下行带宽统计详情 流量用量趋势中呈现的是所选域名的总流量趋势，如图2所示。其中，“下行流量：2.50 GB”为所选域名在查询时间段内的流量消耗。 流量趋势图中的总流量计算方式为，将每5分钟粒度统计的流量进行合计（Byte），再换算成MB后，精确到小数点后两位。 图2 下行流量统计详情

CDN状态码 支持查询最近90天的历史数据。 查询的时间跨度最长为31天。 支持选择多个域名同时查询，单次查询的域名总数不能超过20个。 最小统计粒度为5分钟。如2020-11-06 8:00:00~2020-11-06 8:04:59时间段内的数据，会统计展示在2020-11-06 8:00:00这个统计点上，其中，展示的数据为用户所选粒度时间段内的最大值。 时间粒度的限制说明：当查询时间跨度小于等于2天时，不支持“一天粒度”；当查询时间跨度大于2天，小于等于7天时，不支持“五分钟粒度”；当查询时间跨度大于7天时，仅支持选择“一天粒度”。 选择需要查看的时间、播放域名、区域、时间粒度和状态码，即可查看相应状态码的趋势图，如图3所示。 趋势图中呈现的是服务端返回状态码的数量。 图3 状态码统计信息

转码指标监控 支持查询最近90天的历史数据。 查询的时间跨度最长为30天。 转码指标监控的最小统计粒度为1分钟。如2020-11-06 8:00:00~2020-11-06 8:00:59时间段内的数据，会统计展示在2020-11-06 8:00:00这个统计点上，其中，展示的数据为用户所选粒度时间段内的最大值。 时间粒度的限制说明：当查询时间跨度小于等于2天时，不支持“一天粒度”；当查询时间跨度大于2天，小于等于7天时，不支持“五分钟粒度”；当查询时间跨度大于7天时，仅支持选择“一天粒度”。 选择需要查看的时间、频道名称、码率帧率、时间粒度，即可查看入流质量监控的趋势图。 趋势图中呈现的是频道入流码率和帧率的变化趋势图。 图5 入流质量监控趋势图

前提条件 已注册华为账号并开通华为云，完成实名认证。 具备用于媒体直播的域名，且域名已完成备案。PUSH类型的频道需要一个推流域名和一个播放域名，且两个域名不能相同。PULL类型的频道，不需要推流域名。 若您需要购买自有域名，您可以在华为云的域名注册中购买。您也可以在其它域名服务商处购买。 若您已有域名，但还未根据国家工信部规定完成备案，您可以在华为云的备案中心完成备案。 新增IAM用户首次使用媒体直播服务时，需要配置创建域名的权限。

注意事项 海外直播价格和国内直播价格不同，计费详情请参见价格详情。 在所选加速区域之外使用此播放地址，无法保证功能和播放质量。 如果播放域名的加速区域为“中国大陆”或“全球加速”，而推流域名的直播源站为中国大陆境内时，域名均需要完成中国大陆的域名备案。 视频直播服务可能会分配一个默认的推流域名给用户，如下所示： 国内推流域名格式：{projectid}.hwcloudlive.com 示例：0c283a271****************9459b6a.hwcloudlive.com 海外推流域名：{projectid}.ott.huawei 示例：0c283a271****************9459b6a.ott.huawei 上述推流域名为服务内部使用域名。如果用户被分配了上述域名，虽然可见，但不支持调用或使用。且对正常使用Live无影响，也不会引起额外的费用，可无需关注。

操作步骤 登录视频直播控制台。 在左侧导航树中选择“域名管理”，进入域名管理页面。 单击“添加域名”。在右侧弹出的“添加域名”页面，输入已申请的播放域名或推流域名。 PUSH类型的频道，需同时新增一个推流域名和一个播放域名；PULL类型的频道，仅需新增一个播放域名。 注意：若您的域名未备案，将添加失败，并提示“添加域名失败：ICP编号不存在”。 图2 添加媒体直播播放域名 图3 添加媒体直播推流域名 表1 参数说明 参数 说明 域名 输入二级推流域名或播放域名。示例：“test-push.example.com”。 说明： 域名长度限制为64个字符，暂不支持大写的域名。 推流域名与播放域名不能相同，不支持添加泛域名。 默认每个账号下最多可创建64个域名。如需增加域名，请提交工单处理。 企业项目 将域名加入到企业项目中统一管理。 在企业项目页面创建企业项目，默认为default企业项目，然后将用户组添加到该企业项目。这时用户组内用户将获得用户组授权的该企业项目下的域名的相关操作权限。 说明： 仅企业账号能够配置企业项目。 域名类型 若“域名”中输入的是推流域名则选择推流域名，否则，选择播放域名。域名类型配置后不可更改。 子服务类型 直播服务的子服务类型。 包括如下选项： 云直播：流式直播服务，提供灵活易用，功能丰富的直播加速能力，适用娱乐、电商、教育等场景。 媒体直播：广播级直播服务，支持频道管理、内容加密等特性，适用于媒资，广电等场景。 请选择“媒体直播”。 直播源站 直播源站所在地域，可参考如何选择直播源站和加速区域？选择。直播源站配置后不可更改，建议您选择业务就近的源站。 目前支持如下区域： 中国站北京四入口，支持区域：华北-北京四。 国际站新加坡入口，支持区域：亚太-新加坡、中东-利雅得、中国-香港、非洲-约翰内斯堡。 中东-利雅得、中国-香港、非洲-约翰内斯堡区域默认不开放，如需使用，请提交工单与华为云技术客服联系。 加速区域 播放域名可执行加速的地域，可参考如何选择直播源站和加速区域？选择。仅对播放域名有效，推流域名不支持设置。设置完成后，不支持修改。 如果在所选加速区域之外播放，将无法保证功能和质量，请您根据实际业务，选择有效的加速区域。 包含如下选项： 中国大陆 当观众在中国大陆时，应选择此项。 域名需要在工信部备案，推荐您在华为云备案中心备案。 中国大陆境外 当观众在海外、中国香港、中国澳门、中国台湾时，应选择此项。 全球加速 当观众在中国大陆、中国香港、中国澳门、中国台湾或其他国家和地区时，应选择此项。 域名需要在工信部备案，推荐您在华为云备案中心备案。 推流协议 如果添加的是媒体直播的推流域名，才会展示当前配置项。 媒体直播的推流协议。 包含如下选项： RTMP：RTMP_PUSH类型的频道需要配置RTMP协议的推流域名。 SRT：SRT_PUSH类型的频道需要配置SRT协议的推流域名。 单击“确定”。 在“域名管理”页面的列表中会新增一条“状态”为“配置中”的域名记录。大概3-5分钟时间，当“状态”为“正常”时，域名添加成功。 域名添加完成后，您需要在播放域名和推流域名的DNS服务商处配置CNAME，将您的域名指向CDN配置的CNAME地址。 具体操作请见配置CNAME，配置完成后，对应的域名会自动启用直播加速服务。

响应消息 响应参数 返回状态码为 200: successful operation。 表2 响应Body参数列表 名称 类型 描述 vpn_connection ResponseVpnConnection object vpn_connection对象。 request_id String 请求ID。 表3 ResponseVpnConnection 名称 类型 描述 id String 功能说明：VPN连接ID。 格式：36位UUID。 name String 功能说明：VPN连接名称。 取值范围：1-64个字符，支持数字、英文字母、中文（\u4e00 - \u9fa5）、_（下划线）、-（中划线）、.（点）。 status String 功能说明：VPN连接状态。 取值范围： ERROR：异常。 ACTIVE：正常。 DOWN：未连接。 PENDING_CREATE：创建中。 PENDING_UPDATE：更新中。 PENDING_DELETE：删除中。 FREEZED：冻结中。 UNKNOWN：未知。 vgw_id String 功能说明：VPN网关ID。 格式：36位UUID。 vgw_ip String 功能说明： VPN网关EIP的ID或接入私网IP。 格式：36位UUID或点分十进制IPv4地址（如192.168.45.7）。 style String 功能说明：连接模式。 取值范围： POLICY: 策略模式。 STATIC: 静态路由模式。 BGP: bgp路由模式。 POLICY-TEMPLATE: 策略模板模式。 cgw_id String 功能说明：对端网关ID。 格式：36位UUID。 peer_subnets Array of String IPv4对端子网。当VPN网关的关联模式为ER并且style字段为BGP或POLICY、或VPN网关的IP协议版本号为IPv6时不返回。 peer_subnets_v6 Array of String IPv6对端子网。当VPN网关的关联模式为ER并且style字段为BGP或POLICY、或VPN网关的IP协议版本号为IPv4时不返回。 tunnel_local_address String 路由模式下配置在VPN网关上的tunnel接口地址。仅当style为STATIC或BGP时有效。 tunnel_peer_address String 路由模式下配置在用户侧设备上的tunnel接口地址。仅当style为STATIC或BGP时有效。 enable_nqa Boolean 功能说明：开启NQA检测。仅当style为STATIC时返回。 取值范围：true，false。 policy_rules Array of PolicyRule objects IPv4策略模式的策略规则组。仅当style为POLICY且VPN网关的IP协议版本号为IPv4时返回实际的策略规则组。 policy_rules_v6 Array of PolicyRule objects IPv6策略模式的策略规则组。仅当style为POLICY且VPN网关的IP协议版本号为IPv6时返回实际的策略规则组。 ikepolicy IkePolicy object ike策略对象。 ipsecpolicy IpsecPolicy object ipsec策略对象。 created_at String 创建时间。 UTC时间格式：yyyy-MM-ddTHH:mm:ssZ。 updated_at String 最后一次更新时间。 UTC时间格式：yyyy-MM-ddTHH:mm:ssZ。 enterprise_project_id String 功能说明：企业项目ID。 格式：36位UUID。与vgw_id所标识VPN网关的企业项目ID一致。 connection_monitor_id String 功能说明：VPN连接监控ID。仅当VPN连接下创建有连接监控时返回。 格式：36位UUID。 ha_role String 功能说明：主备模式VPN网关下的连接时，'master'表示主连接，'slave'表示备连接。双活模式下的连接ha_role都是'master'。 默认值：master tags Array of VpnResourceTag objects 标签列表。 表4 PolicyRule 名称 类型 描述 rule_index Integer 功能说明：规则ID。 取值范围：0-50。 source String 源地址网段。 destination Array of String 目的地址网段。单个IPv4网段格式示例：192.168.52.0/24。每个PolicyRule最多返回50个。 表5 IkePolicy 名称 类型 描述 ike_version String 功能说明：IKE版本号。 取值范围：v1, v2。 phase1_negotiation_mode String 功能说明：协商模式。仅当IKE版本为v1时返回。 取值范围： main：主模式，协商过程安全性高。 aggressive：野蛮模式，协商快速且协商成功率高。 authentication_algorithm String 功能说明：认证算法。 取值范围：sha2-512，sha2-384，sha2-256，sha1，md5，sm3。 encryption_algorithm String 功能说明：加密算法。 取值范围：aes-256-gcm-16，aes-128-gcm-16，aes-256，aes-192，aes-128，3des，sm4。 dh_group String 功能说明：第一阶段密钥交换使用的DH组，当VPN网关flavor为GM时不返回。 取值范围：group1，group2，group5，group14，group15，group16，group19，group20，group21。 authentication_method String 功能说明：ike协商时的认证方法。 取值范围： pre-share：预共享密钥。 digital-envelope-v2：国密数字信封。 lifetime_seconds Integer 功能说明：表示SA的生存周期，当该生存周期超时后IKE SA将自动更新。 取值范围：60-604800，单位：秒。 local_id_type String 功能说明：本端ID类型，当VPN网关flavor为GM时不返回。 取值范围： ip。 fqdn。 local_id String 本端ID。当local_id_type为ip时返回VPN连接所使用的网关IP；当local_id_type为fqdn时返回创建或更新VPN连接时指定的本端ID。 当VPN网关flavor为GM时不返回。 peer_id_type String 功能说明：对端ID类型，当VPN网关flavor为GM时不返回。 取值范围： ip。 fqdn。 peer_id String 对端ID。当peer_id_type为ip时返回对端网关的IP；当peer_id_type为fqdn时返回创建或更新VPN连接时指定的对端ID。 当VPN网关flavor为GM时不返回。 dpd Dpd object 对等体存活检测对象。 表6 Dpd 名称 类型 描述 timeout Integer 功能说明：对等体存活检测报文重传间隔。 取值范围：2-60，单位：秒。 interval Integer 功能说明：对等体存活检测空闲时间。 取值范围：10-3600，单位：秒。 msg String 功能说明：对等体存活检测报文格式。 取值范围： seq-hash-notify：指定DPD报文中的载荷顺序是hash-notify。 seq-notify-hash：指定DPD报文中的载荷顺序是notify-hash。 表7 IpsecPolicy 名称 类型 描述 authentication_algorithm String 功能说明：认证算法。 取值范围：sha2-512，sha2-384，sha2-256，sha1，md5，sm3。 encryption_algorithm String 功能说明：加密算法。 取值范围：aes-256-gcm-16，aes-128-gcm-16，aes-256，aes-192，aes-128，3des，sm4。 pfs String 功能说明：PFS使用的DH密钥组，当VPN网关flavor为GM时不返回。 取值范围：group1，group2，group5，group14，group15，group16，group19，group20，group21，disable。 transform_protocol String 功能说明：传输协议。 取值范围： esp：封装安全协议。 lifetime_seconds Integer 功能说明：表示配置IPSec连接建立的隧道以时间为基准的生存周期。 取值范围：30-604800，单位：秒。 encapsulation_mode String 功能说明：报文封装模式。 取值范围： tunnel：隧道模式。 表8 VpnResourceTag 名称 类型 描述 key String 功能说明：标签的键。 取值范围：1-128个字符，支持数字、英文字母、中文、西班牙语、葡语、空格，以及以下字符：_.:=+-@。 value String 功能说明：标签的值。 取值范围：0-255个字符，支持数字、英文字母、中文、西班牙语、葡语、空格，以及以下字符：_.:=+-@。 响应样例 { "vpn_connection": { "id": "98c5af8a-demo-a8df-va86-ae2280a6f4c3", "name": "vpn-1655", "status": "DOWN", "vgw_id": "b32d91a4-demo-a8df-va86-e907174eb11d", "vgw_ip": "0c464dad-demo-a8df-va86-c22bb0eb0bde", "style": "POLICY", "cgw_id": "5247ae10-demo-a8df-va86-dd36659a7f5d", "peer_subnets": ["192.168.0.0/24"], "tunnel_local_address": "169.254.56.225/30", "tunnel_peer_address": "169.254.56.226/30", "policy_rules": [{ "rule_index": 1, "source": "10.0.0.0/24", "destination": [ "192.168.0.0/24" ] }], "ikepolicy": { "ike_version": "v2", "authentication_algorithm": "sha2-256", "encryption_algorithm": "aes-128", "dh_group": "group15", "authentication_method": "pre-share", "lifetime_seconds": 86400, "local_id_type": "ip", "local_id": "10.***.***.134", "peer_id_type": "ip", "peer_id": "88.***.***.164", "dpd": { "timeout": 15, "interval": 30, "msg": "seq-hash-notify" } }, "ipsecpolicy": { "authentication_algorithm": "sha2-256", "encryption_algorithm": "aes-128", "pfs": "group15", "transform_protocol": "esp", "lifetime_seconds": 3600, "encapsulation_mode": "tunnel" }, "created_at": "2022-11-26T13:41:34.626Z", "updated_at": "2022-11-26T13:41:34.626Z", "enterprise_project_id": "0", "ha_role":"master" }, "request_id": "f91082d4-6d49-479c-ad1d-4e552a9f5cae" }

响应消息 响应参数 返回状态码为 200: 更新成功。 表5 响应Body参数列表 名称 类型 描述 customer_gateway ResponseCustomerGateway object customer_gateway对象。 request_id String 请求id。 表6 ResponseCustomerGateway 名称 类型 描述 id String 功能说明：对端网关的ID。 格式：36位UUID。 name String 功能说明：对端网关名称。 取值范围：1-64个字符，包括数字、英文字母、中文(\u4e00 - \u9fa5)、_(下划线)、-(中划线)。 id_type String 功能说明：对端网关标识类型。 取值范围： ip。 fqdn。 id_value String 对端网关标识值。 bgp_asn Long 对端网关的BGP自治域编号。仅当id_type为ip时返回。 created_at String 创建时间。 UTC时间格式：yyyy-MM-ddTHH:mm:ss.SSSZ。 updated_at String 最后一次更新时间。 UTC时间格式：yyyy-MM-ddTHH:mm:ss.SSSZ。 ca_certificate CaCertificate object 对端网关CA证书信息。仅当对端网关绑定CA证书时返回。 tags Array of VpnResourceTag objects 标签列表。 表7 CaCertificate 名称 类型 描述 id String 证书ID。 serial_number String 证书序列号。 signature_algorithm String 签名算法。 issuer String 证书颁发者。 subject String 证书使用者。 expire_time String 证书过期时间。 is_updatable boolean 是否能更新证书内容。 表8 VpnResourceTag 名称 类型 描述 key String 功能说明：标签的键。 取值范围：1-128个字符，支持数字、英文字母、中文、西班牙语、葡语、空格，以及以下字符：_.:=+-@。 value String 功能说明：标签的值。 取值范围：0-255个字符，支持数字、英文字母、中文、西班牙语、葡语、空格，以及以下字符：_.:=+-@。 响应样例 { "customer_gateway": { "id": "03c0aa3d-demo-a8df-va86-9d82473765d4", "name": "cgw-f846", "id_type": "ip", "id_value": "10.***.***.21", "bgp_asn": 65533, "ca_certificate": { "serial_number": "14257156674311863338", "signature_algorithm": "SM3WITHSM2", "issuer": "C=CN,O=a0002,CN=XXX", "subject": "C=CN,O=a0002,CN=XXX", "expire_time": "2024-05-22T07:34:22Z", "is_updatable": true }, "created_at": "2021-12-21T16:49:28.108Z", "updated_at": "2021-12-21T16:49:28.108Z" }, "request_id": "96718f4a-f57a-4e1f-8d05-7d5e903c8d90" }

请求消息 请求参数 表2 请求参数 名称 类型 是否必选 描述 customer_gateway UpdateCgwRequestBodyContent object 是 customer_gateway对象。 表3 UpdateCgwRequestBodyContent 名称 类型 是否必选 描述 name String 否 功能说明：网关名称。 取值范围：1-64个字符，支持数字、英文字母、中文（\u4e00 - \u9fa5）、_（下划线）、-（中划线）、.（点）。 ca_certificate CaCertificateRequest object 否 功能说明：对端网关CA证书。 表4 CaCertificateRequest 名称 类型 是否必选 描述 id String 否 功能说明：证书ID。 格式：36位UUID。 content String 否 功能说明：对端网关CA证书内容。 取值范围：1-8192个字符。 请求样例 PUT https://{Endpoint}/v5/{project_id}/customer-gateways/{customer_gateway_id} { "customer_gateway": { "name": "cgw-f846", "ca_certificate": { "content":"******" } } }

响应消息 响应参数 返回状态码为 200: successful operation。 表4 响应Body参数列表 名称 类型 描述 vpn_gateway ResponseVpnGateway object vpn_gateway对象。 request_id String 请求ID。 表5 ResponseVpnGateway 名称 类型 描述 id String 功能说明：VPN网关ID。 格式：36位UUID。 name String 功能说明：VPN网关名称。 取值范围：1-64个字符，包括数字、英文字母、中文(\u4e00 - \u9fa5)、_(下划线)、-(中划线)。 network_type String 功能说明：VPN网关网络类型。 取值范围：public，private。 默认值：public。 attachment_type String 功能说明：关联模式。 取值范围：vpc，er。 ip_version String 功能说明：VPN网关的IP协议版本。 取值范围：ipv4、ipv6。 certificate_id String 功能说明：证书ID。 格式：36位UUID。 er_id String VPN网关所连接的ER实例的ID。仅当attachment_type为er时返回。 vpc_id String 当attachment_type为vpc时，vpc_id是VPN网关关联的业务VPC的ID。 当attachment_type为er时，vpc_id是VPN网关的接入VPC的ID。 local_subnets Array of String 本端子网。本端子网是云上子网，该网段需要通过VPN与用户侧网络进行互通。单个网段格式示例：192.168.52.0/24。仅当attachment_type为vpc时返回。 local_subnets_v6 Array of String IPv6本端子网。本端子网是云上子网，该网段需要通过VPN与用户侧网络进行互通。单个网段格式示例：16af:cacc:1097::/48。仅当attachment_type为vpc且ip_version为ipv6时返回。 connect_subnet String VPN网关所使用的VPC中的一个子网ID。 bgp_asn Long VPN网关的BGP自治域编号。 flavor String 功能说明：VPN网关的规格类型: 取值范围： Basic：最大转发带宽100Mbps。 Professional1：最大转发带宽300Mbps。 Professional1-NonFixedIP：最大转发带宽300Mbps。 Professional2：最大转发带宽1Gbps。 Professional2-NonFixedIP：最大转发带宽1Gbps。 GM：最大转发带宽500Mbps。 availability_zone_ids Array of String 部署VPN网关的可用区。当指定了可用区时则返回；当未指定可用区时，在VPN网关的状态为ACTIVE时返回。 connection_number Integer VPN网关下的最大VPN连接数。 used_connection_number Integer VPN网关下当前已经使用的VPN连接数。 used_connection_group Integer VPN网关下当前已经使用的VPN连接组个数。同一用户网关入云的两条连接组成一个连接组。VPN网关默认支持10个免费的VPN连接组。 enterprise_project_id String 功能说明：企业项目ID。 格式：36位UUID。创建时不传则返回"0"，表示资源属于default企业项目。 注："0"并不是真实存在的企业项目ID。 eip1 ResponseEip object 双活VPN网关表示使用的第一个EIP，主备VPN网关表示主EIP。在VPN网关的状态为ACTIVE时返回。 eip2 ResponseEip object 双活VPN网关表示使用的第二个EIP，主备VPN网关表示备EIP。在VPN网关的状态为ACTIVE时返回。 created_at String 创建时间。在VPN网关的状态为ACTIVE时返回。 UTC时间格式：yyyy-MM-ddTHH:mm:ssZ。 updated_at String 最后一次更新时间。在VPN网关的状态为ACTIVE时返回。 UTC时间格式：yyyy-MM-ddTHH:mm:ssZ。 access_vpc_id String 功能说明：VPN网关使用的接入VPC ID。 格式：36位UUID。 access_subnet_id String 功能说明：VPN网关使用的接入VPC中的子网ID。 格式：36位UUID。 access_private_ip_1 String 私网类型VPN网关的接入私网IP，VPN网关使用该私网IP与对端网关建连。双活网关表示使用的第一个私网地址，主备表示主私网地址。 示例：192.168.52.9。仅当network_type为private时返回。 access_private_ip_2 String 私网类型VPN网关的接入私网IP，VPN网关使用该私网IP与对端网关建连。双活网关表示使用的第二个私网地址，主备表示备私网地址。 示例：192.168.52.9。仅当network_type为private时返回。 ha_mode String 功能说明：网关的HA模式，"active-active"表示双活，"active-standby"表示主备。 取值范围：active-active，active-standby。 policy_template PolicyTemplate object 非固定IP接入VPN网关的策略模板配置，只有在规格为非固定IP接入VPN网关时返回。 tags Array of VpnResourceTag objects 标签列表。 表6 ResponseEip 名称 类型 描述 id String 功能说明：EIP的ID。 格式：36位UUID。当使用默认企业项目时返回"0"。 ip_version Integer 功能说明：EIP版本。 取值范围：4。 ip_billing_info String 功能说明：EIP的订单信息。包年/包月EIP才会返回订单信息，按需计费的EIP不返回。 格式：order_id:product_id:region_id:project_id，如： CS 22********LIBIV:00301-******-0--0:br-iaas-odin1:0605768a************c006c7e484aa。 type String 功能说明：EIP的类型。 取值范围：可查看申请EIP表6中type字段的取值范围。 ip_address String 功能说明：EIP的公网IPv4地址。 格式：ipv4类型地址。例如：88.***.***.11。 charge_mode String 功能说明：EIP的带宽计费模式。按流量计费或按带宽计费。 取值范围： bandwidth：按带宽计费。 traffic：按流量计费。 bandwidth_id String 功能说明：EIP的带宽ID。 格式：36位UUID。 bandwidth_size Integer 功能说明：EIP的带宽大小，单位：Mbit/s。每个region能够提供的EIP最大带宽不同，EIP的最大带宽受限于EIP服务，可以使用工单来提高帐户下的EIP的最大带宽。 取值范围：1-1000，具体取值请参考弹性公网服务创建eip资料。 bandwidth_name String 功能说明：EIP的带宽名称。 取值范围：1-64个字符，支持数字、英文字母、中文(\u4e00 - \u9fa5)、_(下划线)、-(中划线)、.(点)。 bandwidth_billing_info String 功能说明：EIP的带宽订单信息。包年/包月EIP带宽才会返回带宽订单信息，按需计费的EIP带宽不返回。 格式：order_id:product_id:region_id:project_id，如： CS22********LIBIV:00301-******-0--0:br-iaas-odin1:0605768a************c006c7e484aa。 share_type String 功能说明: 带宽共享类型。 取值范围： PER：独享带宽。 WHOLE：共享带宽。 表7 PolicyTemplate 名称 类型 描述 ike_policy IkePolicy object ike策略对象。 ipsec_policy IpsecPolicy object ipsec策略对象。 表8 IkePolicy 名称 类型 描述 encryption_algorithm String 功能说明：加密算法。 取值范围：aes-256-gcm-16，aes-128-gcm-16，aes-256，aes-192，aes-128。 dh_group String 功能说明：第一阶段密钥交换使用的DH组。 取值范围：group14，group15，group16，group19，group20，group21，disable。 authentication_algorithm String 功能说明：认证算法。 取值范围：sha2-512，sha2-384，sha2-256。 lifetime_seconds Integer 功能说明：表示SA的生存周期，当该生存周期超时后IKE SA将自动更新。 取值范围：60-604800，单位：秒。 表9 IpsecPolicy 名称 类型 描述 authentication_algorithm String 功能说明：认证算法。 取值范围：sha2-512，sha2-384，sha2-256。 encryption_algorithm String 功能说明：加密算法。 取值范围：aes-256-gcm-16，aes-128-gcm-16，aes-256，aes-192，aes-128。 pfs String 功能说明：PFS使用的DH密钥组。 取值范围：group14，group15，group16，group19，group20，group21，disable。 lifetime_seconds Integer 功能说明：表示配置IPSec连接建立的隧道以时间为基准的生存周期。 取值范围：30-604800，单位：秒。 表10 VpnResourceTag 名称 类型 描述 key String 功能说明：标签的键。 取值范围：1-128个字符，支持数字、英文字母、中文、西班牙语、葡语、空格，以及以下字符：_.:=+-@。 value String 功能说明：标签的值。 取值范围：0-255个字符，支持数字、英文字母、中文、西班牙语、葡语、空格，以及以下字符：_.:=+-@。

请求消息 请求参数 表2 请求参数 名称 类型 是否必选 描述 vpn_gateway UpdateVgwSpecificationRequestBodyContent object 是 vpn_gateway对象 表3 UpdateVgwSpecificationRequestBodyContent 名称 类型 是否必选 描述 flavor String 是 功能说明：更新后的VPN网关规格 取值范围：Basic，Professional1，Professional2，Professional1-NonFixedIP，Professional2-NonFixedIP。 每个网关支持的取值范围参考查询VPN网关响应中的supported_flavors字段 请求样例 POST https://{Endpoint}/v5/{project_id}/vpn-gateways/{vgw_id}/update-specification { "vpn_gateway": { "flavor": "Basic" } }

响应消息 响应参数 返回状态码为 200: successful operation。 表2 响应Body参数列表 名称 类型 描述 availability_zones AvailabilityZones object 可用区列表。 request_id String 请求ID。 表3 AvailabilityZones 名称 类型 描述 basic VpnGatewayAvailabilityZones object Basic网关规格。 professional1 VpnGatewayAvailabilityZones object Professional1网关规格。 Professional1-NonFixedIP VpnGatewayAvailabilityZones object Professional1-NonFixedIP网关规格。 professional2 VpnGatewayAvailabilityZones object Professional2网关规格。 Professional2-NonFixedIP VpnGatewayAvailabilityZones object Professional2-NonFixedIP网关规格。 gm VpnGatewayAvailabilityZones object GM网关规格。 以上网关规格的实际可选范围请参考VPN控制台创建VPN网关页面的Specification选项。 表4 VpnGatewayAvailabilityZones 名称 类型 描述 vpc Array of String 关联VPC类型的可用区列表。 er Array of String 关联ER类型的可用区列表。 响应样例 { "availability_zones": { "basic": { "vpc": ["cn-south-1f"], "er": [] }, "professional1": { "vpc": ["cn-south-1f", "cn-south-1e", "cn-south-1c"], "er": ["cn-south-1f"] }, "professional2": { "vpc": ["cn-south-1f", "cn-south-1e", "cn-south-1c"], "er": ["cn-south-1f"] }, "Professional1-NonFixedIP": { "vpc": [], "er": [] }, "Professional2-NonFixedIP": { "vpc": [], "er": [] }, "gm": { "vpc": ["cn-south-1f", "cn-south-1e", "cn-south-1c"], "er": ["cn-south-1f"] } }, "request_id": "b60309ab-812c-4269-9de4-fb9a65e6db16" }

API概览 虚拟专用网络 提供的接口参见表1，各接口对应的权限说明请参见权限策略和授权项。 表1 VPN接口说明 类型 说明 站点入云VPN API VPN网关 站点入云VPN网关的创建、查询、更新、删除以及查询站点入云VPN网关可用区等接口。 对端网关 对端网关的创建、查询、更新、删除等接口。 VPN连接 VPN连接的创建、查询、更新、删除等接口。 VPN连接监控 VPN连接健康检查的创建、查询、删除等接口。 终端入云VPN API VPN网关 终端入云VPN网关的查询、修改、终端入云VPN网关可用区的查询以及终端入云网关连接信息列表的查询等接口。 服务端 服务端的创建、查询、修改和导出客户端配置，以及客户端CA证书的导入、查询、修改和删除等接口。 用户管理 VPN用户的创建、查询、修改、删除、修改密码和重置密码，以及VPN用户组的创建、批量创建、查询、修改、删除、批量删除、添加VPN用户到组、删除组内VPN用户和查询组内VPN用户等接口。 访问策略 VPN访问策略的创建、查询、修改和删除接口。 服务公共接口 VPN配额 配额查询接口。 VPN标签 标签查询、添加和删除等接口。

响应消息 响应参数 返回状态码为 200: successful operation。 表8 响应Body参数列表 名称 类型 描述 vpn_connection ResponseVpnConnection object vpn_connection对象。 request_id String 请求ID。 表9 ResponseVpnConnection 名称 类型 描述 id String 功能说明：VPN连接ID。 格式：36位UUID。 name String 功能说明：VPN连接名称。 取值范围：1-64个字符，支持数字、英文字母、中文(\u4e00 - \u9fa5)、_(下划线)、-(中划线)。 vgw_id String 功能说明：VPN网关ID。 格式：36位UUID。 vgw_ip String 功能说明： VPN网关EIP的ID或接入私网IP。 格式：36位UUID或点分十进制IPv4地址（如192.168.45.7）。 style String 功能说明：连接模式。 取值范围： POLICY: 策略模式。 STATIC: 静态路由模式。 BGP: bgp路由模式。 POLICY-TEMPLATE: 策略模板模式。 cgw_id String 功能说明：对端网关ID。 格式：36位UUID。 peer_subnets Array of String IPv4对端子网。当VPN网关的关联模式为ER并且style字段为BGP或POLICY、或VPN网关的IP协议版本号为IPv6时不返回。 peer_subnets_v6 Array of String IPv6对端子网。当VPN网关的关联模式为ER并且style字段为BGP或POLICY、或VPN网关的IP协议版本号为IPv4时不返回。 tunnel_local_address String 路由模式下配置在VPN网关上的tunnel接口地址。仅当style为STATIC或BGP时有效。 tunnel_peer_address String 路由模式下配置在用户侧设备上的tunnel接口地址。仅当style为STATIC或BGP时有效。 enable_nqa Boolean 功能说明：开启NQA检测。仅当style为STATIC时返回。 取值范围：true，false。 policy_rules Array of PolicyRule objects IPv4策略模式的策略规则组。仅当style为POLICY且VPN网关的IP协议版本号为IPv4时返回实际的策略规则组。 policy_rules_v6 Array of PolicyRule object IPv6策略模式的策略规则组。仅当style为POLICY且VPN网关的IP协议版本号为IPv6时返回实际的策略规则组。 ikepolicy IkePolicy object ike策略对象。 ipsecpolicy IpsecPolicy object ipsec策略对象。 created_at String 创建时间。 UTC时间格式：yyyy-MM-ddTHH:mm:ssZ。 updated_at String 最后一次更新时间。 UTC时间格式：yyyy-MM-ddTHH:mm:ssZ。 enterprise_project_id String 功能说明：企业项目ID。 格式：36位UUID。与vgw_id所标识VPN网关的企业项目ID一致。 connection_monitor_id String 功能说明：VPN连接监控ID。仅当VPN连接下创建有连接监控时返回。 格式：36位UUID。 ha_role String 功能说明：主备模式VPN网关下的连接时，'master'表示主连接，'slave'表示备连接。双活模式下的连接ha_role都是'master'。 默认值：master。 tags Array of VpnResourceTag objects 标签列表。 表10 PolicyRule 名称 类型 描述 rule_index Integer 功能说明：规则ID。 取值范围：0-50。 source String 源地址网段。 destination Array of String 目的地址网段。单个IPv4网段格式示例：192.168.52.0/24。单个IPv6网段格式示例：16af:cacc:1097::/48。每个PolicyRule最多返回50个。 表11 IkePolicy 名称 类型 描述 ike_version String 功能说明：IKE版本号。 取值范围：v1, v2。 phase1_negotiation_mode String 功能说明：协商模式。仅当IKE版本为v1时返回。 取值范围： main：主模式，协商过程安全性高。 aggressive：野蛮模式，协商快速且协商成功率高。 authentication_algorithm String 功能说明：认证算法。 取值范围：sha2-512，sha2-384，sha2-256，sha1，md5，sm3。 encryption_algorithm String 功能说明：加密算法。 取值范围：aes-256-gcm-16，aes-128-gcm-16，aes-256，aes-192，aes-128，3des，sm4。 dh_group String 功能说明：第一阶段密钥交换使用的DH组，当VPN网关flavor为GM时不返回。 取值范围：group1，group2，group5，group14，group15，group16，group19，group20，group21。 authentication_method String 功能说明：ike协商时的认证方法。 取值范围： pre-share：预共享密钥。 digital-envelope-v2：国密数字信封。 lifetime_seconds Integer 功能说明：表示SA的生存周期，当该生存周期超时后IKE SA将自动更新。 取值范围：60-604800，单位：秒。 local_id_type String 功能说明：本端ID类型，当VPN网关flavor为GM时不返回。 取值范围： ip。 fqdn。 local_id String 本端ID。当local_id_type为ip时返回VPN连接所使用的网关IP；当local_id_type为fqdn时返回创建或更新VPN连接时指定的本端ID。 当VPN网关flavor为GM时不返回。 peer_id_type String 功能说明：对端ID类型，当VPN网关flavor为GM时不返回。 取值范围： ip。 any。 fqdn。 peer_id String 对端ID。当peer_id_type为ip时返回对端网关的IP；当peer_id_type为fqdn时返回创建或更新VPN连接时指定的对端ID；当peer_id_type为any时不返回。 当VPN网关flavor为GM时不返回。 dpd Dpd object 对等体存活检测对象。 表12 Dpd 名称 类型 描述 timeout Integer 功能说明：对等体存活检测报文重传间隔。 取值范围：2-60，单位：秒。 interval Integer 功能说明：对等体存活检测空闲时间。 取值范围：10-3600，单位：秒。 msg String 功能说明：对等体存活检测报文格式。 取值范围： seq-hash-notify：指定DPD报文中的载荷顺序是hash-notify。 seq-notify-hash：指定DPD报文中的载荷顺序是notify-hash。 表13 IpsecPolicy 名称 类型 描述 authentication_algorithm String 功能说明：认证算法。 取值范围：sha2-512，sha2-384，sha2-256，sha1，md5，sm3。 encryption_algorithm String 功能说明：加密算法。 取值范围：aes-256-gcm-16，aes-128-gcm-16，aes-256，aes-192，aes-128，3des，sm4。 pfs String 功能说明：PFS使用的DH密钥组 取值范围：group1，group2，group5，group14，group15，group16，group19，group20，group21，disable。 transform_protocol String 功能说明：传输协议。 取值范围： esp：封装安全协议。 lifetime_seconds Integer 功能说明：表示配置IPSec连接建立的隧道以时间为基准的生存周期。 取值范围：30-604800，单位：秒。 encapsulation_mode String 功能说明：报文封装模式。 取值范围： tunnel：隧道模式。 表14 VpnResourceTag 名称 类型 描述 key String 功能说明：标签的键。 取值范围：1-128个字符，支持数字、英文字母、中文、西班牙语、葡语、空格，以及以下字符：_.:=+-@。 value String 功能说明：标签的值。 取值范围：0-255个字符，支持数字、英文字母、中文、西班牙语、葡语、空格，以及以下字符：_.:=+-@。 响应样例 更新VPN连接的响应。 { "vpn_connection": { "id": "98c5af8a-demo-a8df-va86-ae2280a6f4c3", "name": "vpn-1655", "vgw_id": "b32d91a4-demo-a8df-va86-e907174eb11d", "vgw_ip": "0c464dad-demo-a8df-va86-c22bb0eb0bde", "style": "POLICY", "cgw_id": "5247ae10-demo-a8df-va86-dd36659a7f5d", "peer_subnets": ["192.168.1.0/24"], "tunnel_local_address": "169.254.56.225/30", "tunnel_peer_address": "169.254.56.226/30", "policy_rules": [{ "rule_index": 1, "source": "10.0.0.0/24", "destination": [ "192.168.1.0/24" ] }], "ikepolicy": { "ike_version": "v2", "authentication_algorithm": "sha2-256", "encryption_algorithm": "aes-128", "dh_group": "group15", "authentication_method": "pre-share", "lifetime_seconds": 86400, "local_id_type": "ip", "local_id": "10.***.***.134", "peer_id_type": "ip", "peer_id": "88.***.***.164", "dpd": { "timeout": 15, "interval": 30, "msg": "seq-hash-notify" } }, "ipsecpolicy": { "authentication_algorithm": "sha2-256", "encryption_algorithm": "aes-128", "pfs": "group15", "transform_protocol": "esp", "lifetime_seconds": 3600, "encapsulation_mode": "tunnel" }, "created_at": "2022-11-26T13:41:34.626Z", "updated_at": "2022-11-26T13:41:34.626Z", "enterprise_project_id": "0", "ha_role": "master" }, "request_id": "f91082d4-6d49-479c-ad1d-4e552a9f5cae" } 冻结场景下更新失败。 { "error_code": "VPN.0001", "error_msg": "invalid request: ILLEGAL not allowed update vpnConnection", "request_id": "8c833634-4560-7897-7740-a7462f5bcbd4" }

响应消息 响应参数 返回状态码为 201: successful operation。 表6 响应Body参数列表 名称 类型 描述 vpn_gateway ResponseVpnGateway object VPN网关对象。 request_id String 请求ID。 表7 ResponseVpnGateway 名称 类型 描述 id String 功能说明：VPN网关ID。 格式：36位UUID。 name String 功能说明：VPN网关名称。 取值范围：1-64个字符，包括数字、英文字母、中文(\u4e00 - \u9fa5)、_(下划线)、-(中划线)。 network_type String 功能说明：VPN网关网络类型。 取值范围：public，private。 默认值：public。 attachment_type String 功能说明：关联模式。 取值范围：vpc，er。 ip_version String 功能说明：VPN网关的IP协议版本。 取值范围：ipv4、ipv6。 certificate_id String 功能说明：证书ID。 格式：36位UUID。 er_id String VPN网关所连接的ER实例的ID。仅当attachment_type为er时返回。 vpc_id String 当attachment_type为vpc时，vpc_id是VPN网关关联的业务VPC的ID。 当attachment_type为er时，不返回此字段。可以通过access_vpc_id字段查看VPN网关的接入VPC的ID。 local_subnets Array of String IPv4本端子网。本端子网是云上子网，该网段需要通过VPN与用户侧网络进行互通。单个网段格式示例：192.168.52.0/24。仅当attachment_type为vpc且ip_version为ipv4时返回。 local_subnets_v6 Array of String IPv6本端子网。本端子网是云上子网，该网段需要通过VPN与用户侧网络进行互通。单个网段格式示例：16af:cacc:1097::/48。仅当attachment_type为vpc且ip_version为ipv6时返回。 connect_subnet String VPN网关所使用的VPC中的一个子网ID。 bgp_asn Long VPN网关的BGP自治域编号。 flavor String 功能说明：VPN网关的规格类型。实际可选范围请参考VPN控制台创建VPN网关页面的Specification选项。 取值范围： v300：最大转发带宽300Mbps。该取值已经废弃，但仍然保留兼容性支持，建议不要使用该取值。 v1g：最大转发带宽1Gbps。该取值已经废弃，但仍然保留兼容性支持，建议不要使用该取值。 Basic：最大转发带宽100Mbps。 Professional1：最大转发带宽300Mbps。 Professional1-NonFixedIP：最大转发带宽300Mbps。 Professional2：最大转发带宽1Gbps。 Professional2-NonFixedIP：最大转发带宽1Gbps。 GM: 最大转发带宽500Mbps。 connection_number Integer VPN网关下的最大VPN连接数。 used_connection_number Integer VPN网关下当前已经使用的VPN连接数。 used_connection_group Integer VPN网关下当前已经使用的VPN连接组个数。同一用户网关入云的两条连接组成一个连接组。VPN网关默认支持10个免费的VPN连接组。 enterprise_project_id String 功能说明：企业项目ID。 格式：36位UUID或者"0"。 access_vpc_id String 功能说明：VPN网关使用的接入VPC ID。 格式：36位UUID。 access_subnet_id String 功能说明：VPN网关使用的接入VPC中的子网ID。 格式：36位UUID。 ha_mode String 功能说明：网关的HA模式，"active-active"表示双活，"active-standby"表示主备。 取值范围：active-active，active-standby。 默认值：active-active。 policy_template PolicyTemplate object 非固定IP接入VPN网关网关的策略模板配置，只有在规格为非固定IP接入VPN网关时返回。 tags Array of VpnResourceTag objects 标签列表。 表8 VpnResourceTag 名称 类型 描述 key String 功能说明：标签的键。 取值范围：1-128个字符，支持数字、英文字母、中文、西班牙语、葡语、空格，以及以下字符：_.:=+-@。 value String 功能说明：标签的值。 取值范围：0-255个字符，支持数字、英文字母、中文、西班牙语、葡语、空格，以及以下字符：_.:=+-@。 表9 PolicyTemplate 名称 类型 描述 ike_policy IkePolicy object ike 策略对象。 ipsec_policy IpsecPolicy object ipsec 策略对象。 表10 IkePolicy 名称 类型 描述 encryption_algorithm String 功能说明：加密算法。 取值范围：aes-256-gcm-16，aes-128-gcm-16，aes-256，aes-192，aes-128。 dh_group String 功能说明：第一阶段密钥交换使用的DH组。 取值范围：group14，group15，group16，group19，group20，group21，disable。 authentication_algorithm String 功能说明：认证算法。 取值范围：sha2-512，sha2-384，sha2-256。 lifetime_seconds Integer 功能说明：表示SA的生存周期，当该生存周期超时后IKE SA将自动更新。 取值范围：60-604800，单位：秒。 表11 IpsecPolicy 名称 类型 描述 authentication_algorithm String 功能说明：认证算法。 取值范围：sha2-512，sha2-384，sha2-256。 encryption_algorithm String 功能说明：加密算法。 取值范围：aes-256-gcm-16，aes-128-gcm-16，aes-256，aes-192，aes-128。 pfs String 功能说明：PFS使用的DH密钥组。 取值范围：group14，group15，group16，group19，group20，group21，disable。 lifetime_seconds Integer 功能说明：表示配置IPSec连接建立的隧道以时间为基准的生存周期。 取值范围：30-604800，单位：秒。 响应样例 使用已有EIP创建关联VPC的VPN网关的响应。 { "vpn_gateway": { "id": "134f9fb1-demo-a8df-va86-2040a5c13325", "name": "vpngw-9f24", "network_type": "public", "attachment_type": "vpc", "vpc_id": "0cf79a3f-demo-a8df-va86-d7ace626b0fa", "local_subnets": ["192.168.0.0/24"], "connect_subnet": "f5741286-demo-a8df-va86-2c82bd9ee114", "bgp_asn": 64512, "flavor": "Professional1", "connection_number": 200, "used_connection_number": 0, "used_connection_group": 0, "enterprise_project_id": "0", "access_vpc_id": "0cf79a3f-demo-a8df-va86-d7ace626b0fa", "access_subnet_id": "f5741286-demo-a8df-va86-2c82bd9ee114", "ha_mode": "active-active" }, "request_id": "7b37532a-d6e4-46b9-98dc-9169ec2ca58f" } 新建EIP创建关联ER的VPN网关的响应。 { "vpn_gateway": { "id": "80ac167b-demo-a8df-va86-a9a2a23223b8", "name": "vpngw-1234", "network_type": "public", "attachment_type": "er", "ip_version": "ipv4", "er_id": "cb4a631d-demo-a8df-va86-ca3fa348c36c", "bgp_asn": 65533, "flavor": "Professional2", "connection_number": 200, "used_connection_number": 0, "used_connection_group": 0, "enterprise_project_id": "0", "access_vpc_id": "0cf79a3f-demo-a8df-va86-d7ace626b0fa", "access_subnet_id": "f5741286-demo-a8df-va86-2c82bd9ee114", "ha_mode": "active-active" }, "request_id": "cd71cade-bfbd-410b-b672-4bfe46cfc311" } 创建私网关联VPC的VPN网关的响应。 { "vpn_gateway": { "id": "80ac167b-demo-a8df-va86-a9a2a23223b8", "name": "vpngw-1234", "network_type": "private", "attachment_type": "vpc", "vpc_id": "cb4a631d-demo-a8df-va86-ca3fa348c36c", "local_subnets": ["192.168.0.0/24", "192.168.1.0/24"], "connect_subnet": "f5741286-demo-a8df-va86-2c82bd9ee114", "bgp_asn": 65533, "flavor": "Professional2", "connection_number": 200, "used_connection_number": 0, "used_connection_group": 0, "enterprise_project_id": "0", "access_vpc_id": "cb4a631d-demo-a8df-va86-ca3fa348c36c", "access_subnet_id": "f5741286-demo-a8df-va86-2c82bd9ee114", "ha_mode": "active-active" }, "request_id": "cd71cade-bfbd-410b-b672-4bfe46cfc311" }