响应消息样式 plaintext HTTP/1.1 Status Code xamzrequestid: Request Id ContentType: application/xml ContentLength: 0 Date: Date Connection: KeepAlive 响应消息头 该请求的响应消息使用公共的响应消息头，请参见如何调用API响应结果响应消息头。 响应消息元素 该请求的响应中不带有响应元素。 错误码 请参见调用前必知错误码全局错误码。

响应消息样式 plaintext HTTP/1.1 Status Code xamzrequestid: Request Id ContentType: ContentType ContentLength: ContentLength Date: Date Connection: KeepAlive 响应消息头 该请求的响应消息使用公共的响应消息头，请参见如何调用API响应结果响应消息头。 响应消息元素 该请求的响应中不带有响应元素。 错误码 请参见调用前必知错误码全局错误码。

响应消息样式 plaintext HTTP/1.1 Status Code xamzrequestid: Request Id ContentType: ContentType ContentLength: ContentLength Date: Date Connection: KeepAlive 响应消息头 该请求的响应消息使用公共的响应消息头，请参见如何调用API响应结果响应消息头。 响应消息元素 该请求的响应中不带有响应元素。 错误码 请参见调用前必知错误码全局错误码。

响应消息样式 plaintext HTTP/1.1 Status Code xamzrequestid: Request Id ContentType: application/xml ContentLength: 0 Date: Date Connection: KeepAlive 响应消息头 该请求的响应消息使用公共的响应消息头，请参见如何调用API响应结果响应消息头。 响应消息元素 该请求的响应中不带有响应元素。 错误码 请参见调用前必知错误码全局错误码。

参数名称 说明 行动规则名称 行动规则的名称，只能由数字、字母、下划线组成，且不能以下划线开头和结尾，长度为3到36个字符。 描述 行动规则的描述。 行动规则类型 告警行动规则与SMN主题、消息模板关联的类型，请从下拉列表中选择。当前只支持“通知”类型。 主题 SMN主题，请从下拉列表中选择。若没有合适的主题，请单击主题选择栏下方“创建主题”，在SMN界面创建。 消息模板 通知消息的模板，请从下拉列表中选择。若没有合适的消息模板，请单击消息模板选择栏右侧“创建消息模板”，新建消息模板。

响应消息样式 plaintext HTTP/1.1 Status Code acceptranges: AcceptRanges LastModified: LastModified ContentLength: ContentLength ETag: ETag Date: Date Connection: KeepAlive xamzrequestid: Request Id 响应消息头 该请求的响应消息使用公共的响应消息头，请参见如何调用API响应结果响应消息头。 响应消息元素 该请求的响应中不带有响应元素。 错误码 请参见调用前必知错误码全局错误码。

请求消息元素 该请求消息中不带消息元素。 响应消息样式 plaintext HTTP/1.1 Status Code xamzrequestid: string ContentLength: 0 Date: Fri, 01 Apr 2022 08:43:40 GMT Connection: KeepAlive xamzrequestid: tx00000000000000000002100624d98b11217bdefault 响应消息头 该请求的响应消息使用公共的响应消息头，请参见如何调用API响应结果响应消息头。 响应消息元素 该请求的响应中不带有响应元素。 错误码 请参见调用前必知错误码全局错误码。

响应消息样式 plaintext HTTP/1.1 Status Code xamzrequestid: tx00000000000000000000a00624e497a5e72default ContentLength: 0 Date: Thu, 07 Apr 2022 02:16:42 GMT Connection: KeepAlive 响应消息头 该请求的响应消息使用公共的响应消息头，请参见如何调用API响应结果响应消息头。 响应消息元素 该请求的响应中不带有响应元素。 错误码 请参见调用前必知错误码全局错误码。

响应消息样式 plaintext HTTP/1.1 Status Code xamzrequestid: tx00000000000000000000e00624e4c295e72default ContentLength: 0 Date: Thu, 07 Apr 2022 02:28:09 GMT Connection: KeepAlive 响应消息头 该请求的响应消息使用公共的响应消息头，请参见如何调用API响应结果响应消息头。 响应消息元素 该请求的响应中不带有响应元素。 错误码 请参见调用前必知错误码全局错误码。

告警策略模板 1. 登录ECX控制台，点击【服务管理>告警管理>告警模板】。 2. 点击【+创建告警模板】可以创建告警策略模板。 3. 通过创建告警策略模板，可以在创建告警策略时，选择对应的模板，快速创建告警策略。 告警消息 1. 登录ECX控制台，点击【服务管理>告警管理>告警消息】。 2. 告警消息版块可以查看所有的告警消息。 3. 如果触发告警的问题已修复，可以对告警消息点击【处理】，告警消息将被标记为【已恢复】。

功能说明 GetObjectLegalHold请求获取指定对象的当前依法保留状态。 请求消息样式 plaintext GET /{Bucket}/{Key}?legalhold&versionIdVersionId HTTP/1.1 Host: xxx.zos.ctyun.cn AcceptEncoding: identity xamzcontentsha256: ContentSHA256 xamzdate: 20220412T100505Z Authorization: string 请求消息参数 参数名称 参数描述 类型 是否必须 Bucket 参数解释： Bucket的名称。 String 是 Key 参数解释： 对象名称。 String 是 versionId 参数解释： 对象的版本ID。 String 否 请求消息头 该请求使用公共的请求消息头，请参见如何调用API构造请求请求消息头。 请求消息元素 该请求消息中不带消息元素。 响应消息样式 plaintext HTTP/1.1 Status Code xamzrequestid: tx00000000000000000000d00624e4bc55e72default ContentType: application/xml ContentLength: 80 Date: Thu, 07 Apr 2022 02:26:29 GMT Connection: KeepAlive string 响应消息头 该请求的响应消息使用公共的响应消息头，请参见如何调用API响应结果响应消息头。 响应消息元素 参数名称 参数描述 类型 LegalHold 参数解释： 指定对象依法保留配置。 Container 表LegalHold 参数名称 参数描述 类型 Status 参数解释： 是否打开对象依法保留。 取值范围： ON：打开 OFF：关闭 String

功能说明 Get object retention获取对象的保留期限设置。 请求消息样式 plaintext GET /{Bucket}/{Key}?retention&versionIdVersionId HTTP/1.1 Host: xxx.zos.ctyun.cn AcceptEncoding: identity XAmzContentSHA256: ContentSHA256 XAmzDate: 20220412T100505Z Authorization: string 请求消息参数 参数名称 参数描述 类型 是否必须 Bucket 参数解释： Bucket的名称。 String 是 Key 参数解释： 对象名称。 String 是 versionId 参数解释： 对象的版本ID。 String 否 请求消息头 该请求使用公共的请求消息头，请参见如何调用API构造请求请求消息头。 请求消息元素 该请求消息中不带消息元素。 响应消息样式 plaintext HTTP/1.1 Status Code xamzrequestid: tx00000000000000000008100624e501c1217bdefault Date: Thu, 07 Apr 2022 02:44:44 GMT Connection: KeepAlive 响应消息头 该请求的响应消息使用公共的响应消息头，请参见如何调用API响应结果响应消息头。 响应消息参数 参数名称 参数描述 类型 Retention 参数解释： 对象保留期限配置。 Container 表Retention 参数名称 参数描述 类型 Mode 参数解释： 对象保留期限模式。 取值范围： GOVERNANCE：监管模式 COMPLIANCE：合规性模式 String RetainUntilDate 参数解释： 对象保留期限过期日期。 Date

功能说明 Get object legal hold请求获取指定对象的当前依法保留状态。 请求消息样式 plaintext GET /{Bucket}/{Key}?legalhold&versionIdVersionId HTTP/1.1 Host: xxx.zos.ctyun.cn AcceptEncoding: identity XAmzContentSHA256: ContentSHA256 XAmzDate: 20220412T100505Z Authorization: string 请求消息参数 参数名称 参数描述 类型 是否必须 Bucket 参数解释： Bucket的名称。 String 是 Key 参数解释： 对象名称。 String 是 versionId 参数解释： 对象的版本ID。 String 否 请求消息头 该请求使用公共的请求消息头，请参见如何调用API构造请求请求消息头。 请求消息元素 该请求消息中不带消息元素。 响应消息样式 plaintext HTTP/1.1 Status Code xamzrequestid: tx00000000000000000000d00624e4bc55e72default ContentType: application/xml ContentLength: 80 Date: Thu, 07 Apr 2022 02:26:29 GMT Connection: KeepAlive string 响应消息头 该请求的响应消息使用公共的响应消息头，请参见如何调用API响应结果响应消息头。 响应消息元素 参数名称 参数描述 类型 LegalHold 参数解释： 指定对象依法保留配置。 Container 表LegalHold 参数名称 参数描述 类型 Status 参数解释： 是否打开对象依法保留。 取值范围： ON：打开 OFF：关闭 String

本小节介绍微隔离防火墙升级与续订。 升级 升级操作是在Cosole页面产品实例列表进行的，点击【升级】会弹出升级配置页面，用户可以选择升级到的新规格。 升级的规格默认有效期与原实例保持一致。 续订 续订操作是在Cosole页面产品实例列表进行的，点击【续订】会弹出续订配置页面，续订是在原实例到期的基础上增加的有效时间。 到期效果 产品授权到期前7天会在登录页面给出到期提醒，产品到期后，配置的策略依然有效，但是无法登录平台进行调整。建议不计划继续使用本产品的用户，在产品到期前将所有策略关闭。

关键操作列表 操作事件 读写类型 重启实例节点 写事件 创建消息路由任务 写事件 删除消息路由任务 写事件 暂停消息路由任务 写事件 恢复消息路由任务 写事件 重发死信消息 写事件 更新Topic的读写模式 写事件 创建Acl用户 写事件 删除用户 写事件 更新用户 写事件 用户更新Topic权限 写事件 创建Connector任务 写事件 删除Connector任务 写事件 暂停Connector任务 写事件 恢复Connector任务 写事件 创建预付费实例 写事件 创建后付费实例 写事件 磁盘扩容 写事件 节点扩容 写事件 升规格 写事件 续订 写事件 退订 写事件

本节主要介绍分布式消息服务Kafka的订购流程。 背景信息 Kafka实例订购支持用户自定义规格和自定义特性，采用物理隔离的方式部署。租户独占Kafka实例，可根据业务需要可定制相应规格的Kafka实例。在新的资源池节点上，还支持选择主机类型和存储规格等丰富用户选项。 前提条件 具备已通过实名认证的天翼云账号 操作步骤 1. 登录管理控制台。 2. 进入Kafka管理控制台。 3. 在管理控制台右上角单击“地域名称”，选择区域。此处请选择与您的应用服务相同的区域。 4. 点击“购买实例”跳转到购买页面，根据页面订购说明进行产品开通。 5. 下载安装工具Eclipse3.6.0以上上版本 或者IntelliJ ，JDK 1.8.111以上版本。 说明 以下订购说明适用于华东1、华北2、西南1、华南2、上海36、青岛20、长沙42、南昌5、武汉41、杭州7、西南2贵州、太原4、郑州5、西安7、呼和浩特3资源池 计费模式：包周期和按需计费 引擎类型：云原生引擎和Kafka引擎。两者差别如下： 云原生引擎：大规模分区性能稳定性更高，扩容无需迁移数据。 Kafka引擎：完全兼容开源Kafka生态，占用更少IO带宽，可应对更高的性能峰值突刺。 部署方式：单可用区和多可用区部署。单可用区部署请选中任意一个AZ；多可用区部署请选中3个AZ，系统会自动将Broker节点平均分配至各可用区 自动续期：支持自动续期，支持做选择自动续期时长 节点数：3、5、7、9 主机类型：通用型和计算增强型，不同类型主机规格价格不一样，具体区别见文档弹性云主机实例规格 实例规格：主机节点规格，通用型和计算增强型规格不一致，具体以页面为准。 说明 以下订购说明适用于芜湖2、上海7、重庆2、乌鲁木齐27、石家庄20、内蒙6、北京5 资源池 计费模式：包周期和按需计费 区域：开通实例所在资源池 类型：选择产品规格，包括高级版8核32G与基础版4核16G 节点数：固定3个节点 主机类型：支持通用型主机s2、s3和s6，具体区别见文档弹性云主机实例规格通用型

迁移方案一：先迁生产，再迁消费 先将生产消息的业务迁移到新的Kafka，原Kafka不会有新的消息生产。待原有Kafka实例的消息全部消费完成后，再将消费消息业务迁移到新的Kafka，开始消费新Kafka实例的消息。 本方案为业界通用的迁移方案，操作步骤简单，迁移过程由业务侧自主控制，整个过程中消息不会存在乱序问题， 适用于对消息顺序有要求的场景 。但是该方案中需要等待消费者业务直至消费完毕，存在一个时间差的问题，部分数据可能存在较大的端到端时延。 1、将生产客户端的Kafka连接地址修改为新Kafka实例的连接地址。 2、重启生产业务，使得生产者将新的消息发送到新Kafka实例中。 3、观察各消费组在原Kafka的消费进度，直到原Kafka中数据都已经被消费完毕。 4、将消费客户端的Kafka连接地址修改为新Kafka实例的连接地址。 5、重启消费业务，使得消费者从新Kafka实例中消费消息。 6、观察消费者是否能正常从新Kafka实例中获取数据。 7、迁移结束。 结束 迁移方案二：同时消费，后迁生产 消费者业务启用多个消费客户端，分别向原Kafka和新Kafka实例消费消息，然后将生产业务切到新Kafka实例，这样能确保所有消息都被及时消费。 本方案中消费业务会在一段时间内同时消费原Kafka和新Kafka实例。由于在迁移生产业务之前，已经有消费业务运行在新Kafka实例上，因此不会存在端到端时延的问题。但在迁移生产的开始阶段，同时消费原Kafka与新Kafka实例，会导致部分消息之间的生产顺序无法保证，存在消息乱序的问题。此场景 适用于对端到端时延有要求，却对消息顺序不敏感的业务 。 1、启动新的消费客户端，配置Kafka连接地址为新Kafka实例的连接地址，消费新Kafka实例中的数据。 原有消费客户端需继续运行，消费业务同时消费原Kafka与新Kafka实例的消息。 2、修改生产客户端，Kafka连接地址改为新Kafka实例的连接地址。 3、重启生产客户端，将生产业务迁移到新Kafka实例中。 4、生产业务迁移后，观察连接新Kafka实例的消费业务是否正常。 5、等待原Kafka中数据消费完毕，关闭原有消费业务客户端。 6、迁移结束。 结束

介绍分布式消息服务Kafka监控安全风险 分布式消息服务Kafka提供资源和操作监控能力，可以对每个消息实例实时监控、告警和通知操作。用户可以实时掌握实例、主题、消费组的生产消费情况，包括流量、堆积量、重平衡次数等关键信息。 分布式消息服务Kafka支持的监控指标等内容，参考监控信息。

响应消息头 该请求的响应消息使用公共的响应消息头，请参见如何调用API响应结果响应消息头。 响应消息元素 该请求的响应中不带有响应元素。 错误码 请参见调用前必知错误码全局错误码。

响应消息头 该请求的响应消息使用公共的响应消息头，请参见如何调用API响应结果响应消息头。 响应消息元素 该请求的响应中不带有响应元素。 错误码 请参见调用前必知错误码全局错误码。

响应消息头 该请求的响应消息使用公共的响应消息头，请参见如何调用API响应结果响应消息头。 响应消息元素 该请求的响应中不带有响应元素。 错误码 请参见调用前必知错误码全局错误码。

响应消息头 该请求的响应消息使用公共的响应消息头，请参见如何调用API响应结果响应消息头。 响应消息元素 该请求的响应中不带有响应元素。 错误码 请参见调用前必知错误码全局错误码。

介绍分布式消息服务Kafka的新建消费组功能操作介绍。 场景描述 Kafka新建消费组的场景如下： 多个应用程序需要独立消费同一个主题：如果有多个应用程序需要从同一个Kafka主题中独立消费消息，并且每个应用程序需要管理自己的消费进度和分区分配，那么可以为每个应用程序创建一个独立的消费组。 消费者需要实现消息的负载均衡：当有多个消费者需要消费同一个主题的消息时，可以将它们加入同一个消费组，Kafka会自动将主题的分区均匀地分配给消费组中的消费者，实现消息的负载均衡。 消费者需要实现消息的并行处理：如果需要将一个主题的消息并行地处理，可以创建多个消费者实例，并将它们加入同一个消费组。Kafka会将主题的分区分配给消费组中的消费者，每个消费者只消费自己被分配的分区，从而实现消息的并行处理。 消费者需要实现高可用性：为了提高消费者的可用性，可以创建一个消费组，并将多个消费者实例加入该组。当一个消费者实例发生故障时，Kafka会将该消费者的分区重新分配给其他健康的消费者，从而保证消息的连续消费。 操作步骤 （1）登录管理控制台。 （2）进入Kafka管理控制台。 （3）在实例列表页在操作列，目标实例行点击“管理”。 （4）点击“消费组管理”后进入消费组管理页面。 （5）点击“创建消费组”后，输入消费组名称，点击创建。 说明 消费组业务应用接入使用时客户端也可自动创建。

本节主要介绍Kafka客户端使用规范。 consumer使用规范 1、consumer的owner线程需确保不会异常退出，避免客户端无法发起消费请求，阻塞消费。 2、确保处理完消息后再做消息commit，避免业务消息处理失败，无法重新拉取处理失败的消息。 3、consumer不能频繁加入和退出group，频繁加入和退出，会导致consumer频繁做rebalance，阻塞消费。 4、consumer数量不能超过topic分区数，否则会有consumer拉取不到消息。 5、consumer需周期poll，维持和server的心跳，避免心跳超时，导致consumer频繁加入和退出，阻塞消费。 6、consumer拉取的消息本地缓存应有大小限制，避免OOM（Out of Memory）。 7、consumer session设置为30秒，session.timeout.ms30000。 8、Kafka不能保证消费重复的消息，业务侧需保证消息处理的幂等性。 9、消费线程退出要调用consumer的close方法，避免同一个组的其他消费者阻塞sesstion.timeout.ms的时间。 producer使用规范 1、同步复制客户端需要配合使用：acksall 2、配置发送失败重试：retries3 3、发送优化：linger.ms0 4、生产端的JVM内存要足够，避免内存不足导致发送阻塞 topic使用规范 配置要求：推荐3副本，同步复制，最小同步副本数为2，且同步副本数不能等于topic副本数，否则宕机1个副本会导致无法生产消息。 创建方式：支持选择是否开启kafka自动创建Topic的开关。选择开启后，表示生产或消费一个未创建的Topic时，会自动创建一个包含3个分区和3个副本的Topic。 单topic最大分区数建议为100。 topic副本数为3（当前版本限制，不可调整）。

请求消息头 该请求使用公共的请求消息头，请参见如何调用API构造请求请求消息头。 请求消息元素 参数名称 参数描述 类型 是否必须 CompleteMultipartUpload 参数解释： 完成分段上传需要的分段数据信息。 Container 是 表CompleteMultipartUpload 参数名称 参数描述 类型 是否必须 Part 参数解释： 所有分段信息 Container 是 表Part 参数名称 参数描述 类型 是否必须 PartNumber 参数解释： 具体某个分段的分段号 Long 是 ETag 参数解释： 具体某个分段的Etag String 是 响应消息样式 plaintext HTTP/1.1 Status Code xamzrequestid: tx00000000000000000004200624d4b055403fdefault ContentType: application/xml ContentLength: 296 Date: Wed, 06 Apr 2022 08:10:45 GMT Connection: KeepAlive bucket3 key 38d95dc1f762ef78d9e73d1d6515abb42 响应消息头 该请求的响应消息使用公共的响应消息头，请参见如何调用API响应结果响应消息头。

响应消息样式 plaintext HTTP/1.1 Status Code xamzrequestid: tx00000000000000000001000624e4cea5e72default ContentType: application/xml ContentLength: 0 Date: Thu, 07 Apr 2022 02:31:22 GMT Connection: KeepAlive 响应消息头 该请求的响应消息使用公共的响应消息头，请参见如何调用API响应结果响应消息头。 响应消息元素 该请求的响应中不带有响应元素。 错误码 请参见调用前必知错误码全局错误码。

响应消息样式 plaintext HTTP/1.1 Status Code xamzrequestid: tx00000000000000000000200624f957a2a818nanjing3 ContentType: application/xml ContentLength: 0 Date: Fri, 08 Apr 2022 01:52:58 GMT Connection: KeepAlive 响应消息头 该请求的响应消息使用公共的响应消息头，请参见如何调用API响应结果响应消息头。 响应消息元素 该请求的响应中不带有响应元素。 错误码 请参见调用前必知错误码全局错误码。

响应消息样式 plaintext HTTP/1.1 Status Code xamzrequestid: tx00000000000000000001a0062555c7434455default ContentType: application/xml ContentLength: 0 Date: Tue, 12 Apr 2022 11:03:16 GMT Connection: KeepAlive 响应消息头 该请求的响应消息使用公共的响应消息头，请参见如何调用API响应结果响应消息头。 响应消息元素 该请求的响应中不带有响应元素。 错误码 请参见调用前必知错误码全局错误码。

响应消息样式 plaintext HTTP/1.1 Status Code xamzrequestid: tx00000000000000000001a0062555c7434455default ContentType: application/xml ContentLength: 0 Date: Tue, 12 Apr 2022 11:03:16 GMT Connection: KeepAlive 响应消息头 该请求的响应消息使用公共的响应消息头，请参见如何调用API响应结果响应消息头。 响应消息元素 该请求的响应中不带有响应元素。 错误码 请参见调用前必知错误码全局错误码。

响应消息样式 plaintext HTTP/1.1 Status Code xamzrequestid: tx00000000000000000002e00624e43581217bdefault ContentType: application/xml ContentLength: 0 Date: Thu, 07 Apr 2022 01:50:16 GMT Connection: KeepAlive 响应消息头 该请求的响应消息使用公共的响应消息头，请参见如何调用API响应结果响应消息头。 响应消息元素 该请求的响应中不带有响应元素。 错误码 请参见调用前必知错误码全局错误码。

响应消息样式 plaintext HTTP/1.1 Status Code xamzrequestid: tx00000000000000000001000624e4cea5e72default ContentType: application/xml ContentLength: 0 Date: Thu, 07 Apr 2022 02:31:22 GMT Connection: KeepAlive 响应消息头 该请求的响应消息使用公共的响应消息头，请参见如何调用API响应结果响应消息头。 响应消息元素 该请求的响应中不带有响应元素。 错误码 请参见调用前必知错误码全局错误码。

响应消息样式 plaintext HTTP/1.1 Status Code xamzrequestid: tx00000000000000000000200624fa3403b9d5default ContentType: application/xml ContentLength: 0 Date: Fri, 08 Apr 2022 02:51:44 GMT Connection: KeepAlive 响应消息头 该请求的响应消息使用公共的响应消息头，请参见如何调用API响应结果响应消息头。 响应消息元素 该请求的响应中不带有响应元素。 错误码 请参见调用前必知错误码全局错误码。