华为云用户手册

请求示例 创建事件单。 https://{Endpoint}/v1/external/incident/create { "incident_type" : "inc_type_p_security_issues", "creator" : "9605B67C741D4553887A3462771107D3", "current_cloud_service" : [ "app001" ], "assignee_scene" : "", "is_service_interrupt" : true, "enterprise_project" : [ "0" ], "incident_description" : "事件描述", "incident_assignee" : [ "9605B67C741D4553887A3462771107D3" ], "incident_level" : "level_50", "assignee_role" : "", "incident_title" : "事件标题", "incident_source" : "incident_source_manual", "region" : [ "OCB_Cloud" ] }

createClient(2.10.6之前版本) createClient(type: string): HWLLSClient | HWFlvClient | HWHlsClient 【功能说明】 创建一个直播拉流客户端对象，如果需要拉取多个直播流则需要创建多个客户端对象。 【请求参数】 type：string类型，可选。创建的拉流客户端类型。 低时延直播拉流客户端类型：webrtc。 flv直播拉流客户端类型：flv。 HLS直播拉流客户端类型：hls（预留，暂未开放）。 缺省值：webrtc。 【返回参数】 client：拉流客户端对象。 2.10.6版本及之后的SDK不支持独立使用HWFlvClient和HWHlsClient这两种播放器，如您正在使用旧版本SDK，需参考详细接口请查看附录：客户端对象（HWFlvClient） 客户端对象（HWHlsClient）

setLogLevel setLogLevel(level: string): boolean 【功能说明】 设置Console上打印的日志级别，如不设置日志级别，则console日志打印级别默认为error。 【请求参数】 level：string类型，必选，日志级别标识。 none：关闭全部级别的日志打印。 error：打印error级别日志。 warn：打印warn级别及更高级别日志。 info：打印info级别及更高级别日志。 debug：打印debug级别及更高级别日志。 【返回参数】 boolean：设置日志级别结果。true表示日志级别设置成功，false表示日志级别设置失败。

setReportConfig setReportConfig(reportConfig:ReportConfig):boolean 【功能说明】 设置打点能力以及打点和日志上传的认证策略。 【请求参数】 reportConfig：ReportConfig类型，必选。ReportConfig定义如下所示： enable：必选，布尔类型，true表示开启打点，false表示关闭打点。默认true。 tokenConfig：可选，对象定义如下所示： enable：布尔类型，true表示开启认证，false表示关闭认证。默认false。 tokenInfo：数组类型，数组内部ReportTokenInfo类。ReportTokenInfo定义如下所示： appid：string类型。传入appid。 expTimestamp：string类型。过期时间戳，系统当前UNIX时间戳加上鉴权过期时间（推荐7200秒，最长需要小于43200秒，即12个小时）。 例如：当前UNIX时间戳为：1708531200，鉴权过期时间自定义为7200秒，那么过期的时间戳为：1708538400，即表示该校验字符串在2024-02-22 02:00:00过期。 token：string类型。hmac_sha256生成的字符串。hmac_sha256(共享密钥, 过期的时间戳 + appID)。共享密钥由用户控制获取。 【返回参数】 返回值布尔值， true表示设置成功，false表示设置失败。 开启了认证策略，实际请求状态会通过on函数注册Error回调获得。

setParameter setParameter(parameterKey: string, parameterValue: any): boolean 【功能说明】 设置全局配置参数。 【请求参数】 参数名称 参数值 LOADING_CONFIG LoadingConfig类型，定义如下： { netQualityLoading：可选，boolean类型。true表示开启根据网络质量进行loading效果展示，默认值为false，关闭。 netQualityLoadingThreshold：可选，number类型。展示loading效果的网络质量（network-quality）的阈值，默认网络质量等级为5。 frameStuckLoading：可选，boolean类型。true表示开启根据帧卡顿时长进行loading效果展示，默认值为false frameStuckThreshold：可选，number类型。展示loading效果帧卡顿时长的阈值，单位为100ms。默认值为10，表示帧卡顿时长为1000ms。 } 注意： 需要在起播之前进行设置。 DNS_QUERY_ENABLE boolean类型，可选，默认为false，true表示开启DNS结果解析，false表示关闭DNS结果解析。 AC CES S_DOMAIN string类型，可选，默认为空，主要用于拉流环境配置，联系技术支持填入。 GLSB_DOMAIN string类型，可选，默认为空，主要用于GSLB环境配置，联系技术支持填入。 BACKGROUND_PLAY boolean类型，可选，默认为false，true表示开启后台播放，false表示关闭后台播放 AUTO_DOWNGRADE boolean类型，可选，默认为true，true表示开启自动降级，false表示关闭自动降级 【返回参数】 boolean：配置参数设置结果。true表示参数设置成功，false表示参数设置失败。

on on(event: string, handler: function, withTimeout?: boolean): void 【功能说明】 注册客户端对象事件回调接口。 【请求参数】 event：必选，string类型，事件名称， 注册Error事件，监听打点或者日志上传的错误信息。 handler：必选，function类型，事件处理方法。 handler方法会传参errorInfo，errorInfo是一个对象，其定义如下所示： { code：必选，number类型，错误码。 message：必选，string类型，错误描述。 appid：必选，string类型，错误日志标识。 } withTimeout：选填，boolean类型，是否超时报错。 【返回参数】 无

隐私声明 华为云低时延直播SDK是由 华为云计算 有限公司（以下简称“我们”或“华为云”）面向华为云客户提供，方便用户接入低时延直播。华为云客户根据开发文档和用户指南，在其应用中集成低时延直播SDK后，我们将通过被集成的低时延直播SDK向华为云客户面向的最终用户（以下简称“您”或“用户”）提供相关服务，处理华为云客户的应用相关的数据，相关数据中可能包含您的个人信息。华为云非常重视您的个人信息和隐私保护，我们将会按照法律要求和业界成熟的安全标准，为您的个人信息提供安全保护措施。 我们将通过本声明向您说明我们如何收集、使用、披露、保护、存储及传输您的个人信息。 请注意，我们要求集成华为云低时延直播SDK的所有华为云客户，必须做到严格遵循法律法规、开发者协议去处理您的个人信息。在接入、使用各开放能力前，华为云客户必须在其产品应用的隐私政策中，向您告知其集成SDK处理个人信息的基本情况，并获取您的同意或取得其他合法性基础。但我们无法控制华为云客户及其开发的应用如何处理华为云客户所控制的个人信息，也不对其行为负责。我们建议您认真阅读华为云客户的应用相关用户协议及隐私政策。在确认充分了解并同意，华为云客户如何处理您的个人信息后，再使用华为云客户的应用。 一、我们如何收集和使用您的个人信息 华为云仅会根据本声明以下所述目的和方式收集和使用您的个人信息。如果我们要将收集的个人信息用于本声明未载明的其他目的，我们会以合理的方式自行或通过华为云客户明确向您告知，并再次获取您的同意或取得其他合法性基础。如果SDK存在扩展功能，或收集和使用了您的可选个人信息，我们会在下文特别说明。 低时延直播的功能 为了向您提供低时延直播的功能，我们会处理您的音视频流，用于低时延直播的播放。这些内容数据不会被存储，仅在服务器内存中缓存，直播结束后自动清除。 低时延直播体验指标及问题定位的功能 为了向您提供低时延直播体验指标功能以及问题定位的功能，我们会处理您的IP地址、运营商信息、WiFi状态、浏览器信息、操作系统信息、设备型号等数据，用于对低时延直播的首屏时长、播放帧率、网络码率、成功率、观看人数、卡顿率等指标进行统计，以及用于协助您进行业务功能的问题定位和分析。您的上述数据将在中华人民共和国境内处理，这些内容数据的存储期限默认为90天。此为可选功能，可通过SDK接口打开关闭。 您的上述数据在中华人民共和国境内处理，我们不会将上述数据用作其他用途。您完全拥有上述数据所有权及控制权，低时延直播SDK仅接受委托处理您的数据。 二、设备权限调用 当您使用相应功能及服务时，我们会通过华为云客户的应用向系统申请您设备的相应权限。您可以在设备的设置功能或“隐私设置”中，查看权限状态，并选择开启或关闭部分或全部权限。华为云客户在集成使用相应开放能力时，可自行决定权限的调用范围，华为云客户向您说明权限调用的用途。您根据华为云客户的应用请求，开启任一权限，即代表授权我们处理相关个人信息来为您提供相应服务；一旦您关闭任一权限即代表您取消了授权，我们将不再基于对应权限继续处理相关个人信息，可能无法继续为您提供该权限所对应的功能。请注意，您关闭权限的决定，不会影响此前基于您授权所进行的个人信息处理活动的效力。当前华为云低时延直播SDK暂不涉及申请设备权限，无需向您申请授权。 三、对未成年人的保护 在您开始使用本服务时，须承诺您是成年人。若您是未成年人，须您的父母或监护人同意您使用本服务及相关服务条款。 如果未成年人在未经父母或监护人同意的情况下，向我们提供了个人信息，父母或监护人可以联系我们，停止收集、使用或披露其个人信息。 如果我们发现在未事先获得可证实的父母或监护人同意的情况下，收集了未成年人的个人信息，会设法尽快删除相关数据。 如果华为云客户使用本服务用于教育用途，且您的最终用户可能是未成年人，请确保您的最终用户使用本服务前已获得其父母或监护人的明确同意。 四、管理您的个人信息 华为云非常尊重您对个人信息的关注，我们将遵照相关法律法规的要求，协调、支持并保障您行使访问、复制、更正或删除个人信息操作的主体权利。 由于您是通过华为云客户的应用使用华为云低时延直播SDK和服务，如果您希望访问、复制或更正与华为云低时延直播SDK的个人信息，您应通过华为云客户的应用提供的路径实现您的个人信息主体权利。 为保障您访问、复制、更正或删除个人信息的权利实现，我们在与华为云客户的协议中，明确要求华为云客户承诺根据法律法规要求，向您提供便捷的权利实现方式。同时，我们的开放能力也向华为云客户提供了相关的接口，支持华为云客户通过接口调用方式来执行您关于个人信息的访问、复制、更正、删除的权利请求。您也可以通过本声明中“如何联系我们”所述联系方式与我们取得联系，我们将尽力协调、支持并保障您的上述权利实现。 当您直接向我们提出个人信息主体权利时，为了保障您的数据安全和其他合法权益，我们可能会对您的身份进行验证并要求您提供验证身份所必要的个人信息，同时我们也可能会向华为云客户提供收集的身份验证信息以核实您的身份。在验证确认您的身份后，我们会根据法律法规要求及时响应您的相关请求。 如您对您的数据主体权利有进一步要求或存在任何疑问、意见或建议，可通过本声明中“如何联系我们”所述方式与我们取得联系，并行使您的相关权利。 五、信息存储地点及期限 存储地 上述信息将会传输并保存至中华人民共和国境内的服务器。 存储期限 音视频数据在拉流结束后，会立即删除。其他数据会在使用结束90天后删除。 我们仅在实现本声明所述目的所必需的时间内，保留您的个人信息。并在超出保留时间后，删除或匿名化处理您的个人信息，除非法律法规另有要求。 六、如何联系我们 我们设立了个人信息保护专职部门。当您有任何疑问、建议、投诉、请求，请通过访问隐私问题页面与我们联系。我们将尽快处理您提交的问题，并在15个工作日或法律法规规定的期限内，答复您的问题。 如果您对我们的回复不满意，特别是认为我们的个人信息处理行为损害了您的合法权益，您还可以向有管辖权的个人信息保护机构或其他监管部门进行投诉或举报。 一般情况下，我们会尽最大努力响应和处理您的请求。结合您的请求或问题的复杂程度，我们可能会有所延迟，但我们会告知您延迟的理由。

enableStreamStateDetection enableStreamStateDetection(enable: boolean, interval: number, interruptRetry:StreamInterruptRetry): boolean 【功能说明】 开启/关闭音、视频码流状态探测功能，开启后可探测推流侧是否处于断流的状态。 【请求参数】 enable：必选，boolean类型，true表示开启音视频码流状态探测，false表示关闭音视频码流状态探测。默认值为false。 interval：必选，number类型，单位为秒，取值范围为[1,60]。音视频无码流状态的判断时间。默认值为3，推荐设置为3。 interruptRetry：可选，StreamInterruptRetry类型。断流重试播放配置参数，StreamInterruptRetry定义为：{ enable：boolean类型，开启断流后尝试自动恢复播放。默认值为false，即不开启自动重试。 retryInterval：number类型，拉流播放的重试周期，单位为秒。最小值1，最大值建议不超过60，默认值为3。 retryTimes：number类型，尝试重新恢复播放的最大重试次数。最小值1，默认值为30。 } 【返回参数】 boolean：是否成功，true表示成功，false表示失败。 Android端QQ浏览器不支持该功能。

on on(event: string, handler: function, withTimeout?: boolean): void 【功能说明】 注册客户端对象事件回调接口。 【请求参数】 event：必选，string类型，事件名称。具体请参见HWLLSClientEvent。 handler：必选，function类型，事件处理方法。 withTimeout：选填，boolean类型，是否超时报错 【返回参数】 无

streamStatistic streamStatistic(enable: boolean, interval: number): void 【功能说明】 设置是否开启流信息统计。 【请求参数】 enable：必选，boolean类型，是否开启流信息统计，true表示开启统计。 interval：必选，number类型，设置统计间隔，单位为秒，取值范围为[1, 60]，默认值为1。 【返回参数】 无

修订记录 表1 修订记录 修改时间 修改说明 2025-02-17 1、优化播放异常的事件通知，补充代码示例。 2、优化自动降级策略。 3、优化降级播放逻辑；不再支持FLV、HLS独立播放器，旧文档迁移至附录。 4、新增两项常见问题说明。 2024-12-02 低时延直播Web SDK更新点，如下所示： 支持自动降级和指定降级。 支持移动端后台播放音频。 解决设备兼容性问题。 支持多实例video标签id。 2024-11-12 新增最佳实践及其相关的代码示例。 2024-06-27 新增setReportConfig接口，更新SDK。 2024-03-19 1、新增SDK包下载路径及其完整性校验方法。 2、新增FLV、HLS等相关资料。 2023-10-30 第一次正式发布。 父主题： Web SDK

network-quality 【事件说明】 网络质量报告事件。 【回调参数】 NetworkQualityTypes：NetworkQualityTypes类型，网络质量详情。 NetworkQualityTypes枚举值参考如下： NETWORK_QUALITY_UNKNOW = 0，网络质量未知。 NETWORK_QUALITY_GREAT = 1，网络质量极好。 NETWORK_QUALITY_GOOD = 2，用户主观感觉和极好差不多，但码率可能略低于极好。 NETWORK_QUALITY_DEFE CTS = 3，网络质量一般，用户主观感受有瑕疵但不影响观看。 NETWORK_QUALITY_WEAK = 4，网络质量差，勉强能观看但不流畅。 NETWORK_QUALITY_BAD = 5，网络质量很差，严重影响用户观看体验。 NETWORK_QUALITY_DISCONNECT = 6，网络质量非常差甚至链接断开，无法观看。

Error 【事件说明】 客户端错误事件，当出现不可恢复的错误后，Client会上报该事件通知。 【回调参数】 errorInfo：必选，HwLLSError类型，错误信息，详见错误码（HwLLSError）。 errorInfo定义为：{ code：必选，number类型，错误码。 message：必选，string类型，错误描述。 getCode(): number， 必选，返回错误码。 getMsg(): string，必选，返回错误描述。 } 在网络防火墙限制（UDP端口限制）或者低时延直播多次重试播放失败的场景下，可根据特定错误码（HWLLS_MEDIA_NETWORK_ERROR、HWLLS_PLAY_WEBRTC_RETRY_FAILED），进行播放降级，请参考SDK使用。

media-statistic 【事件说明】 媒体统计事件。此事件配合streamStatistic方法使用。 【回调参数】 StatisticInfo：StatisticInfo类型，媒体统计信息。 StatisticInfo定义为：{ video：{ codec: string; // 媒体格式 bitRate: number; // 码率 kbps packetsReceived?: number; // 累计接收包数 packetsLost?: number; // 累计丢包数 jitterBufferDelay?: number; // 抖动时延 ms frameRate: number; // 接收帧率 fps frameDecodedRate?: number; // 解码帧率 fps width: number; // 宽度 height: number; // 高度 framesReceived?: number; // 累计接收帧数 framesDecoded?: number; // 累计解码帧数 framesDropped?: number; // 累计丢帧数 nackCount?: number; // 累计重传数 firCount?: number; // 累计关键字请求数 pliCount?: number; // 累计帧请求数 frameDecodeAvgTime?: number; // 平均解码时延 freeze200Count: number; // 200ms卡顿次数 freeze200Duration: number; // 200ms卡顿时长 freeze600Count: number; // 600ms卡顿次数 freeze600Duration: number; // 600ms卡顿时长 } audio：{ codec: string; // 媒体格式 bitRate: number; // 码率 kbps packetsReceived?: number; // 累计接收包数 packetsLost?: number; // 累计丢包数 jitterBufferDelay?: number; // 抖动时延 ms audioLevel?: number; // 音量等级 freeze200Count: number; // 200ms卡顿次数 freeze200Duration: number; // 200ms卡顿时长 } }

合规使用指南 华为云Live云直播低时延直播场景SDK开发者合规指南 《中华人民共和国个人信息保护法》自2021年11月1日起正式施行后，监管部门、各行业参与方和终端消费者越来越关注用户的隐私保护问题。为了有效治理App、SDK违规收集使用个人信息的现象，监管部门也陆续出台相关标准规范。 您作为开发者为最终用户提供服务，知悉并确认将遵守适用的法律法规和相关的标准规范，履行个人信息保护义务，并遵循合法、正当、必要和诚信的原则处理用户个人信息，包括但不限于《中华人民共和国个人信息保护法》、《中华人民共和国网络安全法》、《中华人民共和国数据安全法》以及其他适用的法律法规和相关的标准规范。 此文档用于帮助您更好地了解【华为云低时延直播SDK】并合规的使用【华为云低时延直播SDK】服务，仅适用于开发者的业务区域为中国大陆地区的场景。 一、基本要求 您的产品及服务需要尊重用户隐私，遵守国家的数据保护法律和法规。禁止参与任何干扰、干涉、损害、未授权访问任何终端设备、服务器、网络的活动。 1. 隐私政策要求 您需根据法律要求以自身名义发布隐私政策，并就个人信息的处理行为获取用户同意或取得其他合法性基础。隐私政策的要求包括不限于如下： 有独立文本，不能作为用户协议的一部分。 App首次运行收集处理个人信息前需要以醒目方式提示用户阅读隐私政策。隐私政策需方便用户查看，例如用户在App主功能界面中通过4次以内的点击或滑动操作可访问。 描述语言需要清晰通俗，符合通用语言习惯，避免使用有歧义的语言。 隐私政策内容要包含产品及服务收集个人信息的目的、方式和范围，个人信息处理者的名称和联系方式等。 您的产品及服务如涉及向第三方共享个人信息或集成了第三方的SDK时，需要在隐私政策中向用户进行披露和说明，获取用户的授权或同意。 2. 处理个人信息要求 您的产品及服务在处理用户个人信息时，需要遵守的要求包括不限于如下： 处理个人信息需要基于使用目的所必需，满足最小化原则。 实际收集和处理的个人信息范围、使用目的需要与隐私政策的范围保持一致。 收集个人信息的频率需与隐私政策保持一致，禁止超频次收集个人信息。 有明确的个人信息到期删除机制，个人信息的存留期与隐私政策保持一致，到期按时删除个人信息或对个人信息进行匿名化处理。 如涉及处理不满十四周岁未成年人个人信息前，应取得未成年人的父母或其他监护人的同意。 如涉及处理个人信息用于个性化推荐功能或大数据分析业务的，应告知并取得最终用户的授权同意情况下方可开展相关业务功能。 如涉及处理敏感个人信息前，应取得最终用户的单独同意。 如涉及跨境传输个人信息，需要按照国家网信部门会同国务院有关部门制定的办法和相关标准进行安全评估，并符合其要求。同时您还取得最终用户的单独同意。 支持用户方便的行使数据主体权利，例如查阅、复制、更正、删除个人信息等权利。 二、声明SDK处理的个人信息 在您接入、使用【华为云低时延直播SDK】服务前，我们要求您在隐私政策中向用户告知我们SDK的名称、SDK提供方名称、收集个人信息类型、使用目的、隐私政策链接，并获取用户的同意或取得其他合法性基础。您可以参考如下方式提供条款内容： 1. 以文字方式向用户告知 第三方SDK名称：华为云低时延直播SDK 第三方公司名称：华为云计算技术有限公司 收集个人信息类型： 音视频流、IP地址、运营商信息、WiFi状态、浏览器信息、操作系统信息、设备型号。 使用目的：为您提供音 视频直播 服务，向您提供低时延直播体验指标功能，以及方便问题定位。 隐私政策链接：隐私声明 2. 以表格方式向用户告知 第三方SDK名称 第三方公司名称 收集个人信息类型 使用目的 隐私政策链接 华为云低时延直播SDK 华为云计算技术有限公司 音视频流、IP地址、运营商信息、WiFi状态、浏览器信息、操作系统信息、设备型号 为您提供音视频直播服务，向您提供低时延直播体验指标功能，以及方便问题定位。 隐私声明 三、权限使用要求 我们SDK在提供服务时会最小化的使用系统权限，您需要根据实际使用的功能申请对应的系统权限并向用户告知征得其同意。 权限 权限描述 使用目的 无 无 无 四、延迟初始化要求 为了避免您的应用在未获取用户的同意前SDK提前处理用户的个人信息。我们提供了SDK初始化的接口createClient(type: string)，请保证您的应用获取用户同意后才能调用此接口初始化SDK。 五、最小化使用功能要求 我们的SDK针对扩展功能和可选的个人信息的处理提供了配置能力，您可以基于业务诉求选择开启或关闭相关功能，低时延直播SDK提供开关上报日志的方法。 1. setReportConfig(reportConfig:ReportConfig)接口中reportConfig包含enable参数，设置为false时，不会进行日志上报，设置为true时，才会进行日志上报。 2. setLogLevel(level: string)接口中level设置为none，则关闭日志打印，设置为error、warn、info或者debug，则会输出对应日志打印。

SDK维护周期 低时延直播客户端SDK提供一年的维护周期，当前各版本的维护周期详情，如表1所示。 2.6.3之前的版本已经不提供维护，如果使用中有问题，请升级到最新版本。 表1 SDK维护周期 SDK版本号 发布时间 维护结束时间 2.10.9 2025-02-17 2026-02-17 2.10.3 2024-12-02 2025-12-02 2.6.9 2024-06-27 2025-06-27 2.6.3 2024-06-12 2025-06-12

软件包完整性校验 用户可对下载的SDK包进行完整性校验，判断下载过程中是否存在篡改和丢包现象。 详细操作如下所示： 在表1中下载SDK包及其完整性校验sha256包至本地。 打开本地命令提示符框，输入如下命令，在本地生成已下载SDK包的SHA256值。 其中，“D:\HWLLS_SDK_Web_2.6.0.tar.gz”为SDK包本地存放路径和SDK包名，请根据实际情况修改。 certutil -hashfile D:\HWLLS_SDK_Web_2.6.0.tar.gz SHA256 命令执行结果示例，如下所示： SHA256 的 D:\HWLLS_SDK_Web_2.6.0.tar.gz 哈希: 3ac83be852e8dcc9e90f236801fd4c494983073543e1ae66ee4d0c29043dccd1 CertUtil: -hashfile 命令成功完成。 比对查询出的SDK包SHA256值和下载后的SDK包SHA256值。 如果一致，说明下载过程中不存在篡改和丢包现象。

URI POST https://{Endpoint}/v3/{project_id}/instances/db-upgrade/schedule-task 表1 参数说明 参数 是否必选 参数类型 描述 project_id 是 String 参数解释： 租户在某一Region下的项目ID。 获取方法请参见获取项目ID。 约束限制： 不涉及。 取值范围： 只能由英文字母、数字组成，且长度为32个字符。 默认取值： 不涉及。

响应示例 { "instance_tasks": [ { "task_id": "07c5880a-cbf0-44ad-91c1-5803a10f11a1", "task_name": "HOTFIX_VERSION_UPGRADE", "instance_id": "cc0ae5c47bf94834bf9e44138f7f995ain14" }, { "task_id": "07c5880a-cbf0-44ad-91c1-5803a10f11a1", "task_name": "HOTFIX_VERSION_UPGRADE", "instance_id": "aa0ae5c47bf94834bf9e44138f7f995ain14" } ] }

请求参数 表2 请求Body参数 参数 是否必选 参数类型 描述 instance_ids 是 Array of strings 批量实例ID。 start_time 是 String 任务开始时间。 upgrade_type 是 String 实例升级类型。区分大小写。 取值范围： hotfix：热补丁升级。 upgrade_action 是 String 实例升级操作，热补丁升级目前只包括升级自动提交。 upgradeAutoCommit：升级自动提交。 target_version 是 String 批量实例升级目标版本。

请求示例 批量实例热补丁升级并采用升级自动提交方式升级传参。 POST https://gaussdb-opengauss.cn-north-4.myhuaweicloud.com/v3/0483b6b16e954cb88930a360d2c4e663/instances/db-upgrade/schedule-task { "instance_ids" : [ "cc0ae5c47bf94834bf9e44138f7f995ain14", "aa0ae5c47bf94834bf9e44138f7f995ain14" ], "start_time": "2023-06-06T01:47:20+0800", "upgrade_type" : "hotfix", "upgrade_action" : "upgradeAutoCommit" , "target_version" : "3.208.0.6,3.208.0.7" }

响应参数 表2 响应Body参数列表 名称 参数类型 说明 instance_id String 实例ID。 status String 流式容灾状态。 normal：该集群未参与容灾。 full_backup：主集群数据全量复制中。 archive：主集群日志流式复制中。 backup_fail：主集群数据全量复制失败。 archive_fail：主集群日志流式复制失败。 switchover：计划内主备倒换中。 restore：灾备集群数据全量恢复中。 restore_fail：灾备集群全备恢复失败。 recovery：灾备集群日志流式复制中。 recovery_fail：灾备集群日志流式复制失败。 promote：灾备集群升主中。 promote_fail：灾备集群升主失败。 rpo String 数据恢复点目标。 rto String 数据恢复时间目标。 rpo_threshold String RPO阈值。 rto_threshold String RTO阈值。 switchover_progress String 主备切换进度。该值为一个百分数。例如：40%。 failover_progress String 容灾升主进度。该值为一个百分数。例如：40%。

响应示例 { "rpo":"0", "rto":"0", "status":"archive", "instance_id":"b3692282395340c5b5421ecf3d7bd6adin14", "rto_threshold":"900", "rpo_threshold":"10", "failover_progress":"", "switchover_progress":"" }

URI GET https://{Endpoint}/v3.5/{project_id}/instances/{instance_id}/disaster-recovery/monitor?disaster_type={disaster_type} 表1 参数说明 名称 是否必选 参数类型 说明 project_id 是 String 参数解释： 租户在某一Region下的项目ID。 获取方法请参见获取项目ID。 约束限制： 不涉及。 取值范围： 只能由英文字母、数字组成，且长度为32个字符。 默认取值： 不涉及。 instance_id 是 String 实例ID。 disaster_type 是 String 容灾类型： stream：流式容灾。

URI POST https://{Endpoint}/v3.5/{project_id}/instances/{instance_id}/disaster-recovery/switchover 表1 参数说明 名称 是否必选 说明 project_id 是 参数解释： 租户在某一Region下的项目ID。 获取方法请参见获取项目ID。 约束限制： 不涉及。 取值范围： 只能由英文字母、数字组成，且长度为32个字符。 默认取值： 不涉及。 instance_id 是 实例ID。

请求示例 POST https://gaussdb-opengauss.cn-north-1.myhuaweicloud.com/v3.5/0483b6b16e954cb88930a360d2c4e663/instances/c04c789b6baa4b6dbcc139c5226f3a2cin14/disaster-recovery/switchover { "disaster_type" : "stream" }

请求参数 表2 参数说明 名称 是否必选 参数类型 说明 disaster_type 是 String 容灾类型。 枚举值： stream：流式容灾。 post_process_config 否 String 是否支持倒换失败自愈，为空时默认不自愈。 枚举值： AUTO：容灾切换失败故障自愈。 MANUAL：容灾切换失败不自愈。 该字段仅支持数据库引擎版本大于等于V2.0-8.200的Quorum流式容灾，其他场景的容灾主备切换不提供自愈功能。

URI POST https://{Endpoint}/v3.5/{project_id}/instances/{instance_id}/disaster-recovery/simulation-stop 表1 参数说明 名称 是否必选 说明 project_id 是 参数解释： 租户在某一Region下的项目ID。 获取方法请参见获取项目ID。 约束限制： 不涉及。 取值范围： 只能由英文字母、数字组成，且长度为32个字符。 默认取值： 不涉及。 instance_id 是 实例ID。

请求示例 POST https://gaussdb-opengauss.cn-north-1.myhuaweicloud.com/v3.5/0483b6b16e954cb88930a360d2c4e663/instances/c04c789b6baa4b6dbcc139c5226f3a2cin14/disaster-recovery/simulation-stop { "disaster_type" : "stream" }

请求示例 POST https://gaussdb-opengauss.cn-north-1.myhuaweicloud.com/v3.5/0483b6b16e954cb88930a360d2c4e663/instances/c04c789b6baa4b6dbcc139c5226f3a2cin14/disaster-recovery/keep-log-stop { "disaster_type" : "stream" }