接口功能介绍 向指定的消费者推送消息 接口约束 无 URI POST /v3/message/push 路径参数 无 Query参数 无 请求参数 请求头header参数 参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池编码 100054c0416811e9a6690242ac110002 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 prodInstId 是 String 实例ID msgId 是 String 消息的offsetMsgId groupName 是 String 订阅组名字 clientId 是 String 客户端ID 响应参数 参数 参数类型 说明 示例 下级对象 statusCode String 接口系统层面状态码。成功：800，失败：900 800 message String 描述状态 returnObj Object 返回对象。此参数所包含的参数请见“响应示例'里面的注释 error String 错误码，只有非成功才有这个字段，方便快速定位问题 201 枚举参数 无 请求示例 请求url 无 请求头header 无 请求体body { "prodInstId":"mqtest", "msgId":"C0A847BC000020E60000000000003FEE", "groupName":"group", "clientId":"5.5.148.141@testinstance" }

接口功能介绍 更新实例名称 接口约束 无 URI POST /v3/instance/updateName 路径参数 无 Query参数 无 请求参数 请求头header参数 参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池编码 100054c0416811e9a6690242ac110002 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 prodInstId 是 String 实例ID instanceName 是 String 新的实例名称 响应参数 参数 参数类型 说明 示例 下级对象 statusCode String 接口系统层面状态码。成功：800，失败：900 message String 描述状态 returnObj Object 返回对象。此参数所包含的参数请见“响应示例'里面的注释 error String 错误码，只有非成功才有这个字段，方便快速定位问题 201 枚举参数 无 请求示例 请求url 请求头header 无 请求体body { "prodInstId":"mqtest", "instanceName":"70687660456281088" } 响应示例 响应成功示例 { "returnObj":{ }, "message":"success", "statusCode":800 } 响应失败示例 { "returnObj": {}, "message": "...", "error":"201", "statusCode": "900" }

请求参数 请求头header参数 无 请求体body参数 无 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 状态码。可能值： 800：请求成功。 900：请求失败。 800 error String 错误码。 ECPC1000 message String 提示信息。 OK. returnObj Object 返回数据对象 returnObj 表 returnObj 参数 参数类型 说明 示例 下级对象 total Long 总记录数 list Array of Objects 数据列表 list 表 list 参数 参数类型 说明 示例 下级对象 diskType String 磁盘类型。枚举值范围：hio高IO;uhio超高IO。 description String 磁盘类型描述。 枚举参数 无 请求示例 请求url 无 请求头header 无 请求体body 无 响应示例 { "statusCode":800, "message":"OK.", "returnObj":{ "total":2, "list":[{ "diskType":"hio", "description":"高IO" },{ "diskType":"uhio", "description":"超高IO" }] } } 状态码 请参考 状态码 错误码 请参考 错误码

项目 描述 策略名称 QoS策略名称。 回收策略 QoS策略的回收策略： 删除：解除QoS策略关联的所有对象或者删除QoS策略关联的所有对象，系统会触发删除QoS策略。 保留：解除QoS策略关联的所有对象或者删除QoS策略关联的所有对象，QoS策略仍保留。 IOPS（总/读/写） 每秒能够进行读写操作/读操作/写操作次数的最大值。 带宽（总/读/写） 总带宽/读带宽/写带宽上限。 突发IOPS（总/读/写） 使用Burst功能时，每秒能够进行读写操作/读操作/写操作次数的最大值。 突发带宽（总/读/写） 使用Burst功能时，总带宽/读带宽/写带宽上限。 突发时长 使用Burst功能时，按照Burst上限的能力进行操作所能持续的时间，单位是秒。上限项目依次为：读写操作次数、读操作次数、写操作次数、总带宽、读带宽、写带宽。 创建时间 QoS策略创建的时间。

接口功能介绍 删除给定的监控视图。 监控视图属于一个监控面板，一个监控面板可以包含多个监控视图。 接口约束 regionID（资源池）、templateID（监控面板）、viewID（监控视图）存在。 URI POST /v4/monitor/deletemonitorview 请求参数 请求体body参数 参数 参数类型 是否必填 示例 说明 下级对象 regionID String 是 81f7728662dd11ec810800155d307d5b 资源池ID templateID String 是 466d5eb4484311eda9b7005056897257 监控面板ID viewID String 是 9a8892ba486c11eda9b7005056897257 监控视图ID 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 返回状态码（800为成功，900为失败），默认值：800 800 errorCode String 失败时的错误代码，参见公共错误码说明 message String 失败时的错误描述，一般为英文描述 Success msgDesc String 失败时的错误描述，一般为中文描述 成功 returnObj Object 返回对象 returnObj 表returnObj 参数 参数类型 说明 示例 下级对象 success Boolean 是否删除成功 true

接口功能介绍 绑定了企业版配额的自选服务器列表 接口约束 此功能为收费功能。确认已经购买系统配额，并且开启服务器防护。如果没有购买配额，可按照页面提示进行购买。如果没有开启防护，请在服务器列表页开启机器防护。 URI POST /v1/quota/quotaHosts 路径参数 无 Query参数 无 请求参数 请求头header参数 参数 是否必填 参数类型 说明 示例 下级对象 ContentType 是 String ContentType application/json 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 quotaVersion 否 Integer 配额版本 1基础版 2企业版 3旗舰版 1 currentPage 是 Integer 分页当前页码 1 pageSize 是 Integer 每页大小 10 osType 否 Integer 操作系统类型 1Linux 2Windows 3全部 1 param 否 String 查询参数 testservername 响应参数 参数 参数类型 说明 示例 下级对象 error String 返回码 CTCSSCN000000：成功 CTCSSCN000001：失败 CTCSSCN000003：用户未签署协议，安全卫士系统无法正常使用 CTCSSCN000004：鉴权错误 CTCSSCN000005：用户没有付费版配额，功能不可用 CTCSSCN000000 message String 返回信息 success returnObj Object 返回对象 returnObj traceId String traceId 211111111111111111111 statusCode String 状态码 200成功 200 表 returnObj 参数 参数类型 说明 示例 下级对象 total Integer 总数 100 list Array of Objects 结果集 list pageNum Integer 当前页 1 pageSize Integer 每页的数量 10 表 list 参数 参数类型 说明 示例 下级对象 agentGuid String agentGuid testagentGuid custName String 主机名称 testcustName publicIp String 公网ip 192.168.1.1 displayName String 实例名称 testdisplayName agentIp String 私有ip 192.168.1.1 status String 状态 已关机 运行中 其他 osType String 操作系统类型 Windows Linux Windows statusCode Integer 服务器状态 4已关机 5运行中 40其他 5

接口功能介绍 统计最近一次弱口令检测扫描出的信息。 接口约束 此功能为收费功能。确认已经购买系统配额，并且开启服务器防护。如果没有购买配额，可按照页面提示进行购买。如果没有开启防护，请在服务器列表页开启机器防护。 URI POST /v1/weakpw/group 路径参数 无 Query参数 无 请求参数 请求头header参数 参数 是否必填 参数类型 说明 示例 下级对象 ContentType 是 String ContentType application/json 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 currentPage 是 Integer 分页当前页码 1 pageSize 是 Integer 页大小 10 checkType 是 String 检测弱口令类型 1：系统弱口令:2：应用弱口令，多个用英文逗号隔开 1 param 否 String 查询参数 12a agentGuid 是 String agentGuid testagentguid 响应参数 参数 参数类型 说明 示例 下级对象 error String 返回码 CTCSSCN000000：成功 CTCSSCN000001：失败 CTCSSCN000003：用户未签署协议，安全卫士系统无法正常使用 CTCSSCN000004：鉴权错误 CTCSSCN000005：用户没有付费版配额，功能不可用 CTCSSCN000000 message String 返回信息 success returnObj Object 返回对象 returnObj traceId String traceId 211111111111111111111 statusCode String 状态码 200成功 200 表 returnObj 参数 参数类型 说明 示例 下级对象 total Integer 总数 100 list Array of Objects 结果集 list pageNum Integer 当前页 1 pageSize Integer 每页的数量 10 表 list 参数 参数类型 说明 示例 下级对象 userName String 用户名 test weakType String 弱口令类型 空口令/系统默认弱口令/密码包含用户名/常见弱密码 空口令 passwd String 密码脱敏，如t t findTime String 首次发现时间 20220406 10:10:10 timestamp String 最后发现时间 20220406 10:10:10 app String 应用名称 app version String 应用版本 1.0.0

天翼云企业路由器服务协议详情请参见这里。

本节主要介绍资源冻结/释放/删除/退订类问题 GeminiDB Redis资源为什么被释放了？ 客户在购买产品后，如果没有及时的进行续费或充值，将进入宽限期。如宽限期满仍未续费或充值，将进入保留期。在保留期内资源将停止服务。保留期满仍未续费或充值，存储在云服务中的数据将被删除、云服务资源将被释放。 GeminiDB Redis资源为什么被冻结了？ 资源冻结的类型有多种，最常见类型为欠费冻结。 实例被冻结了，还可以备份数据吗？ 不支持，如果是欠费冻结，需要您先续费解冻GeminiDB Redis实例后才能备份数据。 怎样将资源解冻？ 欠费冻结：用户可通过续费或充值来解冻资源，恢复GeminiDB Redis正常使用。欠费冻结的GeminiDB Redis允许续费、释放或删除；已经到期的包周期GeminiDB Redis不能发起退订，未到期的包周期GeminiDB Redis可以退订。 冻结、解冻、释放资源时对业务的影响 资源冻结时： 资源将被限制访问和使用，会导致您的业务中断。例如GeminiDB Redis被冻结时，会使得用户无法再连接至数据库。 包周期资源被冻结后，将被限制进行变更操作。 资源被冻结后，可以手动进行退订/删除。 资源解冻时：资源将被解除限制，用户可以连接至数据库。 资源释放时：资源将被释放，实例将被删除，删除前将依据用户策略决定是否执行实例回收站。

参数 参数类型 说明 示例 下级对象 statusCode String 接口系统层面状态码。成功："800"，失败："900"。 800 message String 描述状态。 returnObj Object 返回对象。 error String 错误码，描述错误信息。

本章节针对不同规模团队给到用户权限管理的最佳实践 概述 微服务云应用平台权限管理是由统一身份认证（IAM）纳管。子账号登陆并访问微服务云应用平台前需要被管理员授权对应的微服务云应用平台系统权限后才可以正常使用。 小团队使用微服务云应用平台 建议小团队用户使用IAM权限鉴权，简单易上手。 1. 登陆天翼云官网并访问IAM控制台，选择需要授权的子账号。 2. 查看用户，选择所属用户组，添加用户组。如未创建所需用户组，请参考系统管理主子账号创建用户组并给用户组授权微服务云应用平台权限策略。 3. 选择目标用户组，点击确定即可。 IAM场景1 租户是小团队，只区分功能权限（常用场景） 1. 进入IAM控制台 2. 创建自定义策略 选择策略管理，创建自定义策略。 测试策略内容，仅供参考，MSAP1.6后支持通配符策略。 { "Version": "1.1", "Statement": [ { "Action": [ "msap:inst:" ], "Resource": [ "" ], "Effect": "Allow" } ] } 3. 选择用户组，创建用户组。 4. 选择用户，查看需要授权子账号，在所属用户组TAB栏，添加目标用户组。 完成以上配置后，即完成了IAM策略授权操作了！

本节介绍智算安全专区服务等级协议，请点击查看。 天翼云智算安全专区服务等级协议

本文介绍索引切割所用到的参数及示例。 功能说明 通过索引切割参数，可以将存储在媒体存储的原图按指定大小分割，并截取需要的图片。 参数说明 操作名称：indexcrop 参数说明如下： 参数 描述 取值范围 x 指定在x轴切割出的每块区域的长度。x参数与y参数只能任选其一。 [1,图片宽度] y 指定在y轴切割出的每块区域的长度。x参数与y参数只能任选其一。 [1,图片高度] i 选择切割后返回的图片区域。 [0,区域数) 默认为0，表示第一块。 注意事项 在使用自定义裁剪功能时，请注意以下事项： 如果指定的索引值大于切割后形成的区域数量，将返回原图。 当x和y同时指定且值合法时，以y参数的值为准。 示例 按x轴切割图片，将图片在x轴按100 px为单位切割：indexcrop,x100，选取切割后的第1块区域：i0，具体图片处理参数为： ?xamzprocessimage/indexcrop,x100,i0 按y轴切割图片，将图片在y轴按100 px为单位切割：indexcrop,y100，选取切割后的第1块区域：i0，具体图片处理参数为： ?xamzprocessimage/indexcrop,y100,i0

接口功能介绍 分类统计漏洞数量，没有时间等条件限制。 接口约束 此功能为免费功能。 URI GET /v1/announcement/vulTypeCount 路径参数 无 Query参数 无 请求参数 请求头header参数 参数 是否必填 参数类型 说明 示例 下级对象 ContentType 是 String ContentType application/json 请求体body参数 无 响应参数 参数 参数类型 说明 示例 下级对象 error String 返回码 CTCSSCN000000：成功 CTCSSCN000001：失败 CTCSSCN000003：用户未签署协议，安全卫士系统无法正常使用 CTCSSCN000004：鉴权错误 CTCSSCN000005：用户没有付费版配额，功能不可用 CTCSSCN000000 message String 返回信息 success returnObj Object 返回对象 returnObj traceId String traceId asaadasd11111 statusCode String 状态码 200成功 200 表 returnObj 参数 参数类型 说明 示例 下级对象 linux Integer linux漏洞 未处理漏洞数量 0 windows Integer windows漏洞 未处理漏洞数量 0 webCms Integer webCms漏洞 未处理漏洞数量 0 application Integer 应用漏洞 未处理漏洞数量 0 emergency Integer 应急漏洞 未处理漏洞数量 0

接口功能介绍 防护配置配额解绑 接口约束 此功能为收费功能。确认已经购买网页防篡改配额，并且开启防篡改扫描配置。如果没有购买配额，可按照页面提示进行购买。如果没有开启防护，请在服务器列表页开启机器防护 URI POST /v1/tamperProof/config/unbind 路径参数 无 Query参数 无 请求参数 请求头header参数 参数 是否必填 参数类型 说明 示例 下级对象 ContentType 是 String ContentType application/json 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 agentGuid 是 String agentGuid 111111111111 响应参数 参数 参数类型 说明 示例 下级对象 error String 返回码 CTCSSCN000000：成功 CTCSSCN000001：失败 CTCSSCN000003：用户未签署协议，安全卫士系统无法正常使用 CTCSSCN000004：鉴权错误 CTCSSCN000005：用户没有付费版配额，功能不可用 CTCSSCN000000 message String 返回信息 success returnObj Object 返回对象 traceId String traceId asaadasd11111 statusCode String 状态码 200成功 200

接口功能介绍 防护配置备份目录查询 接口约束 此功能为收费功能。确认已经购买网页防篡改配额，并且开启防篡改扫描配置。如果没有购买配额，可按照页面提示进行购买。如果没有开启防护，请在服务器列表页开启机器防护 URI POST /v1/tamperProof/config/queryBackup 路径参数 无 Query参数 无 请求参数 请求头header参数 参数 是否必填 参数类型 说明 示例 下级对象 ContentType 是 String ContentType application/json 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 serverIp 是 String 防护服务器IP 192.168.1.1 响应参数 参数 参数类型 说明 示例 下级对象 error String 返回码 CTCSSCN000000：成功 CTCSSCN000001：失败 CTCSSCN000003：用户未签署协议，安全卫士系统无法正常使用 CTCSSCN000004：鉴权错误 CTCSSCN000005：用户没有付费版配额，功能不可用 CTCSSCN000000 message String 返回信息 success returnObj String 返回对象 traceId String traceId asaadasd11111 statusCode String 状态码 200成功 200

接口功能介绍 导入pkcs12格式证书 接口约束 无 URI POST /v1/manageCertificate/importCertificateByPKCS12 路径参数 无 Query参数 无 请求参数 请求头header参数 参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池id fecnjniakfkn2314ndekqldedcsadfg 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 passPhrase 是 String 导入证书密码 12345 pkcs12Blob 是 String pkcs12格式证书 MIIKCQIBAzCCCc8GCSqGSIb3DQEHAaCCCcAEggm8MIIJuDCCBG8GCSqGSIb3DQEHBqCCBGAwggRcAgEAMIIEVQYJKoZIhvcNAQcBMBwGCiqGSIb3DQEMAQYwDgQIA5ZZNcJVpBYCAggAgIIEKMpBWtpSNLTskOL8WTgv8Cs2DV7vDKD1 protectionLevel 是 String 密钥保护级别 保护等级，0为硬件，1为软件 epId 否 String 企业项目id default instanceId 否 String 实例id，非必传，当为空时证书创建在最早开通且启用中的实例中 insX63C8r 响应参数 参数 参数类型 说明 示例 下级对象 statusCode String 返回码 取值范围：200 成功 200 error String 错误码 KMS0514 message String 调用结果信息 导入证书成功 returnObj Object 接口返回结果 null returnObj 表 returnObj 参数 参数类型 说明 示例 下级对象 requestId String 请求id 7a41626f0e604cef9776eb19fc8ec7f5 certificateId String 证书id f2ffbff9940a41a4ba9afe1fd8f22792

接口功能介绍 证书私钥解密 接口约束 用户已开通 URI POST /v1/certificateCompute/certificatePrivateKeyDecrypt 路径参数 无 Query参数 无 请求参数 请求头header参数 参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池id fecnjniakfkn2314ndekqldedcsadfg 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 certificateId 是 String 证书id 474e569e8814474a948bdbcf6d853eff algorithm 是 String 解密算法，取值范围为RSAESOAEPSHA256、RSAESOAEPSHA1、RSAESPKCS1V15、SM2 RSAESOAEPSHA1 ciphertextBlob 是 String ODZhOWVmZDktM2QxNi00ODk0LWJkNGYtMWZjNDNmM2YyYWJmS7FmDBBQ0BkKsQrtRnidtPwi 解密密文 响应参数 参数 参数类型 说明 示例 下级对象 statusCode String 返回码 取值范围：200 成功 200 error String 错误码 KMS0514 message String 调用结果信息 解密成功 returnObj String 接口返回结果 returnObj 表 returnObj 参数 参数类型 说明 示例 下级对象 requestId String 请求id 2a56124813ed4ef7a359e818dce118d8 certificateId String 证书id 474e569e8814474a948bdbcf6d853eff plaintext String 解密后明文 csedLEchgF5ijFx9nEc5Y0DpzWb

接口功能介绍 证书私钥解密 接口约束 用户已开通 URI POST /v1/certificateCompute/certificatePrivateKeyDecrypt 路径参数 无 Query参数 无 请求参数 请求头header参数 参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池id fecnjniakfkn2314ndekqldedcsadfg 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 certificateId 是 String 证书id 474e569e8814474a948bdbcf6d853eff algorithm 是 String 解密算法，取值范围为RSAESOAEPSHA256、RSAESOAEPSHA1、RSAESPKCS1V15、SM2 RSAESOAEPSHA1 ciphertextBlob 是 String ODZhOWVmZDktM2QxNi00ODk0LWJkNGYtMWZjNDNmM2YyYWJmS7FmDBBQ0BkKsQrtRnidtPwi 解密密文 响应参数 参数 参数类型 说明 示例 下级对象 statusCode String 返回码 取值范围：200 成功 200 error String 错误码 KMS0514 message String 调用结果信息 解密成功 returnObj String 接口返回结果 returnObj 表 returnObj 参数 参数类型 说明 示例 下级对象 requestId String 请求id 2a56124813ed4ef7a359e818dce118d8 certificateId String 证书id 474e569e8814474a948bdbcf6d853eff plaintext String 解密后明文 csedLEchgF5ijFx9nEc5Y0DpzWb

接口功能介绍 证书公钥加密 接口约束 用户已开通 URI POST /v1/certificateCompute/certificatePublicKeyEncrypt 路径参数 无 Query参数 无 请求参数 请求头header参数 参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池id fecnjniakfkn2314ndekqldedcsadfg 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 certificateId 是 String 证书id 474e569e8814474a948bdbcf6d853eff algorithm 是 String 使用的算法，取值范围为RSAESOAEPSHA256、RSAESOAEPSHA1、RSAESPKCS1V15、SM2 RSAESOAEPSHA1 plaintext 是 String 待加密明文 abc 响应参数 参数 参数类型 说明 示例 下级对象 statusCode String 返回码 取值范围：200 成功 200 error String 错误码 KMS0514 message String 调用结果信息 加密成功 returnObj Object 接口返回结果 returnObj 表 returnObj 参数 参数类型 说明 示例 下级对象 certificateId String 证书id 474e569e8814474a948bdbcf6d853eff ciphertextBlob String 加密后密文 ODZhOWVmZDktM2QxNi00ODk0LWJkNGYtMWZjNDNmM2YyYWJmS7FmDBBQ0BkKsQrtRnidtPwi requestId String 请求id 2a56124813ed4ef7a359e818dce118d8

接口功能介绍 密钥版本详情查询 接口约束 请保证账户余额大于0 URI POST /v1/versionControl/describeKeyVersion 路径参数 无 Query参数 无 请求参数 请求头header参数 参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池id fecnjniakfkn2314ndekqldedcsadfg 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 cmkUuid 是 String 密钥唯一标识id 474e569e8814474a948bdbcf6d853eff keyVersionId 是 String 密钥版本id f2ffbff9940a41a4ba9afe1fd8f22792 响应参数 参数 参数类型 说明 示例 下级对象 statusCode String 返回码 取值范围：200 成功 200 error String 错误码 KMS0514 message String 调用结果信息 获取密钥版本成功 returnObj Object 接口返回结果 returnObj 表 returnObj 参数 参数类型 说明 示例 下级对象 cmkUuid String 密钥唯一标识id 474e569e8814474a948bdbcf6d853eff keyVersionId String 密钥版本id f2ffbff9940a41a4ba9afe1fd8f22792 creationDate String 版本创建时间 Tue Oct 25 15:06:52 CST 2022 requestId String 请求id 87d821f6679544eda3553b6e9dbc2e4c

响应参数 参数 参数类型 说明 示例 下级对象 statusCode String 返回状态码（2000成功，5000系统错误,18xxxx业务错误） 2000 error String 业务错误码，RCCstatusCode RCC1000 message String 返回结果描述 SUCCESS returnObj Object 返回数据体 returnObj 表 returnObj 参数 参数类型 说明 示例 下级对象 totalPrice Double 总价 4.505 subOrderPrices Array of Objects 子项目价格 subOrderPrices 表 subOrderPrices 参数 参数类型 说明 示例 下级对象 totalPrice Double 总价 4.505 serviceTag String 标记 PAAS finalPrice Double 最终价格 4.509 orderItemPrices Array of Objects 价格细分 orderItemPrices 表 orderItemPrices 参数 参数类型 说明 示例 下级对象 itemId Double 项目id bb9081d2c88511edae4d34800d471146 totalPrice Double 总价 4.505 finalPrice Double 最终价格 4.505 resourceType String 资源类型 PAASRCC 枚举参数 无 请求示例 请求url 请求头header 无 请求体body { "clusterName": "mycluster", "engineType": "nacos", "cycleType": "101", "cycleCnt": "1", "autoRenewStatus": "true", "autoRenewCycleType": "3", "autoRenewCycleCount": "1", "resSize": 3, "cpuNum": 4, "memSize": 8, "securityGroupUuid": "59893", "vpcUuid": "16623", "subnetUuid": "25024", "azInfo":[{"azId":3,"azName":"az3"}] }

客户端限速修改。 接口功能介绍 客户端限速修改 接口约束 支持集群模式资源池。 URI POST /v4/vpn/sslclientqos/update 路径参数 无 Query参数 无 请求参数 请求header参数 无 请求body参数 参数 是否必填 参数类型 说明 示例 下级对象 regionID 是 String 资源池ID b342b77ef26b11ecb0ac0242ac110002 sslClientID 是 String SSL客户端ID sslclientf6ee upBandwidth 是 Integer 上行带宽,单位为Kbps或Mbps 10 downBandwidth 是 Integer 下行带宽,单位为Kbps或Mbps 10 isLimitSpeed 否 Boolean 是否限速 取值范围: false:不限速 true:限速 false 响应参数 参数 是否必填 参数类型 说明 示例 下级对象 statusCode 否 Integer 返回状态码 取值范围: 800：成功 900：失败 800 errorCode 否 String 业务细分码，为product.module.code三段式码 message 否 String 失败时的错误描述，一般为英文描述 description 否 String 失败时的错误描述，一般为中文描述 returnObj 否 Object 返回对象 returnObj 表returnObj 参数 是否必填 参数类型 说明 示例 下级对象 logMark 否 String 链路追踪ID 616797965481

响应参数 参数 参数类型 说明 示例 下级对象 statusCode String 返回状态码（2000成功，5000系统错误,18xxxx业务错误） 2000 error String 业务错误码，RCCstatusCode RCC1000 message String 返回结果描述 SUCCESS returnObj Object 返回数据体 returnObj 表 returnObj 参数 参数类型 说明 示例 下级对象 totalPrice Double 总价 4.505 subOrderPrices Array of Objects 子项目价格 subOrderPrices 表 subOrderPrices 参数 参数类型 说明 示例 下级对象 totalPrice Double 总价 4.505 serviceTag String 标记 PAAS finalPrice Double 最终价格 4.509 orderItemPrices Array of Objects 价格细分 orderItemPrices 表 orderItemPrices 参数 参数类型 说明 示例 下级对象 itemId Double 项目id bb9081d2c88511edae4d34800d471146 totalPrice Double 总价 4.505 finalPrice Double 最终价格 4.505 resourceType String 资源类型 PAASRCC 枚举参数 无 请求示例 请求url 请求头header 无 请求体body { "clusterName": "mycluster", "engineType": "nacos", "cycleType": "101", "cycleCnt": "1", "autoRenewStatus": "true", "autoRenewCycleType": "3", "autoRenewCycleCount": "1", "resSize": 3, "cpuNum": 4, "memSize": 8, "securityGroupUuid": "59893", "vpcUuid": "16623", "subnetUuid": "25024", "azInfo":[{"azId":3,"azName":"az3"}] }

接口功能介绍 配置订阅组读取权限 接口约束 无 URI POST /v3/group/updatePerm 路径参数 无 Query参数 无 请求参数 请求头header参数 参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池编码 200000002368 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 prodInstId 是 String 实例ID groupName 是 String 订阅组名字 brokerNameList 是 Array of Strings brokerNameList enable 是 Boolean 是否开启 响应参数 参数 参数类型 说明 示例 下级对象 statusCode String 接口系统层面状态码。成功：800，失败：900 800 message String 描述状态 returnObj Object 返回对象 error String 错误码，只有非成功才有这个字段，方便快速定位问题 201 枚举参数 无 请求示例 请求url 请求头header 无 请求体body { "prodInstId":"mqtest", "groupName":"group", "brokerNameList":[ "mqtestbroker1" ], "enable":true } 响应示例 响应成功示例 { "returnObj":{ }, "message":"success", "statusCode":800 } 响应失败示例 { "returnObj": {}, "message": "...", "error":"201", "statusCode": "900" }

接口功能介绍 调用此接口可获取下载链接地址。 接口约束 参见请求参数说明。 URI POST /v4/monitor/taskcenter/download 路径参数 无 Query参数 无 请求参数 请求头header参数 无 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 regionID 是 String 资源池ID 81f7728662dd11ec810800155d307d5b taskID 是 String 任务ID TASKtacd8b6b4610b97d202306301808 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 返回状态码（800为成功，900为失败），默认值：800 800 errorCode String 失败时的错误代码，参见公共错误码说明 message String 失败时的错误描述，一般为英文描述 Success msgDesc String 失败时的错误描述，一般为中文描述 成功 error String 错误码，请求成功时，不返回该字段 Openapi.Parameter.Error returnObj Object 返回参数，参考returnObj对象结构 returnObj 表 returnObj 参数 参数类型 说明 示例 下级对象 downloadUrl String 下载链接地址 枚举参数 无 请求示例 请求url /v4/monitor/taskcenter/download 请求头header 无 请求体body { "regionID": "81f7728662dd11ec810800155d307d5b", "taskID": "TASKtacd8b6b4610b97d202306301808" }

接口功能介绍 一个监控视图包含一个或多个监控项，监控项为keyvalue格式。 校验指定监控视图中的监控项 Key 是否存在。 接口约束 regionID（资源池）、templateID（监控面板）、viewID（监控视图）存在。 URI GET /v4/monitor/checkmonitoritem 请求参数 Query参数 参数 参数类型 是否必填 示例 说明 下级对象 regionID String 是 81f7728662dd11ec810800155d307d5b 资源池ID templateID String 是 466d5eb4484311eda9b7005056897257 监控面板ID viewID String 是 4cb790ae489411edb386005056897257 监控视图ID itemKey String 是 key1 监控项Key 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 返回状态码（800为成功，900为失败），默认值：800 800 errorCode String 失败时的错误代码，参见公共错误码说明 message String 失败时的错误描述，一般为英文描述 Success msgDesc String 失败时的错误描述，一般为中文描述 成功 returnObj Object 返回对象 returnObj 表returnObj 参数 参数类型 说明 示例 下级对象 exist Boolean 是否存在给定监控项Key true

接口功能介绍 检查是否存在给定名称的监控面板。 这里的名称，是指监控面板自身的名称。 接口约束 regionID（资源池）存在。 URI GET /v4/monitor/checkmonitorname 请求参数 Query参数 参数 参数类型 是否必填 示例 说明 下级对象 regionID String 是 81f7728662dd11ec810800155d307d5b 资源池ID name String 是 templatenameexisttest 要检查的监控面板名称 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 返回状态码（800为成功，900为失败），默认值：800 800 errorCode String 失败时的错误代码，参见公共错误码说明 message String 失败时的错误描述，一般为英文描述 Success msgDesc String 失败时的错误描述，一般为中文描述 成功 returnObj Object 返回对象 returnObj 表returnObj 参数 参数类型 说明 示例 下级对象 exist Boolean 是否存在给定名称的监控面板 true 请求示例 GET /v4/monitor/checkmonitorname?regionID81f7728662dd11ec810800155d307d5b&nametemplatenameexisttest 响应示例 json { "statusCode": 800, "returnObj": { "exist": true }, "errorCode": "", "message": "Success", "msgDesc": "成功" }

告警模板 告警模板：批量删除 接口功能介绍 调用此接口可批量删除告警模板。 接口约束 告警模板ID列表不能为空。 URI POST /v4/monitor/deletealarmtemplates 路径参数 无 Query参数 无 请求参数 请求头header参数 无 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 regionID 是 String ctyun资源池ID 81f7728662dd11ec810800155d307d5b templateIDList 是 Array of Strings 告警模板ID列表 ['312b56b43e4311ed8ef2005056898fe0','318cc4a83e4311ed8ef2005056898fe0'] 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 返回状态码（800为成功，900为失败），默认值：800 800 errorCode String 失败时的错误代码，参见公共错误码说明 message String 失败时的错误描述，一般为英文描述 Success msgDesc String 失败时的错误描述，一般为中文描述 成功 error String 错误码，请求成功时，不返回该字段 Openapi.Parameter.Error returnObj Object 返回参数，参考returnObj对象结构 returnObj 表 returnObj 参数 参数类型 说明 示例 下级对象 success Boolean 删除成功标识 true

监控看板 监控看板：重命名 接口功能介绍 重命名监控看板。 接口约束 参见请求参数说明。 URI POST /v4/monitor/monitorboard/rename 路径参数 无 Query参数 无 请求参数 请求头header参数 无 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 regionID 是 String 资源池ID 81f7728662dd11ec810800155d307d5b boardID 是 String 监控看板ID 58631437d4897105d9ac9bc044d7b6ab name 是 String 新监控面板名称，不可重复 newname 响应参数 参数 参数类型 说明 示例 下级对象 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

接口功能介绍 查询CSR列表信息及CSR详细信息。 接口约束 无 URI POST /v1/csr/list 路径参数 无 Query参数 无 请求参数 请求头header参数 无 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 pageNum 是 Integer 页码 1 pageSize 是 Integer 每页数量 10 keyword 否 String 域名关键字搜索 test.cn encryptionAlgorithm 否 String 加密算法。取值范围：RSA、ECC、SM2 RSA 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 状态码 200 message String 提示信息 Success error String 仅错误时返回 CCMS100000063 returnObj Object 分页 Page 表 Page 参数 参数类型 说明 示例 下级对象 totalSize Integer 数据总量 100 list Object 数据记录 CsrListResult 表 CsrListResult 参数 参数类型 说明 示例 下级对象 id String uuid 6ee1160088ef44ec80213d1a448b2d8e name String csr6b9cea crs名称 domainName String ctyun.cn 域名 privateKeyIsEmpty Boolean 私钥是否为空 false encryptionAlgorithm String 加密算法 SM2 generateMethod String CSR生成方式 MANUAL createTime String 创建时间 20240513T09:19:01Z

本节介绍AI应用中心常见问题。 云智助手如何收费？ 暂不收费。 如何获取云智助手？ 云智助手已面向全部用户推送，如您未能在桌面找到，则可以前往云电脑应用市场下载。 如何切换不同大模型对话？ 1.云智助手对话界面顶部模型切换下拉框，切换后，将新建对话。 2.云智助手右上角更多设置，在设置中可选择切换不同大模型对话，切换后，将新建对话。 是否支持取消云智助手的默认启动快捷键：Alt+E？ 目前云智助手的默认启动快捷键是系统固定的，可在『偏好设置其他设置』中关闭。 注意 如找不到相应开关，请尝试升级客户端解决。 云智助手支持删除历史对话吗？ 暂不支持删除历史对话，后续将会优化以便提供更好的体验。 AI会议助手支持删除会议纪要文件吗？ 暂不支持手动删除会议纪要文件，但会议纪要文件默认保存14天，14天后系统将会自动清除对应文件数据。