本章节主要介绍调用API。 概述 您作为API调用者，需要实现一个API的调用，那么您需要完成以下工作： 1.获取API 从服务目录获取需要调用API。仅在API发布后，才支持被调用。 2.（可选）创建应用并获取授权 对于使用APP和IAM认证的API，需要完成创建应用和将API授权给应用。在API调用过程中，使用所创建应用的密钥对（AppKey、AppSecret），数据服务根据密钥对进行身份核对，完成鉴权。 3.调用API API调用者完成以上步骤后，可以进行API调用。 创建应用 1.在DataArts Studio控制台首页，选择实例，点击“进入控制台”，选择对应工作空间的“数据服务”模块，进入数据服务页面。 详见下图：选择数据服务 2.在左侧导航栏选择服务版本（例如：专享版），进入总览页。 3.单击“调用API > 应用管理”，进入到应用管理页面。单击“新建”，弹出“新建应用”对话框。填写如表3363所示信息。 详见下表： 应用信息 信息项 描述 应用名称 应用名称。 应用类型 IAM：使用IAM认证，即token访问。 APP：对接APP，通过APP认证方式访问。 描述 对应用的介绍。 4.单击“确定”，创建应用。 创建应用成功后，在“应用管理”页面的列表中显示新创建的应用和应用ID。 5.单击“应用名称”，进入应用详情页面，查看AppKey和AppSecret。 将API授权给应用 1.在DataArts Studio控制台首页，选择实例，点击“进入控制台”，选择对应工作空间的“数据服务”模块，进入数据服务页面。 详见下表： 选择数据服务 2.在左侧导航栏选择服务版本（例如：专享版），进入总览页。 3.通过以下任意一种方式，将API授权给应用。 主动授权： a.单击“开发API > API管理”，进入到API管理页面。 b.在待绑定应用的API所在行，单击“查看授权”，进入API完整信息界面。 在“授权信息”页签中，单击“添加授权”。 c.设置授权的截止时间，勾选应用名称，单击“确认授权”，完成API的授权。 申请授权： a.单击“调用API > 服务目录”，进入服务市场主页面。 b.单击待绑定应用的API名称，进入API完整信息页面。 c.在“调用信息”页面，单击“申请权限”。 d.设置使用截止时间并选择应用名称，单击“确认”。 e.申请后，需要等待审核中心审核，方可授权成功。 4.授权成功后，可以在应用管理详情页面查看已绑定的API。 说明 如果已绑定API列表中包含无需绑定的API，在此API所在行的操作列，单击“解绑”，将无需绑定的API删除。 如果需要调试已绑定的API，单击“测试”，进入调试页面。 如果需要对已绑定的API延长授权时间，单击“续约”。

响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 返回状态码（800为成功，900为失败） 800 errorCode String 错误码，为product.module.code三段式码 Openapi.PatternCheck.NotValid error String 错误码，为product.module.code三段式码 Openapi.PatternCheck.NotValid message String 英文描述信息 SUCCESS description String 中文描述信息 成功 returnObj Object 成功时返回的数据 returnObj 表 returnObj 参数 参数类型 说明 示例 下级对象 currentCount Integer 当前页记录数目 1 totalCount Integer 总记录数 10 totalPage Integer 总页数 1 results Array of Objects 分页明细 results 表 results 参数 参数类型 说明 示例 下级对象 projectID String 企业项目ID 0 azName String 可用区名称 az1 attachedVolume Array of Strings 云硬盘ID列表 ["8e8f8bc8b8ad8a8e8e8888cd88888e88"] addresses Array of Objects 网络地址信息 addresses resourceID String 云主机资源ID f88bc88a88a888e8a88bf88888888888 instanceID String 云主机ID 88f888ea88ff88eca8bc888888888fe8 displayName String 云主机显示名称 xxx8888 instanceName String 云主机名称 xxx8888 osType Integer 操作系统类型，详见枚举值表 5 instanceStatus String 云主机状态，请通过状态状态枚举值查看云主机使用状态 running expiredTime String 到期时间 20230419T09:37:53Z availableDay Integer 可用(天) 100 updatedTime String 更新时间 20221019T09:37:53Z createdTime String 创建时间 20221019T09:37:53Z zabbixName String 监控对象名称 8a8fdc88b8a888bb888f8b88888c88f8 secGroupList Array of Objects 安全组信息 secGroupList privateIP String 内网ipv4地址 10.0.0.1 privateIPv6 String 内网ipv6址 888:8:8c8:8888:bee8:88d8:c8a8:888 networkCardList Array of Objects 网卡信息 networkCardList vipInfoList Array of Objects 虚拟IP信息列表 vipInfoList vipCount Integer 虚拟IP数目 1 affinityGroup Object 云主机组信息 affinityGroup image Object 镜像信息 image flavor Object 云主机规格信息 flavor onDemand Boolean 付费方式，取值范围： true：表示按量付费， false：表示包周期 true vpcName String 虚拟私有云名称 vpcxxx vpcID String 虚拟私有云ID vpcxxx8xxxxxx fixedIPList Array of Strings 内网IP ["10.0.0.1"] floatingIP String 公网IP 172.16.0.243 subnetIDList Array of Strings 子网ID列表 ["subnet0yy0yy0yyy"] keypairName String 密钥对名称 keypairxxx 表 addresses 参数 参数类型 说明 示例 下级对象 vpcName String vpc名称 vpcxxxx addressList Array of Objects 网络地址列表 addressList 表 secGroupList 参数 参数类型 说明 示例 下级对象 securityGroupID String 安全组ID sgxxxxxxxx7x securityGroupName String 安全组名称 DefaultSecurityGroup 表 networkCardList 参数 参数类型 说明 示例 下级对象 IPv4Address String IPv4地址 10.0.0.1 IPv6Address Array of Strings IPv6地址列表 ["888:8:8c8:8888:bee8:88d8:c8a8:888"] subnetID String 子网ID subnet0yy6yy2yyy subnetCidr String 子网网段信息 10.0.0.1/24 isMaster Boolean 是否主网卡，取值范围： true：主网卡， false：扩展网卡 true gateway String 网关地址 192.168.0.1 networkCardID String 网卡ID port5ttttt9tt8 securityGroup Array of Strings 安全组ID列表 ["sgxxxxxxxx7x"] 表 vipInfoList 参数 参数类型 说明 示例 下级对象 vipID String 虚拟IP的ID havipfw1kb30m78 vipAddress String 虚拟IP地址 192.168.0.58 vipBindNicIP String 虚拟IP绑定的网卡对应IPv4地址 192.168.0.62 vipBindNicIPv6 String 虚拟IP绑定的网卡对应IPv6地址 100:1:179:b400:d7ea:3e70:7966:2ba5 nicID String 网卡ID portomdlwvr4sm 表 affinityGroup 参数 参数类型 说明 示例 下级对象 policy String 云主机组策略 softaffinity affinityGroupName String 云主机组名称 group10274 affinityGroupID String 云主机组ID 682c01af1eaf400b570f05734a00619d 表 image 参数 参数类型 说明 示例 下级对象 imageID String 镜像ID b88888b8ff888888b88f8c8fbc888b88 imageName String 镜像名称 CentOS7.5.v120210303 表 flavor 参数 参数类型 说明 示例 下级对象 flavorID String 规格ID 8f8ba88888e8ea88ea8b888888dded88 flavorName String 规格名称 s7.medium.2 flavorCPU Integer VCPU 1 flavorRAM Integer 内存 2048 gpuType String GPU类型，取值范围：T4、V100、V100S、A10、A100、atlas 300i pro、mlu370s4，支持类型会随着功能升级增加 T4 gpuCount Integer GPU数目 1 gpuVendor String GPU名称 gpxxxx videoMemSize Integer GPU显存大小 4 表 addressList 参数 参数类型 说明 示例 下级对象 addr String IP地址 192.168.0.62 version Integer IP版本 4 type String 网络类型，取值范围： fixed：内网， floating：弹性公网 fixed

接口功能介绍 获取转发规则列表 接口约束 无 URI GET /v4/elb/listrule 路径参数 无 Query参数 参数 是否必填 参数类型 说明 示例 下级对象 regionID 是 String 区域ID IDs 否 String 转发规则ID列表，以,分隔 rule75ex90k9v0,ruler4cfhgrsss loadBalancerID 否 String 负载均衡实例ID 请求参数 请求头header参数 无 请求体body参数 无 响应参数 参数 参数类型 说明 示例 下级对象 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 Array of Objects 接口业务数据 returnObj error String statusCode为900时为业务细分错误码，三段式：product.module.code; statusCode为800时为SUCCESS 表 returnObj 参数 参数类型 说明 示例 下级对象 regionID String 区域ID azName String 可用区名称 projectID String 项目ID ID String 转发规则ID loadBalancerID String 负载均衡ID listenerID String 监听器ID priority Integer 优先级 100 description String 描述 conditions Array of Objects 匹配规则数据 conditions action Object 规则目标 action status String 状态: ACTIVE / DOWN createdTime String 创建时间，为UTC格式 updatedTime String 更新时间，为UTC格式 表 conditions 参数 参数类型 说明 示例 下级对象 type String 类型。取值范围：servername（服务名称）、urlpath（匹配路径） serverNameConfig Object 服务名称 serverNameConfig urlPathConfig Object 匹配路径 urlPathConfig 表 serverNameConfig 参数 参数类型 说明 示例 下级对象 serverName String 服务名称 表 urlPathConfig 参数 参数类型 说明 示例 下级对象 urlPaths String 匹配路径 matchType String 匹配类型。取值范围：ABSOLUTE，PREFIX，REG 表 action 参数 参数类型 说明 示例 下级对象 type String 默认规则动作类型 forwardConfig Object 转发配置 forwardConfig redirectListenerID String 重定向监听器ID 表 forwardConfig 参数 参数类型 说明 示例 下级对象 targetGroups Array of Objects 后端服务组 targetGroup 表 targetGroup 参数 参数类型 说明 示例 下级对象 targetGroupID String 后端服务组ID weight Integer 权重 100

接口功能介绍 查询指定时间段内的监听器时序指标监控数据。 接口约束 regionID（资源池）、deviceUUIDList（监听器资源）、itemNameList（待查监控项名称）存在。 URI POST /v4/monitor/querylistenerhistorymetricdata 请求参数 请求体body参数 参数 参数类型 是否必填 示例 说明 下级对象 regionID String 是 81f7728662dd11ec810800155d307d5b 资源池ID itemNameList Array of String 是 ["lsscur"] 待查的监控项名称 startTime String 是 1667815639 查询起始时间戳 endTime String 是 1667817639 查询结束时间戳 deviceUUIDList Array of String 是 ["listenernz7f02jdzb"] 查询设备ID列表，具体值参考监控对象查询返回字段deviceUUID period Integer 否 300 聚合周期，单位：秒，默认300 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 参数 参数类型 说明 示例 下级对象 result Array of Objects 返回数据结果 result totalCount Integer 获取对象数据条数 14 totalPage Integer 总页数 1 currentCount Integer 当前页记录数 14 page Integer 页码，建议参考请求参数pageNo，该参数后续会下线 1 pageSize Integer 页大小，建议参考请求参数pageSize，该参数后续会下线 10 表result 参数 参数类型 说明 示例 下级对象 regionID String 所属资源池ID 81f7728662dd11ec810800155d307d5b fUID String 唯一键 listenernz7f02jdzb deviceUUID String 设备ID listenernz7f02jdzb fuserLastUpdated String 最近更新时间 20221107 18:25:12 itemAggregateList Array of Objects 监控项值列表 itemAggregateList 表itemAggregateList 参数 参数类型 说明 示例 下级对象 {itemName} Array of Objects 监控项内容 valueObject 表valueObject 参数 参数类型 说明 示例 下级对象 samplingTime Integer 监控数据采样时间 1667815639 value String 监控项值，具体请参考对应监控项文档 524288

接口功能介绍 查询指定时间段内的裸金属时序指标监控数据。 接口约束 regionID（资源池）、deviceUUIDList（裸金属资源）、itemNameList（待查监控项名称）存在。 URI POST /v4/monitor/querybaremetalhistorymetricdata 请求参数 请求体body参数 参数 参数类型 是否必填 示例 说明 下级对象 regionID String 是 81f7728662dd11ec810800155d307d5b 资源池ID itemNameList Array of String 是 ["cpuutil","memutil"] 待查的监控项名称 startTime String 是 1667815639 查询起始时间戳 endTime String 是 1667817639 查询结束时间戳 deviceUUIDList Array of String 是 ["ssdflzofraseqxqocgiuxm5acrwz4j"] 查询设备ID列表，具体值参考监控对象查询返回字段deviceUUID period Integer 否 300 聚合周期，单位：秒，默认300 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 参数 参数类型 说明 示例 下级对象 result Array of Objects 返回数据结果 result totalCount Integer 获取对象数据条数 14 totalPage Integer 总页数 1 currentCount Integer 当前页记录数 14 page Integer 页码，建议参考请求参数pageNo，该参数后续会下线 1 pageSize Integer 页大小，建议参考请求参数pageSize，该参数后续会下线 10 表result 参数 参数类型 说明 示例 下级对象 regionID String 所属资源池ID 81f7728662dd11ec810800155d307d5b fUID String 唯一键 ssdflzofraseqxqocgiuxm5acrwz4j deviceUUID String 设备ID ssdflzofraseqxqocgiuxm5acrwz4j fuserLastUpdated String 最近更新时间 20221107 18:25:12 itemAggregateList Array of Objects 监控项值列表 itemAggregateList 表itemAggregateList 参数 参数类型 说明 示例 下级对象 {itemName} Array of Objects 监控项内容 valueObject 表valueObject 参数 参数类型 说明 示例 下级对象 samplingTime Integer 监控数据采样时间 1667815639 value String 监控项值，具体请参考对应监控项文档 524288

数据删除 租户删除文档数据库服务实例时，存储在数据库实例中的数据都会被删除，任何人都无法查看及恢复数据。

接口功能介绍 查询自定义镜像列表 接口约束 无 URI GET /v3/customImage/describe 路径参数 无 Query参数 参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池ID。 d8bbd132b53a11e9b0e40242ac110002 imageName 否 String 镜像名称 DYF status 否 String 状态。枚举值范围：[Starting启用中, Available可用, Stopped停用, StartFailed启用失败, Uploading上传中, UploadFailed上传失败, WaitVerify待验证, Expired已过期, Deleting删除中, DeleteFailed删除失败]。 Available pageNum 否 Integer 页码，至少1，默认1 1 pageSize 否 Integer 每页数量，最大100，默认10 10 请求参数 请求头header参数 无 请求体body参数 无 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 状态码。可能值： 800：请求成功。 900：请求失败。 800 error String 错误码。 ECPC1000 message String 提示信息。 ok returnObj Object 返回数据对象 returnObj 表 returnObj 参数 参数类型 说明 示例 下级对象 total Long 总记录数 2 list Array of Objects 数据列表 list 表 list 参数 参数类型 说明 示例 下级对象 imageOid String 镜像ID milm91642m8ukk1r7a6h7l5 imageName String 镜像名称 WindowsServer2019Standardv1.3 osType String 操作系统类型（Windows;Linux） Windows platform String 操作系统平台（Windows;Centos;Ubuntu;UOS;Kylin银河麒麟;NeoKylin中标麒麟） Windows sysDisk Object 系统盘相关信息 sysDisk dataDisks Array of Objects 数据盘相关信息列表 dataDisks description String 描述 测试 gpuCategory Boolean 是否为GPU类型镜像 false status String 状态。枚举值范围：[Starting启用中, Available可用, Stopped停用, StartFailed启用失败, Uploading上传中, UploadFailed上传失败, WaitVerify待验证, Expired已过期, Deleting删除中, DeleteFailed删除失败]。 Available createTime String 创建时间。以ISO 8601为标准，并使用UTC+0时间，格式为yyyyMMddTHH:mm:ssZ。 20230927T07:48:41Z expireTime String 到期时间。以ISO 8601为标准，并使用UTC+0时间，格式为yyyyMMddTHH:mm:ssZ。 null 表 sysDisk 参数 参数类型 说明 示例 下级对象 diskSize Integer 盘大小（单位：GB） 80 表 dataDisks 参数 参数类型 说明 示例 下级对象 diskSize Integer 盘大小（单位：GB） 20

接口功能介绍 查询队列v3 接口约束 无 URI GET /v3/queue/query 路径参数 无 Query参数 参数 是否必填 参数类型 说明 示例 下级对象 prodInstId 是 String 实例ID 6b10c8b962244f1f921d1a48d0f15cca vhost 否 String vhost名称 vhost1 name 否 String 队列名称 pageNum 否 Integer 分页的页序号 1 pageSize 否 Integer 分页的大小 100 请求参数 请求头header参数 参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池id 6b10c8b962244f1f921d1a48d0f15cca 请求体body参数 无 响应参数 参数 参数类型 说明 示例 下级对象 returnObj Object 返回对象 returnObj message String 描述状态 success statusCode String 接口系统层面状态码。成功：800，失败：900 800 error String 错误码，描述错误信息，只有失败才显示 AMQPAMQP 表 returnObj 参数 参数类型 说明 示例 下级对象 data Object 返回数据 data 表 data 参数 参数类型 说明 示例 下级对象 filteredcount Integer 按name过滤后的总队列数 2 itemcount Integer 当前页面上的队列数量 2 items Array of Objects 队列详细信息 items page Integer 当前页数 1 pagecount Integer 总页数 1 pagesize Integer 分页设置的每个页面的最多队列数 100 totalcount Integer 总队列数 2 表 items 参数 参数类型 说明 示例 下级对象 vhost String 虚拟机名称 / durable Boolean 是否持久化，默认持久化 true name String 队列名称 qu1 autodelete Boolean 是否自动删除 false consumers Integer 消费者数量 0

本页介绍天翼云TeleDB数据库的COLUMN设计规范。 建议能用数值类型的，就不用字符类型。 建议能用varchar(N)就不用char(N)，以利于节省存储空间。 建议能用varchar(N)就不用text，varchar。 建议使用default NULL，而不用 default ''，以节省存储空间。 建议如有国际货业务的话，使用timestamp with time zone(timestamptz)，而不用 timestamp without time zone，避免时间函数在对于不同时区的时间点返回值不同，也为业务国际化扫清障碍。 建议使用NUMERIC(precision，scale)来存储货币金额和其它要求精确计算的数值， 而不建议使用real，double precision。

业务场景 在一个社交媒体平台中，我们需要实时统计用户的点赞数和在线人数。为了满足实时性和高并发的需求，我们决定使用 Redis 来实现一个实时计数器。 业务需求 实时统计用户的点赞数，以便在用户界面上显示点赞数的实时更新。 实时统计在线用户人数，以便在管理后台实时监控在线用户的数量。 需求分析 计数器需要能够实时更新，并能够处理高并发的请求。 计数器的数据需要持久化，以防止数据丢失。 实现方案 使用 Redis 的计数器功能来存储和更新点赞数和在线用户数。 使用 Redis 的键过期功能来自动清除超时的在线用户。 使用 Redis 的持久化功能，如 AOF 或 RDB，来保证数据的持久性。 使用 Redis 的事务功能来确保计数器的原子性更新。 示例代码 以下是一个简化的示例代码，展示了如何使用 Redis 实现实时计数器的关键部分： // 用户点赞操作 public void likePost(String postId, String userId) { Jedis jedis new Jedis("localhost"); jedis.incr("postlikes:" + postId); // 增加点赞数 jedis.sadd("postlikedusers:" + postId, userId); // 添加点赞用户 jedis.close(); } // 获取帖子的点赞数 public long getPostLikes(String postId) { Jedis jedis new Jedis("localhost"); long likes Long.parseLong(jedis.get("postlikes:" + postId)); jedis.close(); return likes; } // 用户上线操作 public void userOnline(String userId) { Jedis jedis new Jedis("localhost"); jedis.setex("useronline:" + userId, 300, "true"); // 设置用户在线标志，并设置过期时间为 300 秒 jedis.close(); } // 获取在线用户数 public long getOnlineUserCount() { Jedis jedis new Jedis("localhost"); long count jedis.keys("useronline:").size(); jedis.close(); return count; } 在上述示例代码中，我们使用 Redis 的计数器功能来存储点赞数，并使用 Redis 的集合数据类型来存储点赞的用户。对于在线用户数的统计，我们使用 Redis 的键过期功能来设置用户在线标志的过期时间，并使用 Redis 的键查询功能来获取在线用户数。

接口描述 下载审计日志文件。 接口约束 URI GET /v1/collector/sqllogdownload 请求参数 请求头header参数 参数 是否必填 参数类型 说明 示例 下级对象 请求体Query参数 参数 是否必填 参数类型 说明 示例 下级对象 prodInstId 是 Long 实例id 10 dbResourceId 是 Long 数据库资源id 2 fileName 是 String 审计日志文件名称 postgresql20221026152843.csv 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 状态码 800 message String 消息提示 SUCCESS returnObj Object 返回对象 请求示例 /v1/collector/sqllogdownload?prodInstId10&dbResourceId2&fileNamepostgresql20221101174412.csv 请求头header 请求体body 响应示例 groovy { "message": "SUCCESS", "returnObj": {}, "statusCode": 800 } 错误码 访问ErrorCodes说明文档查看更多错误码。

接口功能介绍 校验备份集名称的有效性。 接口约束 无 URI GET /v1/backup/backupnamevalidity 请求参数 请求头header参数 参数 是否必填 参数类型 说明 示例 下级对象 请求体Query参数 参数 是否必填 参数类型 说明 示例 下级对象 prodInstId 是 Long 实例id 10 backupName 是 String 备份名称 1. 长度为1100个字符 2. 由数字、中文、英文、下划线（）、短横线（）组成 test 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 状态码 800 message String 消息提示 SUCCESS returnObj Object 返回对象，true:有效，false:无效 true 请求示例 /v1/backup/backupnamevalidity?prodInstId10&backupNametest 请求头header 请求体body 响应示例 json { "message": "SUCCESS", "returnObj": true, "statusCode": 800 } 错误码 访问ErrorCodes说明文档查看更多错误码。

OpenClaw 是一个开源的、运行于系统级环境的通用 AI 助手框架。支持文件读写、代码执行与多步任务编排，可通过聊天工具接收指令并完成实际操作。其核心特征是“可执行性”，适用于自动化办公与任务代理，通常需在隔离、可控的云端环境中运行。 说明 OpenClaw 作为开源项目，建议在使用前全面评估其安全性与稳定性，仔细阅读《OpenClaw 安全风险提示》并且严格按照对应的开源许可协议规范使用，确保系统和数据安全。 本文将为您介绍使用天翼云弹性云主机部署个人AI助手 OpenClaw 的最佳实践。 注意 本文使用最新版本镜像 【OpenClawv2026.3.13Ubuntu24.04 】部署， 建议您使用该镜像参考流程。低于【OpenClawv2026.3.13 】版本的镜像，请参考实践使用云主机部署OpenClaw（自定义配置版）进行操作。 步骤1：购买云主机 方式1：通过公有云生态专区部署OpenClaw 说明 资源池西南1、华南2、长沙42、武汉41、芜湖2、杭州7 、华东1、武汉4、拉萨3、上海36 、上海7 支持使用方式1部署。 1. 登录天翼云官网，进入[公有云生态专区](

本文主要介绍RDSPostgreSQL实例的空闲连接查杀操作。 操作场景 若您的数据库实例在查询结束后连接进程不主动关闭，此时就会产生空闲连接。空闲连接过多时，会影响您的数据库实例性能。您可以通过杀死空闲连接降低对数据库性能的影响。 操作步骤 1. 登录天翼云门户。 2. 点击控制中心，进入控制中心后，选择目标资源池。 3. 在产品列表页面中找到【数据库】→【关系数据库PostgreSQL版】，点击进入控制台。 4. 在左侧菜单中点击【PostgreSQL】→【实例管理】，点击进入产品实例管理页。 5. 在【实例管理】的实例列表中选择目标实例，点击实例名称进入实例管理详情页。 6. 在二级菜单中，选择"实例操作"。 7. 在"实例操作"页面，操作类型选择"空闲连接查杀"，数据库命令下拉选择对应类型，待查杀用户输入您需要查杀的数据库用户名，时间阈值填写您需要查杀的时间，默认单位为秒。确认以上信息后，点击"执行"按钮。 8. 等待系统执行空闲连接查杀操作后， 会出现相应的"操作结果"和"信息"提示。 注意 不同资源池因IaaS资源能力等原因，加载版本有所差异，详见

接口功能介绍 删除指定对象所有备份资源，包括备份计划、备份任务、备份数据、恢复任务 接口约束 1、该备份对象存在需要删除的备份资源 URI POST /v4/backup/deleteresourcesbackup 路径参数 无 Query参数 无 请求参数 请求头header参数 无 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 backupObjectID 是 String 备份对象ID 0ae97ef56ee244af9d051a509b0a1be6 regionID 是 String 资源池ID 81f7728662dd11ec810800155d307d5b isCloud 否 Boolean 是否是云上资源(默认true)，true：弹性云主机，false：本地客户主机。该参数后续即将下线，推荐使用sourceType参数 true sourceType 否 String 产品服务类型(默认CTECS)，CTECS：弹性云主机，CTDPS：裸金属物理机，CTLS：本地客户主机 CTDPS 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 返回状态码(800为成功，900为失败) 800 message String 成功或失败时的描述，一般为英文描述 SUCCESS description String 成功或失败时的描述，一般为中文描述 成功 returnObj Object 成功时返回对象 returnObj errorCode String 业务细分码，为product.module.code三段式码。 backup.regionInfo.empty error String 业务细分码，为product.module.code三段式大驼峰码 Backup.RegionInfo.Empty 表 returnObj 参数 参数类型 说明 示例 下级对象 status String 删除操作状态 参考响应示例 regionID String 资源池ID 参考响应示例

接口功能介绍 删除指定对象所有备份资源，包括备份计划、备份任务、备份数据、恢复任务 接口约束 1、该备份对象存在需要删除的备份资源 URI POST /v4/backup/deleteresourcesbackup 路径参数 无 Query参数 无 请求参数 请求头header参数 无 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 backupObjectID 是 String 备份对象ID 0ae97ef56ee244af9d051a509b0a1be6 regionID 是 String 资源池ID 81f7728662dd11ec810800155d307d5b isCloud 否 Boolean 是否是云上资源(默认true)，true：弹性云主机，false：本地客户主机。该参数后续即将下线，推荐使用sourceType参数 true sourceType 否 String 产品服务类型(默认CTECS)，CTECS：弹性云主机，CTDPS：裸金属物理机，CTLS：本地客户主机 CTDPS 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 返回状态码(800为成功，900为失败) 800 message String 成功或失败时的描述，一般为英文描述 SUCCESS description String 成功或失败时的描述，一般为中文描述 成功 returnObj Object 成功时返回对象 returnObj errorCode String 业务细分码，为product.module.code三段式码。 backup.regionInfo.empty error String 业务细分码，为product.module.code三段式大驼峰码 Backup.RegionInfo.Empty 表 returnObj 参数 参数类型 说明 示例 下级对象 status String 删除操作状态 参考响应示例 regionID String 资源池ID 参考响应示例

操作步骤 单个实例绑定一个或多个标签 1. 登录“控制中心”，管理控制台顶部菜单左侧 ，选择地域。 2. 选择 “存储>海量文件服务OceanFS”，进入OceanFS文件系统列表页面。 3. 在文件系统列表中，点击待添加标签的文件系统所在行的“操作>更多>编辑标签”。 4. 弹出“编辑标签”窗口，键入标签“标签键”，和“标签值”。支持同时添加多个标签，单击“确定”，完成标签的添加。 5. 此时，在此文件系统列表页的“标签”列处，点击标签图标可看到已添加的标签信息。 多个实例绑定一个或多个标签 1. 登录“控制中心”，管理控制台顶部菜单左侧 ，选择地域。 2. 选择 “存储>海量文件服务OceanFS”，进入OceanFS文件系统列表页面。 3. 在文件系统列表中，勾选需要批量绑定标签的文件系统实例，点击列表上方按钮“批量绑定标签”。 4. 在“批量绑定标签”弹窗中，展示了所选文件系统实例，您可以按照使用限制与配置参数说明要求填写/选择标签键值，新增标签键值对。新增完成后，所有被勾选的文件系统实例都将绑定该新增标签。 5. 您还可以在“批量绑定标签”弹窗中，修改标签键值对，执行编辑标签操作。 解绑标签 前提条件 实例资源已绑定标签。 操作步骤 解绑单个实例的标签 1. 登录“控制中心”，管理控制台顶部菜单左侧 ，选择地域。 2. 选择 “存储>海量文件服务OceanFS”，进入OceanFS文件系统列表页面。 3. 在文件系统列表中，点击待添加标签的文件系统所在行的“操作>更多>编辑标签”。 4. 弹出“编辑标签”窗口，点击标签键值后面的“删除”，可同时删除多个标签。 5. 单击弹窗下方“确定”，完成标签的解绑操作。

介绍分布式消息服务RabbitMQ惰性队列能力。 使用场景 RabbitMQ从3.6.0版本开始引入了惰性队列（Lazy Queue）的概念。惰性队列会尽可能的将消息存入磁盘中，而在消费者消费到相应的消息时才会被加载到内存中，它的一个重要的设计目标是能够支持更长的队列，即支持更多的消息存储。当消费者由于各种各样的原因（比如消费者下线、宕机亦或者是由于维护而关闭等）而致使长时间内不能消费消息造成堆积时，惰性队列就很有必要了 默认情况下，当生产者将消息发送到RabbitMQ的时候，队列中的消息会尽可能的存储在内存之中，这样可以更加快速的将消息发送给消费者。即使是持久化的消息，在被写入磁盘的同时也会在内存中驻留一份备份。当RabbitMQ需要释放内存的时候，会将内存中的消息换页至磁盘中，这个操作会耗费较长的时间，也会阻塞队列的操作，进而无法接收新的消息。虽然RabbitMQ的开发者们一直在升级相关的算法，但是效果始终不太理想，尤其是在消息量特别大的时候 惰性队列会将接收到的消息直接存入文件系统中，而不管是持久化的或者是非持久化的，这样可以减少了内存的消耗，但是会增加I/O的使用，如果消息是持久化的，那么这样的I/O操作不可避免，惰性队列和持久化消息可谓是“最佳拍档”。注意如果惰性队列中存储的是非持久化的消息，内存的使用率会一直很稳定，但是重启之后消息一样会丢失。

本节主要介绍分布式消息服务Kafka的创建Topic说明 背景信息 Kafka的主题（Topic）是对消息进行分类和组织的概念。主题是Kafka中最基本的逻辑单元，用于区分不同类型的消息。 每个主题可以有多个分区（Partition），每个分区都是一个有序的消息日志。分区允许消息在集群中进行并行处理，提高了吞吐量和并发性能。 主题的特点包括： 逻辑分类：主题可以根据业务需求或数据类型进行逻辑分类，例如订单主题、日志主题、用户行为主题等。 多分区：主题可以被分成多个分区，每个分区都有自己的消息顺序。分区可以在不同的节点上进行存储和处理，实现了水平扩展和负载均衡。 副本复制：每个分区可以有多个副本（Replica），副本用于提供高可用性和容错性。副本可以分布在不同的节点上，当节点故障时可以自动进行故障转移。 持久化存储：主题中的消息被持久化存储在磁盘上，确保消息的可靠性和持久性。消费者可以随时消费主题中的历史消息，而不仅仅是最新的消息。 通过使用主题，Kafka能够有效地组织和管理大规模的消息流。主题的分区和副本机制提供了高可用性和容错性，使得Kafka成为处理大规模实时数据流的理想选择。 前提条件 已购买并部署分布式消息服务Kafka 操作步骤 创建Topic （1）登录管理控制台。 （2）进入Kafka管理控制台。 （3）在实例列表页在操作列，目标实例行点击“管理”。 （4）点击“Topic管理”后、点击“创建Topic”。 （5）点击“创建Topic”后，输入Topic名称、分区数等参数。 （6）创建好Topic后，可以点击“更多”按钮中的“生产消息”来测试其是否正常。

基本信息 负载类型：选择守护进程DaemonSet。工作负载类型的介绍请参见工作负载概述。 负载名称：填写工作负载的名称。 命名空间：选择工作负载的命名空间，默认为default。您可以单击后面的“创建命名空间”，命名空间的详细介绍请参见创建命名空间。 容器运行时：CCE集群默认使用普通运行时。 时区同步：选择是否开启时区同步。开启后容器与节点使用相同时区（时区同步功能依赖容器中挂载的本地磁盘，请勿修改删除），时区同步详细介绍请参见时区同步。 容器配置 容器信息 Pod中可以配置多个容器，您可以单击右侧“添加容器”为Pod配置多个容器。 基本信息：容器基本信息 生命周期：设置容器生命周期 健康检查：设置容器健康检查 环境变量：设置环境变量 数据存储：存储概述 安全设置：对容器权限进行设置，保护系统和其他容器不受其影响。请输入用户ID，容器将以当前用户权限运行。 容器日志：使用ICAgent采集容器日志 说明 负载实例数大于1时，不支持挂载云硬盘类型的存储。 镜像访问凭证：用于访问镜像仓库的凭证，默认取值为defaultsecret，使用defaultsecret可访问SWR镜像仓库的镜像。defaultsecret详细说明请参见defaultsecret。 GPU显卡：默认为不限制。当集群中存在GPU节点时，工作负载实例可以调度到指定GPU显卡类型的节点上。

参数 参数说明 协议端口 请选择对应的协议类型和端口，目前支持TCP和UDP协议。 源对象命名空间 选择允许哪个命名空间的对象允许访问。 源对象Pod标签 选择允许带有这个标签的Pod访问。

接口功能介绍 查询负载均衡设备的实时监控数据。 接口约束 regionID（资源池）存在，且存在负载均衡设备。 URI POST /v4/monitor/queryelblatestmetricdata 请求参数 请求体body参数 参数 参数类型 是否必填 示例 说明 下级对象 regionID String 是 81f7728662dd11ec810800155d307d5b 资源池ID deviceUUIDList Array of String 是 ["lb01zk7t5mnf","lb01s9e8clwu"] 查询设备ID列表，具体值参考监控对象查询返回字段deviceUUID pageNo Integer 否 1 页码，默认为1 page Integer 否 1 页码，默认为1，建议使用pageNo，该参数后续会下线 pageSize Integer 否 1 页大小，默认为20 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 返回状态码（800为成功，900为失败），默认值：800 800 errorCode String 失败时的错误代码，参见公共错误码说明 message String 失败时的错误描述，一般为英文描述 Success msgDesc String 失败时的错误描述，一般为中文描述 成功 returnObj Object 返回对象 returnObj 表returnObj 参数 参数类型 说明 示例 下级对象 result Array of Objects 返回数据结果 result totalCount Integer 获取对象数据条数 138 totalPage Integer 总页数 1 currentCount Integer 当前页记录数 2 page Integer 页码，建议参考请求参数pageNo，该参数后续会下线 1 pageSize Integer 页大小，建议参考请求参数pageSize，该参数后续会下线 10 表result 参数 参数类型 说明 示例 下级对象 regionID String 所属资源池ID 81f7728662dd11ec810800155d307d5b fUID String 唯一键 lb01zk7t5mnf fuserLastUpdated String 最近更新时间 20221107 18:25:12 deviceUUID String 设备ID lb01zk7t5mnf itemList Object 监控项内容 itemList 表itemList 参数 参数类型 说明 示例 下级对象 samplingTime Integer 监控数据采集时间 1667816712 {item1} String 监控项具体内容 0.1168 {item2} String 监控项具体内容 0.1168 ... String 监控项具体内容

。 3. 在左侧导航栏选择 模板管理。 4. 在模板管理页面，单击创建模板， 可参考创建模板完成模板配置。 5. 模板默认基于华南2资源池, 可以根据需要进行调整。 java terraform { requiredproviders { ctyun { source "ctyunit/ctyun" version "2.1.1" } } } provider "ctyun" { } variable "kafkaname" { type string description "kafka实例名称" default "demokafka" } variable "kafkatopicname" { type string description "topic名称" default "demotopic" } variable "kafkaconsumergroup" { type string description "消费组名称" default "democonsumers" } variable "kafkaspecname" { type string description "kafka实例的规格类型，可通过 default "kafka.2u4g.cluster" } variable "kafkadisktype" { type string description "磁盘类型，通常支持SAS、SSD、FASTSSD，规格支持的具体磁盘类型可使用ctyunkafkaspecs查看" default "SSD" } variable "kafkadisksize" { type number description "单个节点的磁盘存储空间，单位为GB" default 100 } variable "kafkanodenum" { type number description "节点数，也叫代理个数，单机版为1个，集群版3~50个" default 3 } variable "kafkatopicpartitionnum" { type number description "topic的分区数量" default 1 } resource "ctyunvpc" "vpctest" { name "vpcforkafka" cidr "192.168.0.0/16" } resource "ctyunsubnet" "subnettest" { vpcid ctyunvpc.vpctest.id name "subnetforkafka" cidr "192.168.1.0/24" dns [ "114.114.114.114", "8.8.8.8" ] } resource "ctyunsecuritygroup" "securitygrouptest" { vpcid ctyunvpc.vpctest.id name "sgforkafka" } data "ctyunzones" "test" { } resource "ctyunkafkainstance" "testkafkainstance" { instancename var.kafkaname engineversion "3.6" specname var.kafkaspecname nodenum var.kafkanodenum zonelist data.ctyunzones.test.zones disktype var.kafkadisktype disksize var.kafkadisksize vpcid ctyunvpc.vpctest.id subnetid ctyunsubnet.subnettest.id securitygroupid ctyunsecuritygroup.securitygrouptest.id cycletype "month" cyclecount 3 autorenew true autorenewcyclecount 1 } resource "ctyunkafkatopic" "testkafkatopic" { name var.kafkatopicname instanceid ctyunkafkainstance.testkafkainstance.id partitionnum var.kafkatopicpartitionnum } resource "ctyunkafkaconsumergroup" "testkafkaconsumergroup" { name var.kafkaconsumergroup instanceid ctyunkafkainstance.testkafkainstance.id description "测试消费组" } 6. 在资源栈管理中，选择刚才创建的模板，并填写参数触发资源栈的创建。可参考创建资源栈 7. 8. 9. 参考部署资源栈，完成资源栈部署。部署完成后，您可前往对应资源栈控制台查看资源的创建结果。 10.

协议服务提供标准 NFS 协议访问 HPFS 文件系统的能力,本文介绍创建协议服务的场景说明和操作步骤。 场景说明 当创建文件系统后，如您需要使用弹性云主机 ECS 或 CPU 物理机来挂载该文件系统，您需要创建协议服务，使用 VPC 或 VPCE 挂载地址挂载到云服务器上。 操作步骤 1. 登录天翼云控制中心，单击管理控制台左上角的，选择地域。 2. 选择“存储>并行文件服务 HPFS”，进入并行文件服务的控制台页面。 3. 点击目标文件系统，进入文件系统详情页，点击协议服务页签，即可进入协议服务页面。 4. 单击“创建协议服务”按钮，进入创建页面，根据需求及界面提示进行选择并点击创建： 参数 说明 文件系统 所属文件系统的 ID。 协议服务规格 只支持通用型。 协议类型 导出协议类型 NFS，默认支持 NFSv3 和 NFSv4。 注意 这里的协议类型选择，不影响文件系统本身协议类型为 HPFSPOSIX，相当于同时提供两种协议访问通道。 选择网络 选择协议服务使用的虚拟私有云（VPC），需要与要挂载的云服务器 VPC 网络相同，才能保证网络互通，实现文件的挂载访问。 创建后不可修改，若当前地域没有虚拟私有云，点击“创建虚拟私有云”，创建完成后刷新可选择新建的 VPC。 如您是在地域资源池使用，则还需选择 NFS 协议使用的子网（SUBNET）网络。 注意 一个文件系统可以创建多个协议服务； 同一个文件系统，创建的不同协议服务，不能绑定同一个 VPC； 不同的文件系统，创建的不同协议服务，可以绑定同一个 VPC。 终端节点 开启后本服务将为您创建免费的终端节点（VPCE），自动连接并行文件的协议服务。 创建 VPCE 后将返回该 VPC 专属的挂载地址，通常需要 1~3 分钟。如果您删除了终端节点，则 VPCE 的挂载地址将会失效。 开启终端节点后，需选择NFS协议使用的子网（SUBNET）网络，仅支持选择普通子网。 描述 协议服务的描述信息，可根据需求添加备注。 5. 协议服务为异步创建，创建完成后，可在协议服务列表页刷新，即可看到对应的协议服务信息。

本文介绍如何开启与查看云录制。 前提条件 已开通AOne会议免费版、标准版或者AOne会议旗舰版。 用户具备足够的云录制存储空间。 用户具备“主持人”或者“联席主持人”权限。 注意事项 云录制过程中若网络异常或会议被终止，可能影响录制文件完整性。 云录制文件归属于会议创建者，仅会议创建者可修改观看权限。 云录制文件默认观看范围为会议创建者与本企业的参会者。 跨企业参会人员默认无法观看，如需观看需要会议创建者将录制文件的分享方式修改为“通过链接分享”。 应用场景说明 适用于需要内容沉淀、会议复盘、重复学习的业务场景： 技术评审、产品复盘、专家讲座。 企业级培训、文化宣讲、客户答疑。 战略例会、决策类会议。 操作步骤 会中自动开启云录制（可选） 在“预定会议”设置中启用“自动开启云录制”，可选择“主持人入会后开启”或者“成员入会后开启”。 会中手动开启云录制（可选） 主持人/联席主持人进入参会页面，点击“云录制”按钮，开启云录制。 录制完成后查看 会议结束后，录制文件将在“录制”>“我的录制”或者“录制”>“我参会的录制”中生成会议录制信息。 支持修改分享方式，分享方式支持“指定用户分享”或者“通过链接分享”。 支持视频下载和删除、会议转写内容导出、观看链接复制。

VPC边界防火墙支持VPC之间通信流量的访问控制，实现内部业务互访活动的可视化与安全防护。 支持的防护对象 虚拟私有云（VPC） 虚拟网关（VGW） VPN网关（VPN） 企业连接网（ECN） 全球接入网关（DGW） 约束条件 仅“专业版”支持VPC边界防火墙。 依赖企业路由器（Enterprise Router, ER）服务引流。 仅支持防护当前账号所属企业项目下的VPC。 配置流程 企业路由器模式（新版）配置及使用流程： 操作步骤 操作说明 创建VPC边界防火墙 为VPC边界防火墙规划用于引流的网段。 说明 引流VPC不会创建在您的账号上，即不占用您的防护VPC个数。 配置企业路由器并将流量引至云防火墙 通过企业路由器连通VPC和云防火墙之间的流量。 为防护VPC添加连接，建立VPC与ER之间的网络互通。 在企业路由器中创建两个路由表作为关联路由表和传播路由表，将VPC和防火墙之间的流量互相传输。 为VPC添加一条指向企业路由器的路由。 开启/关闭VPC边界防火墙并确认流量经过云防火墙 开启VPC边界流量防护，并验证流量是否经过云防火墙。 VPC边界防护规则 通过防护规则放行/拦截流量（放行后的流量会经过入侵防御IPS、病毒防御等功能的检测）。 通过添加黑白名单拦截/放行流量 通过黑白名单放行/拦截流量（放行/拦截的流量，不再经过其它功能的检测）。 访问控制日志 查看防护策略是否生效。

接口功能介绍 获取接入点的资源权限详情 接口约束 无 URI POST /v1/applicationAccessPointManage/describeResourcePolicy 路径参数 无 Query参数 无 请求参数 请求头header参数 参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池id fecnjniakfkn2314ndekqldedcsadfg 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 applicationId 是 String 接入点id b2160c2c9c704ca9b8080d186c97280d 响应参数 参数 参数类型 说明 示例 下级对象 statusCode String 状态码 取值范围：200 成功 200 message String 提示信息 Success returnObj Object 返回数据结构体 returnObj error String 错误码 仅错误时返回 格式为{服务编码}.{错误编号} KMS.0269 表 returnObj 参数 参数类型 说明 示例 下级对象 requestId String 请求id 1d6d65ac761d4276ad0f1b94ef2ea29d cmkNum Integer 密钥数量 1 certNum Integer 证书数量 1 cmkList String of Array(Object) 密钥列表 cmkList certList Array of Objects 证书列表 certList 表 certList 参数 参数类型 说明 示例 下级对象 resourceId String 资源id fb65c5395e46493c9b814df1e80aa018 表 cmkList 参数 参数类型 说明 示例 下级对象 aliasName String 密钥别名 testcmk1 resourceId String 资源id fb65c5395e46493c9b814df1e80aa017

接口功能介绍 获取接入点的资源权限详情 接口约束 无 URI POST /v1/applicationAccessPointManage/describeResourcePolicy 路径参数 无 Query参数 无 请求参数 请求头header参数 参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池id fecnjniakfkn2314ndekqldedcsadfg 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 applicationId 是 String 接入点id b2160c2c9c704ca9b8080d186c97280d 响应参数 参数 参数类型 说明 示例 下级对象 statusCode String 状态码 取值范围：200 成功 200 message String 提示信息 Success returnObj Object 返回数据结构体 returnObj error String 错误码 仅错误时返回 格式为{服务编码}.{错误编号} KMS.0269 表 returnObj 参数 参数类型 说明 示例 下级对象 requestId String 请求id 1d6d65ac761d4276ad0f1b94ef2ea29d cmkNum Integer 密钥数量 1 certNum Integer 证书数量 1 cmkList String of Array(Object) 密钥列表 cmkList certList Array of Objects 证书列表 certList 表 certList 参数 参数类型 说明 示例 下级对象 resourceId String 资源id fb65c5395e46493c9b814df1e80aa018 表 cmkList 参数 参数类型 说明 示例 下级对象 aliasName String 密钥别名 testcmk1 resourceId String 资源id fb65c5395e46493c9b814df1e80aa017

接口功能介绍 解析IP或端口 接口约束 传参规范 URI GET /vfw/v2addresscontentresolve 路径参数 无 Query参数 参数 是否必填 参数类型 说明 示例 下级对象 groupId 是 Integer 地址簿id 10 addressType 是 String 地址簿类型v4;v6;port v4 contents 是 String ip/端口 ["1.1.1.1"] 请求参数 请求头header参数 参数 是否必填 参数类型 说明 示例 下级对象 urlType 是 String 请求地址类型 CTAPI regionId 是 String 资源池id 100054c0416811e9a6690242ac110002 请求体body参数 无 响应参数 参数 参数类型 说明 示例 下级对象 statusCode String 状态码 message String 返回信息 成功 error String 错误码：CFW0000 :成功!;CFW0001:参数错误！;CFW0002：业务错误！ CFW0000 returnObj Array of Objects 接口返回结果 GroupIp 表 GroupIp 参数 参数类型 说明 示例 下级对象 description String 地址簿描述 描述 content String ip/端口 v4

接口功能介绍 下载实例参数配置。 接口约束 URI GET /v1/params/downloadparam 请求参数 请求头header参数 参数 是否必填 参数类型 说明 示例 下级对象 请求体Query参数 参数 是否必填 参数类型 说明 示例 下级对象 prodInstId 是 Long 实例id 10 setName 是 String 实例参数配置名称 实例10的参数配置 响应参数 请求成功时，返回的是一个文件流，在浏览器可以直接下载 参数 参数类型 说明 示例 下级对象 statusCode Integer 状态码 810 message String 消息提示 请求失败 : 实例参数配置名称不能为空 returnObj Object 返回对象 请求示例 /v1/params/downloadparam?prodInstId10&setName实例10的参数配置 请求头header 请求体body 响应示例 json { "message": "请求失败 : 实例参数配置名称不能为空", "returnObj": {}, "statusCode": 810 } 错误码 访问ErrorCodes说明文档查看更多错误码。

响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 返回状态码（800为成功，900为失败） 800 errorCode String 错误码，为product.module.code三段式码 Openapi.PatternCheck.NotValid error String 错误码，为product.module.code三段式码 Openapi.PatternCheck.NotValid message String 英文描述信息 SUCCESS description String 中文描述信息 成功 returnObj Object 成功时返回的数据 returnObj 表 returnObj 参数 参数类型 说明 示例 下级对象 projectID String 企业项目ID 0 azName String 可用区名称 az1 attachedVolume Array of Strings 云硬盘ID列表 ["d36d47360724429eb7b6dca67a2a0ef5", "b484565cb5a04b3085cd3b674991aff0"] addresses Array of Objects 网络地址信息 addresses resourceID String 云主机资源ID cde530453f204f47bf32d12e62ef3b23 instanceID String 云主机ID c5a7966a88e7362b6e11c2d8fbfc07ca displayName String 云主机显示名称 apitest01 instanceName String 云主机名称 apitest01 osType Integer 操作系统类型，详见枚举值表格 5 instanceStatus String 云主机状态，请通过状态枚举值查看云主机使用状态 running expiredTime String 到期时间 20230419T09:37:53Z availableDay Integer 可用天数 120 updatedTime String 更新时间 20221019T09:37:53Z createdTime String 创建时间 20221019T09:37:53Z zabbixName String 监控对象名称 c5a7966a88e7362b6e11c2d8fbfc07ca secGroupList Array of Objects 安全组信息 secGroupList privateIP String 内网IPv4地址 192.168.1.104 privateIPv6 String 内网IPv6址 100:1:1ec:6600:fb6f:5428:c7e3:fa60 networkCardList Array of Objects 网卡信息 networkCardList vipInfoList Array of Objects 虚拟IP信息列表 vipInfoList vipCount Integer 虚拟IP数目 1 affinityGroup Object 云主机组信息 affinityGroup image Object 镜像信息 image flavor Object 云主机规格信息 flavor onDemand Boolean 付费方式，取值范围： true：表示按量付费， false：表示包周期 true vpcName String 虚拟私有云名称 vpctest3 vpcID String 虚拟私有云ID vpcjomc98yuqu fixedIPList Array of Strings 内网IP列表 ["192.168.1.104"] floatingIP String 公网IP 117.89.29.150 subnetIDList Array of Strings 子网ID列表 ["subnet7tk4rmsj4c"] keypairName String 密钥对名称 kptest2 表 addresses 参数 参数类型 说明 示例 下级对象 vpcName String vpc名称 vpctest3 addressList Array of Objects 网络地址列表 addressList 表 secGroupList 参数 参数类型 说明 示例 下级对象 securityGroupID String 安全组ID sgw3cn7d00a4 securityGroupName String 安全组名称 DefaultSecurityGr 表 networkCardList 参数 参数类型 说明 示例 下级对象 IPv4Address String IPv4地址 192.168.1.104 IPv6Address Array of Strings IPv6地址列表 ["100:1:1ec:6600:fb6f:5428:c7e3:fa60"] subnetID String 子网ID subnet0yy6yy2yyy subnetCidr String 子网网段信息 10.0.0.1/24 isMaster Boolean 是否主网卡，取值范围： true：主网卡， false：扩展网卡 true gateway String 网关地址 192.168.1.1 networkCardID String 网卡ID port10s1q9v9xf securityGroup Array of Strings 安全组ID列表 ["sgw3cn7d00a4"] 表 vipInfoList 参数 参数类型 说明 示例 下级对象 vipID String 虚拟IP的ID havip82g6jjhebo vipAddress String 虚拟IP地址 192.168.1.52 vipBindNicIP String 虚拟IP绑定的网卡对应IPv4地址 192.168.1.104 vipBindNicIPv6 String 虚拟IP绑定的网卡对应IPv6地址 100:1:1ec:6600:fb6f:5428:c7e3:fa60 nicID String 网卡ID port10s1q9v9xf 表 affinityGroup 参数 参数类型 说明 示例 下级对象 policy String 云主机组策略 softaffinity affinityGroupName String 云主机组名称 apitest01 affinityGroupID String 云主机组ID d1559aad39327dedcfa62871258b1bb5 表 image 参数 参数类型 说明 示例 下级对象 imageID String 镜像ID 4e5f72c9fa164ae6b60e11287edc934c imageName String 镜像名称 CentOS7.9 64位 表 flavor 参数 参数类型 说明 示例 下级对象 flavorID String 规格ID c5f17f9c5cfd9c8772dd152171c9002a flavorName String 规格名称 s7.medium.2 flavorCPU Integer VCPU 1 flavorRAM Integer 内存 2048 gpuType String GPU类型，取值范围：T4、V100、V100S、A10、A100、atlas 300i pro、mlu370s4，支持类型会随着功能升级增加 T4 gpuCount Integer GPU数目 1 gpuVendor String GPU名称 gpux videoMemSize Integer GPU显存大小 2 表 addressList 参数 参数类型 说明 示例 下级对象 addr String IP地址 192.168.1.104 version Integer IP版本 4 type String 网络类型，取值范围： fixed：内网， floating：公网 fixed

参数 详情 取值 enableresourcequota 创建namespace时是否自动创建resourcequota对象。 false：不自动创建resourcequota对象。 true：自动创建resourcequota对象。resourcequota的默认取值请参见设置资源配额及限制。 默认：false