接口功能介绍 调用此接口可查询告警模板列表。 接口约束 无。 URI GET /v4/monitor/queryalarmtemplates 请求参数 Query参数 参数 参数类型 是否必填 示例 说明 下级对象 showMode String 否 ecs 本参数表示展示出来的服务。默认返回所有服务。取值范围：ecs：云主机。evs：云硬盘。pms：物理机。...详见“告警规则：获取告警服务列表”接口返回。 templateType String 否 all 本参数表示模板类型。默认all。取值范围：system：系统默认。custom：自定义。all：所有。根据以上范围取值。 pageNo Integer 否 1 页码，默认为1 page Integer 否 1 页码，默认为1，建议使用pageNo，该参数后续会下线 pageSize Integer 否 2 页大小，默认为20 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 返回状态码（800为成功，900为失败），默认值：800 800 errorCode String 失败时的错误代码，参见公共错误码说明 message String 失败时的错误描述，一般为英文描述 Success msgDesc String 失败时的错误描述，一般为中文描述 成功 returnObj Object 返回参数 returnObj 表returnObj 参数 参数类型 说明 示例 下级对象 templateList Array of Objects 告警模板列表 template totalCount Integer 总记录数 2 totalPage Integer 总页数 1 currentCount Integer 当前页记录数 14 page Integer 页码，建议参考请求参数pageNo，该参数后续会下线 1 pageSize Integer 页大小，建议参考请求参数pageSize，该参数后续会下线 10 表template 参数 参数类型 说明 示例 下级对象 templateID String 告警模板ID 315c7f8c3e4311ed8ef2005056898fe0 lastUpdate String 最近更新时间 20220927T09:03:03Z name String 告警模板名称 bzmcV service String 服务 ecs dimension String 维度 ecs desc String 告警模板描述 test rules Array of Objects 告警规则 rule 表rule 参数 参数类型 说明 示例 下级对象 for Integer 持续时间，当规则执行结果持续多久符合条件时报警（防抖） 120 metric String 监控指标 cpuutil fun String 算法 min operator String 比较符 le value String 告警阈值 80 period String 算法统计周期 5m level Integer 报警级别 1

告警联系人/组 告警联系人组：查询列表 接口功能介绍 调用此接口可查询告警联系人组的列表。 接口约束 无。 URI POST /v4.1/monitor/querycontactgroups 路径参数 无 Query参数 无 请求参数 请求头header参数 无 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 name 否 String 组名 testname search 否 String 模糊搜索，可搜索字段为联系人的：告警联系组组名（name）、告警联系人姓名（name）、告警联系人手机号（phone）、告警联系人邮箱（email） name123 pageNo 否 Integer 页码，默认为1 1 pageSize 否 Integer 每页大小 10 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 返回状态码（800为成功，900为失败），默认值：800 800 errorCode String 失败时的错误代码，参见公共错误码说明 message String 失败时的错误描述，一般为英文描述 Success msgDesc String 失败时的错误描述，一般为中文描述 成功 error String 错误码，请求成功时，不返回该字段 Openapi.Parameter.Error returnObj Object 返回参数 returnObj 表 returnObj 参数 参数类型 说明 示例 下级对象 contactGroupList Array of Objects 告警联系人组列表 contactGroup totalCount Integer 总记录数 20 currentCount Integer 当前页记录数 5 totalPage Integer 总页数 3 表 contactGroup 参数 参数类型 说明 示例 下级对象 contactGroupID String 告警联系人组ID cf21ea17e31d5f47bf106c489a86f67d name String 组名 group3 desc String 组备注 test contactList Array of Objects 告警联系人列表 contact updateTime Integer 最近更新时间, 时间戳，精确到毫秒 1667459789000 createTime Integer 创建时间，时间戳，精确到毫秒 1667459789000 表 contact 参数 参数类型 说明 示例 下级对象 contactID String 告警联系人ID a6fb570f22995bde989cdf0819c687d0 name String 用户名 gxlupdate phone String 手机号 18919128910 email String 邮箱 864307365@qq.com updateTime Integer 最近更新时间, 时间戳，精确到毫秒 1667459789000 createTime Integer 创建时间，时间戳，精确到毫秒 1667459789000 phoneActivation Integer 本参数表示手机号码是否激活。取值范围：1：已激活。0：未激活。根据以上范围取值。 0 emailActivation Integer 本参数表示邮箱是否激活。取值范围：1：已激活。0：未激活。根据以上范围取值。 0

如何选择磁盘空间？ Kafka支持多副本存储，副本数量为3。存储空间包含所有副本存储空间总和，因此，您在创建Kafka实例，选择初始存储空间时，建议根据业务消息体积预估以及副本数量选择合适的存储空间。 例如：业务消息体积预估100GB，则磁盘容量最少应为100GB3+ 预留磁盘大小100GB。 如何选择实例带宽？ Kafka实例的网络带宽指单向（读或写）最大带宽。一般建议选择带宽时建议预留30%，确保您的应用运行更稳定。 100MB/s，业务流量为70M以内时推荐选用。 300MB/s，业务流量为210M以内时推荐选用。 Kafka支持磁盘加密吗？ 分布式消息服务Kafka不支持磁盘加密。 Kafka扩容会影响业务吗？ Kafka的扩容过程可能会对业务产生一定的影响，具体取决于您的扩容策略和实施方式。以下是一些可能的影响： 重分区和重新分配：当您需要扩容Kafka集群时，可能需要进行重分区和重新分配。这涉及到数据的重新分布和重新平衡，可能会导致一段时间内的性能下降和延迟增加。在重分区和重新分配期间，Kafka会重新分配副本、重新分区数据，并且可能需要重新加载和重新平衡消费者群组。 网络和磁盘负载增加：扩容Kafka集群意味着增加了更多的节点和副本，这可能会增加网络和磁盘的负载。数据的复制和同步可能会导致网络带宽的消耗，而新增的节点和副本可能会增加磁盘的写入和读取负载。

通知模板 通知模板：查看详情 接口功能介绍 调用此接口可查看通知模板详情。 接口约束 通知模板存在。 URI GET /v4/monitor/describenoticetemplate 路径参数 无 Query参数 参数 是否必填 参数类型 说明 示例 下级对象 noticeTemplateID 是 String 通知模板ID 315c7f8c3e4311ed8ef2005056898fe0 请求参数 请求头header参数 无 请求体body参数 无 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 返回状态码（800为成功，900为失败），默认值：800 800 errorCode String 失败时的错误代码，参见公共错误码说明 message String 失败时的错误描述，一般为英文描述 Success msgDesc String 失败时的错误描述，适配中英文 成功 description String 失败时的错误描述，适配中英文 成功 error String 错误码，请求成功时，不返回该字段 Openapi.Parameter.Error returnObj Object 返回参数 returnObj 表 returnObj 参数 参数类型 说明 示例 下级对象 noticeTemplateID String 通知模板ID 315c7f8c3e4311ed8ef2005056898fe0 name String 通知模板名称 bzmcV service String 服务 ecs dimension String 维度 ecs contents Array of Objects 通知模板 content isDefault Boolean 是否为自定义默认通知模板 false createTime Integer 创建时间，时间戳，精确到秒 1667459789 updateTime Integer 最近更新时间，时间戳，精确到秒 1667459789 表 content 参数 参数类型 说明 示例 下级对象 content String 通知模板内容 this is content notifyType String 本参数表示通知方式。取值范围：sms：短信。email：邮件。 根据以上范围取值。 sms

本节介绍了本地盘的简介、创建本地盘、删除本地盘等。 简介 本地盘是虚拟机实例、容器实例或函数服务所在物理机上的本地硬盘设备。本地硬盘能够为实例提供本地存储访问能力，具有低时延、高随机IOPS、高吞吐量和高性价比的优势。 本地盘是将一个或多个硬盘的分区在逻辑上集合，相当于一个大硬盘来使用，当硬盘的空间不够使用的时候，可以继续将其它的硬盘的分区加入其中，这样可以实现磁盘空间的动态管理，相对于普通的磁盘分区有很大的灵活性。同样具备较高的IO性能，同时支持RAID方式提供更高系统可靠性。用户可以按需选择容量规格购买使用本地盘。本地盘目前提供SATA HDD、SATA SSD、NVMe SSD三种类型的介质。本地盘支持提供给虚拟机实例作为系统盘或数据盘，作为系统盘时，开放购买的规格支持为20GB～2048GB，作为数据盘时，开放购买的规格支持为10GB～6144GB。 注意 本地盘不支持快照，云硬盘支持快照，高可用方面也不如云盘。 由于本地盘是随着单台物理机，一旦物理机故障将有丢失数据风险，数据可靠性较低，因此，重要数据建议使用云硬盘。 创建本地硬盘 1. 登录ECX控制台。 2. 单击左侧导航栏【边缘存储>本地盘】进入本地盘列表，单击【购买本地盘】。 3. 【基础配置>计费模式】选择【包年包月】或者【按需计费】。 4. 选择【地域】跟【可用区】，本地盘需要与虚拟机在同一个可用区。 5. 点击【增加一块数据盘】，选择本地盘的类型、大小以及驱动，一次最多可以选择3块磁盘。 6. 本地盘只能选择立即挂载，点击下拉列表【请选择挂载虚机】，列表中显示当前集群运行中和已关机的虚机，点击【选择】需要挂载的虚机。 7. 单击【下单购买】完成支付，即创建成功。 注意 实际可购买的地域和可用区以库存展示为准

您可通过配置通知策略，自定义告警事件的匹配条件。当触发相应匹配条件时，系统将按照预设的通知方式向指定对象推送告警信息，提醒其及时开展问题排查与处理工作。 前提条件 已创建通知对象，具体操作，请参见【告警通知对象】。 新建通知策略 1. 登录【应用性能监控控制台】，在左侧导航栏选择告警管理 > 通知策略。 2. 在通知策略 页面左上角单击创建通知策略。 3. 点击“高级设置”（如只需要设置通知对象与通知时段，可无需点击高级设置）。 4. 在新建通知策略页面顶部设置通知策略名称。 5. 在匹配规则区域设置告警事件的匹配规则，点击添加规则，然后进行以下设置： 注意 静默策略优先于通知策略，即已被静默策略匹配到的告警事件将会被静默，无法再进行通知策略的事件匹配。创建静默策略的操作，请参见【静默策略】。 1. 选择数据来源。 指定来源：通知策略会针对指定来源（集成）的告警事件进行匹配规则过滤并发送通知。 无预设来源：通知策略会针对所有告警事件进行匹配规则过滤并发送通知。 2. 设置匹配规则表达式，您可以自定义标签或选择已有的标签。 已有的标签包括： 告警规则表达式指标中携带的标签。 系统自带的默认标签，默认标签说明如下。 分类 标签 说明 常用字段 alertname 告警规则名称 常用字段 carmsobjid 告警对象ID 常用字段 carmsobjtype 告警对象类型 常用字段 carmsobjname 告警对象名称 常用字段 alertGroup 告警规则的group属性 系统预置字段 ctyunarmsregioncode 资源池编码 系统预置字段 ctyunarmsregionname 资源池名称 系统预置字段 ctyunarmstenantcode 租户编码 系统预置字段 ctyunarmstenantname 租户名称 系统预置字段 ctyunarmsalertlevel 告警等级： 1一般 2次要 3重要 4紧急 系统预置字段 ctyunarmsalertruleid 告警规则ID，在告警规则页面选择通知策略后，在对应通知策略中会新增一条匹配规则ctyunarmsalertruleid告警规则ID 系统预置字段 ctyunarmsnotifystrategyid 告警通知策略ID 系统预置字段 ctyunarmsintegrationname 集成名称，ARMS默认上报的告警集成名称为ARMSDEFAULT。 系统预置字段 ctyunarmsalertrulefrequency 告警通知频率 说明 如果需同时满足多个匹配规则才告警，则单击添加条件 编辑第二条匹配规则条件。 如果需满足任意一个匹配告警事件规则就告警，则单击添加规则 编辑第二条匹配规则。 在配置通知策略并设置匹配规则时，需注意所有关联规则的描述内容总和不可超过 64KB，大约100条匹配规则（具体数量与实际规则的复杂度相关），如超过限制则会配置失败，此时为确保配置顺利完成，请重新创建一条通知策略关联更多的匹配规则。 若将通知策略中的匹配规则删除（ctyunarmsalertruleid告警规则ID），告警规则详情中关联的通知策略虽仍可看到，但无法发出通知。 3. 单击下一步。 6. 在事件分组 区域，设置告警事件是否需要分组，然后单击下一步。 不需要分组：所有告警事件会以一条告警信息发送给处理人。 设置分组字段：选择指定字段，该字段内容相同的告警事件会汇总到同一告警发送通知，减少联系人需要处理的告警。 7. 在通知对象区域，设置以下参数。 1. 单击+添加通知对象 选择通知对象。 通知对象类型如下： 联系人：选择具体联系人后还需选择使用电话、短信或邮件的通知方式。 联系人组：选择具体联系人组后还需选择使用电话、短信或邮件的通知方式。 排班：选择具体排班后还需选择使用电话、短信或邮件的通知方式。 钉钉/飞书/企微：通过钉钉、飞书或企业微信发送告警通知。 通用Webhook：通过Webhook发送告警通知。 2. 选择告警恢复后是否发送恢复通知。 发送恢复通知：当告警下面全部事件都恢复时，告警状态是否自动恢复为已解决。当告警恢复时，系统将会发送通知给告警处理人。 3. 如选择邮件或短信方式，可设置邮件与短信通知模板。 4. 设置通知时段，告警会在设置的通知时段内发送告警通知。 5. 单击下一步。 8. 在重复/升级/恢复策略 区域设置告警是否需要重复通知或使用升级策略，然后单击下一步。 告警是否需要重复通知：如果需要重复通知，设置重复频率。当告警未恢复或未认领时，告警会以设置的重复频率循环发送告警信息直至告警恢复。 告警是否配置升级策略： 不需要升级策略，告警未恢复状态下只发送一次。 选择升级策略后，告警未恢复状态下，告警通知将会根据升级策略发送通知给其他通知对象。 告警是否开启手动恢复：关闭手动恢复，则当告警事件在告警集成中设置的自动恢复时间内都没有再触发，告警将会自动恢复；开启手动恢复，当告警事件在告警集成中设置的自动恢复时间内都没有再触发，告警不会自动恢复，必须人工干预调整状态。 9. 在行动集成 区域可以设置告警触发或恢复后自动执行的行动。具体可参考【行动集成】。 10. 设置完成后，单击提交。

请求参数 请求头header参数 无 请求体body参数 无 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 返回状态码（800为成功，900为失败），默认值：800 800 errorCode String 失败时的错误代码，参见公共错误码说明 message String 失败时的错误描述，一般为英文描述 Success msgDesc String 失败时的错误描述，一般为中文描述 成功 description String 失败时的错误描述，适配中英文 成功 error String 错误码，请求成功时，不返回该字段 Openapi.Parameter.Error returnObj Object 返回对象 returnObj 表 returnObj 参数 参数类型 说明 示例 下级对象 alarmRules Array of Objects 告警规则 alarmRule totalCount Integer 总记录数 20 currentCount Integer 当前页记录数 10 totalPage Integer 总页数 2 表 alarmRule 参数 参数类型 说明 示例 下级对象 alarmRuleID String 告警规则ID 2c2472dff6335b4bbe459609fc9f8154 regionID String ctyun资源池ID 81f7728662dd11ec810800155d307d5b name String 规则名 ctyunrule desc String 描述 demo service String 本参数表示服务。取值范围： ecs：云主机。 evs：云硬盘。 pms：物理机。 ... 详见"云监控：查询服务维度及监控项"接口返回。 ecs dimension String 本参数表示告警维度。取值范围： ecs：云主机。 disk：磁盘。 pms：物理机。 ... 详见"云监控：查询服务维度及监控项"接口返回。 ecs repeatTimes Integer 重复告警通知次数 0 silenceTime Integer 告警接收策略静默时间，多久重复通知一次，单位为秒 300 recoverNotify Integer 本参数表示恢复是否通知。取值范围： 0：否。 1：是。 根据以上范围取值。 0 notifyType Array of Strings 本参数表示告警接收策略。取值范围： email：邮件告警。 sms：短信告警。 根据以上范围取值。 ['email','sms'] contactGroupList Array of Objects 告警联系人组 contactGroup notifyWeekdays Array of Integers 本参数表示通知周期。取值范围： 0：周日。 1：周一。 2：周二。 3：周三。 4：周四。 5：周五。 6：周六。 根据以上范围取值。 [0,1,2,3,4,5,6] notifyStart String 通知起始时段，默认为00:00:00 00:00:00 notifyEnd String 通知结束时段，默认为23:59:59 23:59:59 webhookUrl Array of Strings webhook消息推送url地址 [' status Integer 本参数表示告警规则启用状态。取值范围： 0：启用。 1：停用。 根据以上范围取值。 0 alarmStatus Integer 本参数表示告警规则告警状态。取值范围： 0：正常。 1：正在告警。 根据以上范围取值。 0 createTime Integer 创建时间，毫秒级时间戳。 1689580180000 updateTime Integer 更新时间，毫秒级时间戳。 1689580180000 projectID String 项目ID 0 conditions Array of Objects 具体匹配策略 condition resources Array of Objects 资源信息列表 resources resourceScope Integer 规则的资源范围，取值范围： 0：实例资源类型。 1：资源分组类型。 2：全部资源类型 。 根据以上范围取值。 0 defaultContact Integer 是否使用天翼云默认联系人接收通知，取值范围： 0：否。 1：是。 根据以上范围取值。 0 表 contactGroup 参数 参数类型 说明 示例 下级对象 contactGroupID String 告警联系人组ID 000f03221f4d8cc8bb2e1c30fb751ccc name String 告警联系人组名称 告警组aaa 表 condition 参数 参数类型 说明 示例 下级对象 eventName String 事件指标 migrationeventstart description String 事件中文描述 云主机迁移发生 value String 出现次数，告警阈值，整数格式字符串 1 period String 本参数表示算法统计周期。 5m level Integer 告警等级。取值范围： 1：紧急。 2：警示。 3：普通。 根据以上范围取值。 3 表 resources 参数 参数类型 说明 示例 下级对象 resource Array of Objects 资源信息 resourceObj 表 resourceObj 参数 参数类型 说明 示例 下级对象 name String 资源实例标签键 uuid value String 资源实例标签值 17d7e40a1f4ebca6fdb437dbb43237ee

任务中心 数据导出任务：查询 接口功能介绍 调用此接口可查询数据导出任务结果。 接口约束 资源池ID不能为空。 URI GET /v4/monitor/taskcenter/querytask 路径参数 无 Query参数 参数 是否必填 参数类型 说明 示例 下级对象 regionID 是 String 资源池ID 81f7728662dd11ec810800155d307d5b taskID 否 String 任务ID TASKtacd8b6b4610b97d202306301808 name 否 String 任务名称，支持模糊搜索 主机数据 pageNo 否 Integer 页码，不传默认为1 1 pageSize 否 Integer 每页大小，不传默认为20 2 请求参数 请求头header参数 无 请求体body参数 无 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 返回状态码（800为成功，900为失败），默认值：800 800 errorCode String 失败时的错误代码，参见公共错误码说明 message String 失败时的错误描述，一般为英文描述 Success msgDesc String 失败时的错误描述，一般为中文描述 成功 error String 错误码，请求成功时，不返回该字段 Openapi.Parameter.Error returnObj Object 返回参数，参考returnObj对象结构 returnObj 表 returnObj 参数 参数类型 说明 示例 下级对象 taskList Array of Objects 任务列表 taskObj totalCount Integer 总记录数 2 totalPage Integer 总页数 1 currentCount Integer 当前记录数 2 表 taskObj 参数 参数类型 说明 示例 下级对象 name String 任务名称 数据导出任务A description String 任务描述 用于导出云主机7月份历史数据 service String 云监控服务 ecs dimension String 云监控维度 ecs dimensions Array of Objects 查询设备标签列表，用于定位目标设备，多标签查询取交集 dimensionObj itemNameList Array of Strings 待查的监控项名称，具体设备对应监控项参见监控项列表：查询 ['cpuutil','memutil'] aggregateType Array of Strings 本参数表示数据聚合类型。取值范围：raw：原始值。avg：平均值。max：最大值。min：最小值。根据以上范围取值。 ['avg'] startTime Integer 数据起始时间 1692812541 endTime Integer 数据截止时间 1692842541 period Integer 数据点间隔 3600 createTime Integer 创建时间,精确至毫秒 1692842341000 updateTime Integer 更新时间,精确至毫秒 1692842441000 status Integer 本参数表示任务状态码。取值范围：0：待处理。1：处理中。2：已完成。3：失败。4：过期。根据以上范围取值。 1 process Integer 百分比进度，当status为1时有意义，范围 0100 66 msg String 任务详情，可用于展示报错信息 导出数据失败，请重试 表 dimensionObj 参数 参数类型 说明 示例 下级对象 name String 设备标签键 uuid value Array of Strings 设备标签键所对应的值 ['9dc489794e1945e2b5235d3c70d516b3']

响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 返回状态码（800为成功，900为失败），默认值：800 800 errorCode String 失败时的错误代码，参见公共错误码说明 message String 失败时的错误描述，一般为英文描述 Success msgDesc String 失败时的错误描述，适配中英文 成功 description String 失败时的错误描述，适配中英文 成功 error String 错误码，请求成功时，不返回该字段 Openapi.Parameter.Error returnObj Object 返回参数，参考returnObj对象结构 returnObj 表 returnObj 参数 参数类型 说明 示例 下级对象 noticeTemplateID String 通知模板ID 312b56b43e4311ed8ef2005056898fe0 枚举参数 无 请求示例 请求url /v4/monitor/createnoticetemplate 请求头header 无 请求体body { "name": "ctyunnoticetemplate", "service": "ecs", "dimension": "ecs", "contents": [ { "notifyType": "email", "content": "this is a demo" } ] } 响应示例 { "statusCode": 800, "returnObj": { "noticeTemplateID": "c76ee847fe895ab591bc0407f01a3e6f" }, "errorCode": "", "message": "Success", "msgDesc": "成功", "description": "成功" } 状态码 请参考 状态码

响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 返回状态码（800为成功，900为失败），默认值：800 800 errorCode String 失败时的错误代码，参见公共错误码说明 message String 失败时的错误描述，一般为英文描述 Success msgDesc String 失败时的错误描述，一般为中文描述 成功 description String 失败时的错误描述，适配中英文 成功 error String 错误码，请求成功时，不返回该字段 Openapi.Parameter.Error returnObj Object 返回对象 returnObj 表 returnObj 参数 参数类型 说明 示例 下级对象 success Boolean 是否成功 true 枚举参数 无 请求示例 请求url /v4/monitor/updatealarmblacklist 请求头header 无 请求体body { "blacklistID": "46d7bc837ac45238a9342076d0b9f9f0", "name": "ctyunalarmblacklist", "desc": "demo", "regionID": "81f7728662dd11ec810800155d307d5b", "service": "ecs", "dimension": "ecs", "resources": [ { "resource": [ { "name": "uuid", "value": "7dd744ea5a0261d3e62738f82f5fd3e1" }, { "name": "instancename", "value": "ecmaf97" } ] } ], "metrics": [ "cpuutil", "memutil" ], "startTime": 1687337384, "endTime": 1687338884, "contactGroupList": [ "234bee0616f65b0aadb8c0903d480a58" ] }

响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 返回状态码（800为成功，900为失败），默认值：800 800 errorCode String 失败时的错误代码，参见公共错误码说明 message String 失败时的错误描述，一般为英文描述 Success msgDesc String 失败时的错误描述，一般为中文描述 成功 description String 失败时的错误描述，适配中英文 成功 error String 错误码，请求成功时，不返回该字段 Openapi.Parameter.Error returnObj Object 返回对象 returnObj 表 returnObj 参数 参数类型 说明 示例 下级对象 success Boolean 是否成功 true 枚举参数 无 请求示例 请求url /v4/monitor/updatealarmblacklist 请求头header 无 请求体body { "blacklistID": "46d7bc837ac45238a9342076d0b9f9f0", "name": "ctyunalarmblacklist", "desc": "demo", "regionID": "81f7728662dd11ec810800155d307d5b", "service": "ecs", "dimension": "ecs", "resources": [ { "resource": [ { "name": "uuid", "value": "7dd744ea5a0261d3e62738f82f5fd3e1" }, { "name": "instancename", "value": "ecmaf97" } ] } ], "metrics": [ "cpuutil", "memutil" ], "startTime": 1687337384, "endTime": 1687338884, "contactGroupList": [ "234bee0616f65b0aadb8c0903d480a58" ] }

移出一台或多台云主机 接口功能介绍 将一台或多台云主机移出伸缩组 接口约束 无 URI POST /v4/scaling/group/instancemoveout 路径参数 无 Query参数 无 请求参数 请求头header参数 无 请求体body参数 参数 是否必选 参数类型 说明 示例 下级对象 regionID 是 String 资源池ID 81f7728662dd11ec810800155d307d5b groupID 是 Integer 伸缩组ID 443 instanceIDList 是 Array of Strings 实例ID列表 [adc614e0e838d73f0618a6d51d09070a] 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 返回码：800表示成功，900表示失败 800 errorCode String 业务细分码，为product.module.code三段式码 Scaling.Group.NotFound 错误码 message String 失败时的错误描述，一般为英文描述 scaling group info not found description String 失败时的错误描述，一般为中文描述 未找到弹性伸缩组信息 returnObj Object 成功时返回的数据，参见表returnObj returnObj 表 returnObj 参数 参数类型 说明 示例 下级对象 instanceIDList Array of Strings 实例ID列表 [adc614e0e838d73f0618a6d51d09070a]

删除一个告警策略 接口功能介绍 删除一个告警策略 接口约束 无 URI POST /v4/scaling/rule/deletealarm 路径参数 无 Query参数 无 请求参数 请求头header参数 无 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 regionID 是 String 资源池ID 81f7728662dd11ec810800155d307d5b groupID 是 Integer 伸缩组ID 511 ruleID 是 Integer 伸缩策略ID 72 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 返回码：800表示成功，900表示失败 800 errorCode String 业务细分码，为product.module.code三段式码 Scaling.Group.NotFound 错误码 message String 失败时的错误描述，一般为英文描述 scaling group info not found instance description String 失败时的错误描述，一般为中文描述 未找到弹性伸缩组信息 returnObj Object 成功时返回的数据，参见表returnObj returnObj 表 returnObj 参数 参数类型 说明 示例 下级对象 ruleID Integer 伸缩策略ID 72 请求示例 请求头header 无 请求体body json { "regionID": "81f7728662dd11ec810800155d307d5b", "ruleID": 72, "groupID": 499 }

删除一个周期策略 接口功能介绍 删除一个周期策略 接口约束 无 URI POST /v4/scaling/rule/deletecycle 路径参数 无 Query参数 无 请求参数 请求头header参数 无 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 regionID 是 String 资源池ID 81f7728662dd11ec810800155d307d5 groupID 是 Integer 伸缩组ID 471 ruleID 是 Integer 伸缩策略ID 149 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 返回码：800表示成功，900表示失败 800 errorCode String 业务细分码，为product.module.code三段式码 Scaling.Rule.NotFound 错误码 message String 失败时的错误描述，一般为英文描述 scaling rule info not found description String 失败时的错误描述，一般为中文描述 未找到弹性伸缩策略信息 returnObj Object 成功时返回的数据，参见表returnObj returnObj 表 returnObj 参数 参数类型 说明 示例 下级对象 ruleID Integer 伸缩策略ID 149 请求示例 请求头header 无 请求体body json { "regionID": "81f7728662dd11ec810800155d307d5b", "groupID": 471, "ruleID": 149 }

启用一个告警策略 接口功能介绍 启用一个告警策略 接口约束 无 URI POST /v4/scaling/rule/startalarm 路径参数 无 Query参数 无 请求参数 请求头header参数 无 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 regionID 是 String 资源池ID 81f7728662dd11ec810800155d307d5 groupID 是 Integer 伸缩组ID 471 ruleID 是 Integer 伸缩策略ID 149 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 返回码：800表示成功，900表示失败 800 errorCode String 业务细分码，为product.module.code三段式码 Scaling.Rule.NotFound 错误码 message String 失败时的错误描述，一般为英文描述 scaling rule info not found description String 失败时的错误描述，一般为中文描述 未找到弹性伸缩策略信息 returnObj Object 成功时返回的数据，参见表returnObj returnObj 表 returnObj 参数 参数类型 说明 示例 下级对象 ruleID Integer 伸缩策略ID 149 请求示例 请求头header 无 请求体body json { "regionID": "81f7728662dd11ec810800155d307d5b", "groupID": 471, "ruleID": 149 }

修改弹性伸缩组的健康检查方式 接口功能介绍 修改弹性伸缩组的健康检查方式 接口约束 无 URI POST /v4/scaling/group/updatehealthmode 路径参数 无 Query参数 无 请求参数 请求头header参数 无 请求体body参数 参数 是否必选 参数类型 说明 示例 下级对象 regionID 是 String 资源池ID 81f7728662dd11ec810800155d307d5b groupID 是 Integer 伸缩组ID 443 healthMode 是 Integer 健康检查方式。取值范围：1：云主机健康检查。2：弹性负载均衡健康检查。 1 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 返回码：800表示成功，900表示失败 800 errorCode String 业务细分码，为product.module.code三段式码 Scaling.Group.NotFound 错误码 message String 失败时的错误描述，一般为英文描述 scaling group info not found description String 失败时的错误描述，一般为中文描述 未找到弹性伸缩组信息 returnObj Object 成功时返回的数据，参见表returnObj returnObj 表 returnObj 参数 参数类型 说明 示例 下级对象 groupID Integer 伸缩组ID 443

启用伸缩组中的指定策略 接口功能介绍 启用伸缩组中的指定策略。 接口约束 无 URI POST /v4/scaling/rule/start 路径参数 无 Query参数 无 请求参数 请求头header参数 无 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 regionID 是 String 资源池ID 81f7728662dd11ec810800155d307d5 groupID 是 Integer 伸缩组ID 471 ruleID 是 Integer 伸缩策略ID 149 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 返回码：800表示成功，900表示失败 800 errorCode String 业务细分码，为product.module.code三段式码 Scaling.Rule.NotFound 错误码 message String 失败时的错误描述，一般为英文描述 scaling rule info not found description String 失败时的错误描述，一般为中文描述 未找到弹性伸缩策略信息 returnObj Object 成功时返回的数据，参见表returnObj returnObj 表 returnObj 参数 参数类型 说明 示例 下级对象 ruleID Integer 伸缩策略ID 149 请求示例 请求头header 无 请求体body json { "regionID": "81f7728662dd11ec810800155d307d5b", "groupID": 471, "ruleID": 149 }

修改弹性伸缩组的伸缩配置 接口功能介绍 修改弹性伸缩组的伸缩配置 接口约束 无 URI POST /v4/scaling/group/updateconfigid 路径参数 无 Query参数 无 请求参数 请求头header参数 无 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 regionID 是 String 资源池ID 88f8888888dd88ec888888888d888d8b groupID 是 Integer 伸缩组ID 489 configID 是 Integer 伸缩配置ID 375 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 返回码：800表示成功，900表示失败 800 errorCode String 业务细分码，为product.module.code三段式码 Scaling.Group.NotFound 错误码 message String 失败时的错误描述，一般为英文描述 scaling group info not found description String 失败时的错误描述，一般为中文描述 未找到弹性伸缩组信息 returnObj Object 成功时返回的数据 returnObj 表 returnObj 参数 参数类型 说明 示例 下级对象 groupID Integer 伸缩组ID 489 请求示例 请求头header 无 请求体body json { "regionID": "81f7728662dd11ec810800155d307d5b", "groupID": 509, "configID": 375 }

停用一个周期策略 接口功能介绍 停用一个周期策略 接口约束 无 URI POST /v4/scaling/rule/stopcycle 路径参数 无 Query参数 无 请求参数 请求头header参数 无 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 regionID 是 String 资源池ID 81f7728662dd11ec810800155d307d5 groupID 是 Integer 伸缩组ID 471 ruleID 是 Integer 伸缩策略ID 149 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 返回码：800表示成功，900表示失败 800 errorCode String 业务细分码，为product.module.code三段式码 Scaling.Rule.NotFound 错误码 message String 失败时的错误描述，一般为英文描述 scaling rule info not found description String 失败时的错误描述，一般为中文描述 未找到弹性伸缩策略信息 returnObj Object 成功时返回的数据，参见表returnObj returnObj 表 returnObj 参数 参数类型 说明 示例 下级对象 ruleID Integer 伸缩策略ID 149 请求示例 请求头header 无 请求体body json { "regionID": "81f7728662dd11ec810800155d307d5b", "groupID": 471, "ruleID": 149 }

查询伸缩活动ID 接口功能介绍 查询伸缩活动ID列表 接口约束 无 URI POST /v4/scaling/group/queryactivities 路径参数 无 Query参数 无 请求参数 请求头header参数 无 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 regionID 是 String 资源池ID 81f7728662dd11ec810800155d307d5b groupID 是 Integer 伸缩组ID 472 pageNo 否 Integer 页码 5 pageSize 否 Integer 分页查询时设置的每页行数，取值范围:[1~100]，默认值为10 10 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 返回码：800表示成功，900表示失败 800 errorCode String 业务细分码，为product.module.code三段式码 Scaling.Group.NotFound 错误码 message String 失败时的错误描述，一般为英文描述 scaling group info not found description String 失败时的错误描述，一般为中文描述 未找到弹性伸缩组信息 returnObj Object 成功时返回的数据，参见表returnObj returnObj 表 returnObj 参数 参数类型 说明 示例 下级对象 activeIDList Array of Integers 伸缩活动ID列表 [938]

删除一个弹性伸缩配置 接口功能介绍 删除一个弹性伸缩配置 接口约束 无 URI POST /v4/scaling/configdelete 路径参数 无 Query参数 无 请求参数 请求头header参数 无 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 regionID 是 String 资源池ID 81f7728662dd11ec810800155d307d5b configID 是 Integer 伸缩配置ID 410 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 返回码：800表示成功，900表示失败 800 errorCode String 业务细分码，为product.module.code三段式码 Scaling.Config.NotFound 错误码 message String 失败时的错误描述，一般为英文描述 scaling config info not found description String 失败时的错误描述，一般为中文描述 未找到弹性伸缩配置信息 returnObj Object 成功时返回的数据，参见表returnObj returnObj 表 returnObj 参数 参数类型 说明 示例 下级对象 configID Integer 伸缩配置ID 410 请求示例 请求头header 无 请求体body json { "regionID": "81f7728662dd11ec810800155d307d5b", "configID": 410 } 响应示例 json { "returnObj": { "configID": 410 }, "errorCode": "", "message": "SUCCESS", "description": "成功", "statusCode": 800 }

执行一条伸缩策略 接口功能介绍 执行一条伸缩策略 接口约束 无 URI POST /v4/scaling/rule/execute 路径参数 无 Query参数 无 请求参数 请求头header参数 无 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 regionID 是 String 资源池ID 81f7728662dd11ec810800155d307d5b ruleID 是 Integer 伸缩策略ID 78 groupID 是 Integer 伸缩组ID 483 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 返回码：800表示成功，900表示失败 800 errorCode String 业务细分码，为product.module.code三段式码 Scaling.Rule.NotFound 错误码 message String 失败时的错误描述，一般为英文描述 scaling rule info not found description String 失败时的错误描述，一般为中文描述 未找到弹性伸缩策略信息 returnObj Object 成功时返回的数据，参见表returnObj returnObj 表 returnObj 参数 参数类型 说明 示例 下级对象 ruleID Integer 伸缩策略ID 78 请求示例 请求头header 无 请求体body json { "ruleID": 78, "regionID": "81f7728662dd11ec810800155d307d5b", "groupID": 483 }

停用一个告警策略 接口功能介绍 停用一个告警策略 接口约束 无 URI POST /v4/scaling/rule/stopalarm 路径参数 无 Query参数 无 请求参数 请求头header参数 无 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 regionID 是 String 资源池ID 81f7728662dd11ec810800155d307d5 groupID 是 Integer 伸缩组ID 471 ruleID 是 Integer 伸缩策略ID 149 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 返回码：800表示成功，900表示失败 800 errorCode String 业务细分码，为product.module.code三段式码 Scaling.Rule.NotFound 错误码 message String 失败时的错误描述，一般为英文描述 scaling rule info not found description String 失败时的错误描述，一般为中文描述 未找到弹性伸缩策略信息 returnObj Object 成功时返回的数据，参见表returnObj returnObj 表 returnObj 参数 参数类型 说明 示例 下级对象 ruleID Integer 伸缩策略ID 149 请求示例 请求头header 无 请求体body json { "regionID": "81f7728662dd11ec810800155d307d5b", "groupID": 471, "ruleID": 149 }

启用一个周期策略 接口功能介绍 启用一个周期策略 接口约束 无 URI POST /v4/scaling/rule/startcycle 路径参数 无 Query参数 无 请求参数 请求头header参数 无 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 regionID 是 String 资源池ID 81f7728662dd11ec810800155d307d5 groupID 是 Integer 伸缩组ID 471 ruleID 是 Integer 伸缩策略ID 149 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 返回码：800表示成功，900表示失败 800 errorCode String 业务细分码，为product.module.code三段式码 Scaling.Rule.NotFound 错误码 message String 失败时的错误描述，一般为英文描述 scaling rule info not found description String 失败时的错误描述，一般为中文描述 未找到弹性伸缩策略信息 returnObj Object 成功时返回的数据，参见表returnObj returnObj 表 returnObj 参数 参数类型 说明 示例 下级对象 ruleID Integer 伸缩策略ID 149 请求示例 请求头header 无 请求体body json { "regionID": "81f7728662dd11ec810800155d307d5b", "groupID": 471, "ruleID": 149 }

查询用户弹性伸缩资源配额 接口功能介绍 查询用户的弹性伸缩组、伸缩配置、伸缩策略配额。 接口约束 无 URI POST /v4/scaling/quota 路径参数 无 Query参数 无 请求参数 请求头header参数 无 请求体body参数 参数 是否必选 参数类型 说明 示例 下级对象 regionID 是 String 资源池ID 81f7728662dd11ec810800155d307d5b 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 返回码：800表示成功，900表示失败 800 errorCode String 业务细分码，为product.module.code三段式码 错误码 message String 失败时的错误描述，一般为英文描述 description String 失败时的错误描述，一般为中文描述 returnObj Object 成功时返回的数据，参见表returnObj returnObj 表 returnObj 参数 参数类型 说明 示例 下级对象 scalingGroupLimit Integer 伸缩组配额 50 scalingRuleLimit Integer 伸缩策略配额 10 scalingConfigLimit Integer 伸缩配置配额 100 请求示例 请求头header 无 请求体body json { "regionID": "81f7728662dd11ec810800155d307d5b" } 响应示例 json { "returnObj": { "scalingGroupLimit": 50, "scalingRuleLimit": 10, "scalingConfigLimit": 100 }, "errorCode": "", "message": "SUCCESS", "description": "成功", "statusCode": 800 }

接口功能介绍 网关负载均衡开启删除保护 接口约束 无 URI POST /v4/gwlb/enabledeleteprotection 路径参数 无 Query参数 无 请求参数 请求头header参数 无 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 regionID 是 String 资源池 ID bb9fdb42056f11eda1610242ac110002 gwLbID 是 String 网关负载均衡ID gwlbxxx 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 返回状态码（800为成功，900为失败） 800 message String statusCode为900时的错误信息; statusCode为800时为success, 英文 success description String statusCode为900时的错误信息; statusCode为800时为成功, 中文 成功 errorCode String statusCode为900时为业务细分错误码，三段式：product.module.code; statusCode为800时为SUCCESS SUCCESS returnObj Object 接口业务数据 returnObj 表 returnObj 参数 参数类型 说明 示例 下级对象 gwElbID String 网关负载均衡 ID gwlbxxx 枚举参数 无 请求示例 请求url POST /openapi/v4/gwlb/enabledeleteprotection 请求头header 无 请求体body { "regionID": "xxxx", "gwLbID": "xxxx" }

接口功能介绍 更新多证书 接口约束 无 URI POST /v4/elb/updatedomaincertlinks 路径参数 无 Query参数 无 请求参数 请求头header参数 无 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 regionID 是 String 资源池ID 81f7728662dd11ec810800155d307d5b domainCertID 是 String 多证书 ID dclxxxx description 否 String 支持拉丁字母、中文、数字, 特殊字符：~!@ $%^&()+ <>?:{},./;'[]·！@ ￥%……&（） —— +{} 《》？：“”【】、；‘'，。、，不能以 http: / https: 开头，长度 0 128 decs certificateID 否 String 证书 ID certxxxxx 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 返回状态码（800为成功，900为失败） 800 message String statusCode为900时的错误信息; statusCode为800时为success, 英文 success description String statusCode为900时的错误信息; statusCode为800时为成功, 中文 成功 errorCode String statusCode为900时为业务细分错误码，三段式：product.module.code; statusCode为800时为SUCCESS SUCCESS returnObj Object 检查结果 见下表 表 returnObj 参数 参数类型 说明 示例 下级对象 domainCertID String 多证书 id dclxxxx

接口功能介绍 重置密码 接口约束 无 URI POST /v1/resetPassword 路径参数 无 Query参数 无 请求参数 请求头header参数 参数 是否必填 参数类型 说明 示例 下级对象 ContentType 是 String 类型 application/json regionId 是 String 资源池编码 bb9fdb42056f11eda1610242ac110002 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 instanceId 是 Long 实例ID 166902317915212318 password 是 String 密码。长度在850个字符，且需包含至少一个大写字母、一个小写字母、一个数字和一个特殊字符。 Aa1!1234 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 响应码 0 message String 返回信息 returnObj Boolean 重置是否成功 true error String 错误信息 枚举参数 无 请求示例 请求url POST 请求头header json { "ContentType":"application/json" } 请求体body json { "instanceId":166902317915212320, "password":"Aa1!1234" } 响应示例 json { "statusCode":0, "message":"", "returnObj":true } 状态码 请参考 状态码

接口功能介绍 本接口用于删除GB28181凭证。 接口约束 删除凭证前请确保存在该凭证。 请求参数说明： String类型的参数，传""等同于不传。 Integer类型的参数，传0等同于不传。 Boolean类型的参数，传false等同于不传。 URI DELETE /v2/gb28181Certs/ 路径参数 参数 是否必填 参数类型 说明 示例 下级对象 UserName 是 String 凭证用户名。 cert Query参数 无 请求参数 请求头header参数 无 请求体body参数 无 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 响应状态码。 200 error String 错误码，执行成功时，不返回该字段。 VSS0001 message String 响应信息。 请求成功 requestId String 请求ID。 362d4e78556b47129182d0881fade86b returnObj Object 响应数据，执行失败时，不返回该字段。 returnObj 表 returnObj 参数 参数类型 说明 示例 下级对象 RequestId String 请求ID。 1942b6dc15704a93950d90d3101d3ebb 枚举参数 无 请求示例 请求url DELETE '/v2/gb28181Certs/openapi01' 请求头header 无 请求体body 无 响应示例 {"statusCode": 200,"message": "请求成功","requestId": "1942b6dc15704a93950d90d3101d3ebb","returnObj": {"RequestId": "1942b6dc15704a93950d90d3101d3ebb"}}

接口功能介绍 本接口用于修改设备的目录。 接口约束 修改设备目录前确保存在该目录以及设备。 请求参数说明： String类型的参数，传""等同于不传。 Integer类型的参数，传0等同于不传。 Boolean类型的参数，传false等同于不传。 URI PUT /v2/dirs//devices/ 路径参数 参数 是否必填 参数类型 说明 示例 下级对象 DirId 是 String 目录ID。 1548576244711424 DeviceId 是 String 设备ID。 29942028422873997 Query参数 无 请求参数 请求头header参数 无 请求体body参数 无 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 响应状态码。 200 error String 错误码，执行成功时，不返回该字段。 VSS0001 message String 响应信息。 请求成功 requestId String 请求ID。 362d4e78556b47129182d0881fade86b returnObj Object 响应数据，执行失败时，不返回该字段。 returnObj 表 returnObj 参数 参数类型 说明 示例 下级对象 RequestId String 请求ID。 68561b784a2944a7a713186f5cb20d34 枚举参数 无 请求示例 请求url PUT '/v2/dirs/1548576244711424/devices/29942028422873997' 请求头header 无 请求体body {"InProtocol":"gb28181"}

接口功能介绍 虚机删除 接口约束 注意边缘池id与虚机id需正确。 URI POST /v3/evm/deleteInstance 路径参数 无 Query参数 无 请求参数 请求头header参数 无 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 nodeCode 是 String 边缘池id，可通过查看区域集群编码列表接口获取。 ynlincang1 id 是 String 虚拟机id。 evmxxxxxx refundOrderType 否 Integer 选择退订方式，0退订正常状态资源，退订后冻结；1强制删除冻结状态资源；2退订并销毁正常状态资源，默认值是0。 0 reservedIP 否 Boolean 退订后是否保留IP，false不保留，true暂时保留，过期后仍会释放，默认false。 false 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 状态码 200 message String 状态描述 Success returnObj Object 返回数据 returnObj error String 错误码，执行成功时，不返回该字段 ECX0001 表 returnObj 参数 参数类型 说明 示例 下级对象 id String 虚拟机id evmxxxxx 枚举参数 无

接口功能介绍 调用此接口可设置指定告警规则的告警联系人及通知方式。 接口约束 告警规则存在。 URI POST /v4/monitor/setalarmrulecontact 请求参数 请求体body参数 参数 参数类型 是否必填 示例 说明 下级对象 regionID String 是 81f7728662dd11ec810800155d307d5b 资源池ID alarmRuleID String 是 2c2472dff6335b4bbe459609fc9f8154 告警规则ID contactGroupList Array of String 是 ["7e6b4ac7cf07561db381fea74c401f50"] 告警接收策略通知人ID列表 notifyType Array of String 是 ["sms"] 告警接受策略通知方式。取值范围：sms：短信通知。email：邮件通知。根据以上范围取值。 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 返回状态码（800为成功，900为失败），默认值：800 800 errorCode String 失败时的错误代码，参见公共错误码说明 message String 失败时的错误描述，一般为英文描述 Success msgDesc String 失败时的错误描述，一般为中文描述 成功 returnObj Object 返回参数 returnObj 表returnObj 参数 参数类型 说明 示例 下级对象 success Boolean 是否成功 true