接口描述 查询SQL洞察（SQL审计）文件列表 接口约束 无 URI GET /v1/collector/sqllogfiles 请求参数 请求体Query参数 参数 是否必填 参数类型 说明 示例 下级对象 prodInstId 是 Long 实例id 10 pageNum 是 Integer 页码最小值为1 1 pageSize 是 Integer 页大小取值范围为：1500 10 fileName 否 String 审计文件名称 postgresql20221026152843.csv 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 状态码 800 message String 消息提示 SUCCESS returnObj PageVO 返回对象 PageVO 参数 参数类型 说明 示例 下级对象 pageNum Integer 页码 1 pageSize Integer 页大小 10 pageTotal Integer 总页数 1 total Integer 总记录数 2 list List 记录 DescribeSQLLogFilesVO DescribeSQLLogFilesVO 参数 参数类型 说明 示例 下级对象 : fileName String 文件名称 postgresql20221101174412.csv logDownloadUrl String 下载地址 logSize String 日志文件大小，单位：byte 5438349 logTime Long 审计文件时间 1667297102000 sqlStartTime Long sql开始时间 1667296096000 sqlEndTime Long sql结束时间 1667297102000

本文介绍防盗链功能的使用场景和方式。 使用场景 一些不良网站为了扩充内容，不惜盗用其他网站的链接，以降低成本。这种行为不仅损害了原网站的合法利益，还加重了服务器的负担。为了解决这一问题，防盗链的技术应运而生。 在HTTP协议中，网站可以通过表头字段"Referer"来检测目标网页访问的来源网页。通过跟踪来源，网站可以采取技术手段进行处理，一旦检测到来源不是本站会进行阻止。防盗链是利用"Referer"设置，去检测请求来源的"Referer"字段信息是否与白名单或黑名单匹配。若与白名单匹配成功，则允许请求访问。否则阻止请求访问。 为了防止其他人在未授权的情况下盗用ZOS的数据，ZOS提供了一种基于HTTP请求头中referer字段的防盗链方法，支持访问白名单和访问黑名单的设置。 Referer规则 Referer可以设置多个，多个Referer换行隔开。 HTTP请求头中的Referer参数用于指定发出请求的资源的URL。该参数可以包含通配符（）和问号（?），通配符可以代替0个或多个字符，而问号可以代替单个字符。 下载文件时，如果Referer头域包含http或https，则必须将Referer设置包含http或https。 空Referer表示HTTP或HTTPS请求中，不带Referer字段或Referer字段为空。如果不允许空Referer，则只有HTTP或HTTPS header中包含Referer字段的请求才能访问ZOS资源。 白名单Referer为空，黑名单Referer不空时，允许所有黑名单中指定网站以外的其他网站的请求访问目标桶中的数据。若对象是私有，黑名单中指定网站以外的其他网站的请求访问时需校验AKSK，有权限的账号才能访问；若对象是公共读，则不校验AKSK权限。 白名单Referer不为空，黑名单Referer为空或不空时，允许在白名单且不在黑名单中的网站的请求访问目标桶中的数据。当请求来源是白名单referer，不管对象是私有还是公共读，无需校验AKSK就能访问。 同时配置白名单和黑名单，当白名单Referer与黑名单Referer内容有交集时，交集部分Referer被禁止。当请求是白名单中非交集的部分，不管对象是私有还是公共读，无需校验AKSK权限就能访问。 黑名单Referer与白名单Referer都为空时，默认允许所有网站的请求访问目标桶中的数据。若对象是私有，需校验AKSK，有权限的账号才能访问；若对象是公共读，则不校验AKSK权限。

请求参数 请求头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 参数 参数类型 说明 示例 下级对象 desktopOid String 云电脑ID XXXXXXXXXXXXX6925 desktopName String 云电脑名称 nickname String 云电脑别名 osType String 操作系统类型（Windows;Linux） status String 运行状态（Creating创建中;Stopped已关机;Starting启动中;Running运行中;Rebooting重启中;Rebuilding重装中;Stopping关闭中;Deleting删除中;Deleted已删除;Unhealthy异常;RollingBack回滚中;Resizing变更中;Evacuating迁移中;Rescuing救援中;BackingUp备份中;DeletingBackup删除备份中;Regaining恢复中;Hibernating休眠中;Hibernated已休眠;WakingUp唤醒中） flavorType String 规格类型。可能值：[Common通用型, GpuGPU型, Hpn高性能网络型, Kp鲲鹏, Hg海光]。 cpuArch String CPU架构。仅对XC型规格有意义。可能值：[arm, x86]。 processorType String 处理器类型。仅对XC型规格有意义。可能值： kp：鲲鹏。 hg：海光。 kp cpu Integer CPU个数 memory Integer 内存大小（单位：GB） gpuMemory Integer 显存大小（单位：GB）。仅对GPU规格云电脑有意义。 sysDisk Object 系统盘 sysDisk dataDisks Array of Objects 数据盘 dataDisks imageOid String 镜像ID templateOid String 规格模板ID osName String 操作系统名称 org Object 归属部门 org vpcOid String VPC ID vpcName String VPC名称 subnets Array of Objects 所在子网集合 subnets eipAddresses Array of Objects 弹性ip列表 eipAddresses pubUserOid String 分配用户ID（当且仅当用户与云电脑绑定成功时返回） userName String 分配用户名称（当且仅当用户与云电脑绑定成功时返回） chargeType String 计费方式。枚举值范围：[PrePaid包年包月, ResourcePack资源包] createTime String 创建时间。以ISO 8601为标准，并使用UTC+0时间，格式为yyyyMMddTHH:mm:ssZ。 expireTime String 到期时间。以ISO 8601为标准，并使用UTC+0时间，格式为yyyyMMddTHH:mm:ssZ。 表 sysDisk 参数 参数类型 说明 示例 下级对象 diskOid String 磁盘ID diskType String 磁盘类型（hio高IO（high IO）；uhio超高IO（ultrahigh IO） diskSize Integer 磁盘大小。单位：GB availableBytes String 磁盘剩余可用字节数。单位：B。注意：上报情况存在延迟，可能为空。 66666666666 diskUuid String 磁盘UUID 表 dataDisks 参数 参数类型 说明 示例 下级对象 diskOid String 磁盘ID diskType String 磁盘类型（hio高IO（high IO）；uhio超高IO（ultrahigh IO） diskSize Integer 磁盘大小。单位：GB availableBytes String 磁盘剩余可用字节数。单位：B。注意：上报情况存在延迟，可能为空。 66666666666 diskUuid String 磁盘UUID 表 org 参数 参数类型 说明 示例 下级对象 orgOid String 部门ID completeOrgName String 完整部门名称。由从根部门到当前部门的名称，以半角斜线号（/）为分隔符拼接而成。 表 subnets 参数 参数类型 说明 示例 下级对象 subnetOid String 子网ID privateIpAddresses Array of Objects 私有IP地址集合 privateIpAddresses 表 privateIpAddresses 参数 参数类型 说明 示例 下级对象 address String IP地址 portOid String 网卡ID isDefault Boolean 是否为默认网卡，true表示是，false表示否 表 eipAddresses 参数 参数类型 说明 示例 下级对象 eipOid String 弹性IP ID ipAddress String IP地址 privateIpAddress String 私有IP地址

参数 说明 可用区 可用区1 存储类型 SFS Turbo性能型 协议类型 NFS 选择网络 选择与弹性云主机相同VPC

。 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.

本章节主要介绍了SQL Server控制台创建数据库功能与说明。 创建数据库 1. 在天翼云官网首页的顶部菜单栏，选择【产品 > 数据库 > 关系型数据库 > 关系数据库SQL Server版】，进入关系数据库SQL Server产品页面。然后单击【管理控制台】，进入TeleDB数据库【概览】页面。 2. 在左侧导航栏，选择【SQL Server > 实例管理】，进入实例列表页面。然后在顶部菜单栏，选择区域和项目。 3. 在实例列表中，单击目标实例名称，进入实例【基本信息】页面。 4. 单击【数据库管理】，可以看到实例已创建的数据库列表。 5. 单击【创建数据库】，设置如下参数，然后单击【确定】。 参数 说明 数据库名称 1.名称长度为164个字符，由小大写字母、数字、下划线()或中划线()组成，以字母开头，字母或数字结尾 ； 2.数据库名称不能为rdsadmin、master、msdb、tempdb、model或resource字段（不区分大小写）。 支持字符集 数据库字符集，支持的字符集包括： 1.ChinesePRCCIAS； 2.ChinesePRCCSAS； 3.ChinesePRCCIAI； 4.SQLLatin1GeneralCP1CIAS； 5.ChinesePRC90CIAI； 6.CyrillicGeneralCIAS； 7.THAICIAS。

本章节主要介绍了SQL Server控制台重命名数据库功能与说明。 约束说明 1. 新数据库名称长度为164个字符，由小大写字母、数字、下划线()或中划线()组成，以字母开头，字母或数字结尾。 2. 新数据库名称不能为rdsadmin、master、msdb、tempdb、model或resource字段（不区分大小写）。 3. 新数据库名不能与原数据库名相同，且不能与已存在的数据库名相同。 4. 只有处于ONLINE状态的数据库才能重命名。 5. 如果是主备实例，只有已经构建主备关系且完成主备数据同步的数据库才能重命名。 操作步骤 1. 在天翼云官网首页的顶部菜单栏，选择【产品 > 数据库 > 关系型数据库 > 关系数据库SQL Server版】，进入关系数据库SQL Server产品页面。然后单击【管理控制台】，进入TeleDB数据库【概览】页面。 2. 在左侧导航栏，选择【SQL Server > 实例管理】，进入实例列表页面。然后在顶部菜单栏，选择区域和项目。 3. 在实例列表中，单击目标实例名称，进入实例【基本信息】页面。 4. 单击【数据库管理】，可以看到实例已创建的数据库列表。 5. 选择目标数据库，单击操作列的【修改数据库名】按钮。 6. 在弹出的输入框中，输入修改后的数据库名，单击【确定】。

本文主要介绍SQL Server实例的规格变更操作步骤。 前提条件 ● 实例状态为“运行中”。 注意 实例规格变更期间服务会短暂中断，建议在业务空闲时变更。 操作步骤 1. 在天翼云官网首页的顶部菜单栏，选择【产品 > 数据库 > 关系型数据库 > 关系数据库SQL Server版】，进入关系数据库SQL Server产品页面。然后单击【管理控制台】，进入TeleDB数据库【概览】页面。 2. 在左侧导航栏，选择【SQL Server > 实例管理】，进入实例列表页面。然后在顶部菜单栏，选择区域和项目。 3. 在实例列表中找到需要进行规格变更的目标实例，单击列表右侧的【更多】，单击【规格变更】选项。 4. 在【规格变更】页面，您可查看当前实例规格，选择所需的性能规格。如果选择更高的规格，确认无误后，单击【提交】并完成支付，即可进行规格扩容。如果选择更低的规格，确认无误后，单击【提交】并完成支付，即可进行规格降配。 5. 返回实例列表页面，根据您之前的选择，查看当前实例状态为【扩容中】或者【降配中】。 说明 ● SQL Server支持多种规格，您可以根据实际情况，合理选择所需的实例规格。 ● 一旦执行变更操作后不可撤销，如果需要修改，需要在当前变更操作结束后，重新提交变更操作。

本小节主要介绍RDSPostgreSQL实例清理在线表操作。 操作场景 RDSPostgreSQL支持为您的数据库实例清理指定数据库的在线表，来缩短新旧版本的年龄差值。 操作步骤 1. 登录天翼云门户。 2. 点击控制中心，进入控制中心后，选择目标资源池。 3. 在产品列表页面中找到【数据库】→【关系数据库PostgreSQL版】，点击进入控制台。 4. 在左侧菜单中点击【PostgreSQL】→【实例管理】，点击进入产品实例管理页。 5. 在【实例管理】的实例列表中选择目标实例，点击实例名称进入实例管理详情页。 6. 在二级菜单中选择"实例操作"页签，进入"实例操作"页面。 7. 在"实例操作"页面，操作类型选择"清理在线表"，数据库命令选项选择对应类型，数据库名选项请输入您需要清理的数据库名，表名选项请输入您要清理的数据库表名，事务id阈值选项，请输入您需要清理的事务id阈值。确认以上信息后，点击"执行"按钮。 8. 等待系统执行清理在线表操作后， 会出现相应的"操作结果"和"信息"提示。 注意 不同资源池因IaaS资源能力等原因，加载版本有所差异，详见

本文介绍RDSPostgreSQL如何创建手动备份。 操作场景 RDSPostgreSQL支持对运行正常的实例创建手动备份，在紧急情况下，需要立即进行备份可以通过手动备份。 注意 当数据库实例被删除时，RDSPostgreSQL实例的自动备份、增量备份、手动备份被同步删除。 操作方法 1. 登录天翼云官网。 2. 点击控制中心，进入控制中心后，选择目标资源池。 3. 在产品列表页面中找到【数据库】→【关系数据库PostgreSQL版】，点击进入控制台。 4. 在左侧菜单中点击【PostgreSQL】→【实例管理】，点击进入产品实例管理页。 5. 在【实例管理】的实例列表中选择目标实例，点击指定的实例，进入单个实例管理详情页。 6. 在详情页中点击备份恢复页签，进入备份恢复功能页，点击【创建备份】按钮。 7. 在弹出的页面中，填写备份名称，点击确定，提交创建备份任务，点击取消，放弃创建备份任务。 备份名称命名规则如下： 长度为1100个字符。 由数字、中文、英文、特殊字符组成。 描述限制如下： 长度限制1024个字符。 注意 不同资源池因IaaS资源能力等原因，加载版本有所差异，操作步骤有细微差异，请以实际界面为准，功能加载情况详见

本文介绍了修改实例端口功能。 操作场景 当用户根据业务需要需要对数据库访问端口进行修改时，可在RDSPostgreSQL界面中调整。 操作步骤 1. 登录天翼云门户。 2. 点击控制中心，进入控制中心后，选择目标资源池。 3. 在产品列表页面中找到【数据库】→【关系数据库PostgreSQL版】，点击进入控制台。 4. 在左侧菜单中点击【PostgreSQL】→【实例管理】，点击进入产品实例管理页。 5. 在【实例管理】的实例列表中选择目标实例，点击实例名称进入实例管理详情页。 6. 在数据库端口属性点击【修改】按钮进行操作。 约束限制及注意事项 仅Ⅱ类资源池支持修改实例端口。 端口可修改范围为[20006543]。 如实例有只读实例，只读实例端口也会被修改。 只读实例不支持单独修改访问端口。 修改实例端口会重启实例，且修改端口的实例需为运行中状态。 修改实例访问端口后，请及时修改安全组规则，否则可能无法通过新端口访问实例。 注意 不同资源池因iaas资源能力等原因，加载版本有所差异，详见

本小节主要介绍设置RDSPostgreSQL实例的可维护时间段。 操作场景 您可根据实际的业务时间，设置实例的可维护时间。建议把可维护时间设置在您的业务低峰期，避免维护过程中影响您的业务使用。 注意 在实际的实例维护期间，实例状态会变更为"实例维护中"，一般不影响您的数据库业务。 操作步骤 1. 登录天翼云门户。 2. 点击控制中心，进入控制中心后，选择目标资源池。 3. 在产品列表页面中找到【数据库】→【关系数据库PostgreSQL版】，点击进入控制台。 4. 在左侧菜单中点击【PostgreSQL】→【实例管理】，点击进入产品实例管理页。 5. 在【实例管理】的实例列表中选择目标实例，点击指定的实例，进入单个实例管理详情页。 6. 在单个实例管理页面的"基本信息"中，点击"可维护时间段"的"修改"选项。 7. 在时间段选择上，选择您想要设置的时间段，并点击"确定"。 8. 等待系统更新完您实例的可维护时间后，刷新当前页面，在"实例详情"页查看修改后的"可维护时间段"。 注意 不同资源池因iaas资源能力等原因，加载版本有所差异，详见

接口功能介绍 批量休眠云电脑，前提条件：云电脑处于运行中状态。 接口约束 无 URI POST /v3/desktop/batch/suspend 路径参数 无 Query参数 参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池ID。 xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx 请求参数 请求头header参数 无 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 desktopList 是 Array of Objects 云电脑列表，可设置一个或多个，最多 10 个 desktopList 表 desktopList 参数 是否必填 参数类型 说明 示例 下级对象 desktopOid 是 String 云电脑ID XXXXXXXXXXXXX6925 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 状态码。可能值： 800：请求成功。 900：请求失败。 800 error String 错误码。 ECPC1000 message String 提示信息。 OK. returnObj Object 返回数据结构体。 returnObj 枚举参数 无 请求示例 请求url 请求头header 无 请求体body { "desktopList":[{ "desktopOid":"XXXXXXXXXXXXX6925" }] }

接口功能介绍 修改弹性IP带宽v3 接口约束 无 URI POST /v3/fip/update 路径参数 无 Query参数 参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池ID。 xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx 请求参数 请求头header参数 无 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 resourcePackOid 是 String 资源包ID fipOid 是 String 弹性IP ID band 是 Object 带宽信息 band 表 band 参数 是否必填 参数类型 说明 示例 下级对象 bandWidth 是 String 带宽，单位：MBps 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 状态码。可能值： 800：请求成功。 900：请求失败。 800 error String 错误码。 ECPC1000 message String 提示信息。 OK. returnObj Object 返回数据结构体。 returnObj 枚举参数 无 请求示例 请求url 无 请求头header 无 请求体body { "resourcePackOid":"rsp3uyckx0nxry4rp3j3482e", "fipOid":"fipuwkwlhv456djds6upt0fy", "band":{ "bandWidth":5 } }

接口功能介绍 批量唤醒云电脑，前提条件：云电脑处于休眠状态。 接口约束 无 URI POST /v3/desktop/batch/resume 路径参数 无 Query参数 参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池ID。 xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx 请求参数 请求头header参数 无 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 desktopList 是 Array of Objects 云电脑列表，可设置一个或多个，最多 10 个 desktopList 表 desktopList 参数 是否必填 参数类型 说明 示例 下级对象 desktopOid 是 String 云电脑ID XXXXXXXXXXXXX6925 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 状态码。可能值： 800：请求成功。 900：请求失败。 800 error String 错误码。 ECPC1000 message String 提示信息。 OK. returnObj Object 返回数据结构体。 returnObj 枚举参数 无 请求示例 请求url 请求头header 无 请求体body { "desktopList":[{ "desktopOid":"XXXXXXXXXXXXX6925" }] }

接口功能介绍 校验cidr是否合法 接口约束 传参规范 URI GET /vfw/v2checkcidr 路径参数 无 Query参数 参数 是否必填 参数类型 说明 示例 下级对象 cidr 是 String cidr 192.168.1.0/24 vpcId 是 String vpc id vpc123 请求参数 请求头header参数 参数 是否必填 参数类型 说明 示例 下级对象 urlType 是 String 请求地址类型 CTAPI regionId 是 String 资源池id 100054c0416811e9a6690242ac110002 请求体body参数 无 响应参数 参数 参数类型 说明 示例 下级对象 statusCode String 状态码 message String 返回信息 成功 error String 错误码：CFW0000 :成功!;CFW0001:参数错误！;CFW0002：业务错误！ CFW0000 returnObj Object 接口返回结果 CanDowngradeVo 表 CanDowngradeVo 参数 参数类型 说明 示例 下级对象 result Boolean 结果 error String 错误信息 成功 枚举参数 无 请求示例 请求url 无 请求头header { "regionid": "100054c0416811e9a6690242ac110002", "urlType": "CTAPI" } 请求体body {}

接口功能介绍 防火墙能否降低版本 接口约束 传参规范 URI GET /vfw/v2candowngrade 路径参数 无 Query参数 参数 是否必填 参数类型 说明 示例 下级对象 masterResourceId 是 String 主订单id 3a81fa31d70d46769fb081e50af 请求参数 请求头header参数 参数 是否必填 参数类型 说明 示例 下级对象 urlType 是 String 请求地址类型 CTAPI regionId 是 String 资源池id 100054c0416811e9a6690242ac110002 请求体body参数 无 响应参数 参数 参数类型 说明 示例 下级对象 statusCode String 状态码 message String 返回信息 成功 error String 错误码：CFW0000 :成功!;CFW0001:参数错误！;CFW0002：业务错误！ CFW0000 returnObj Object 接口返回结果 CanDowngradeVo 表 CanDowngradeVo 参数 参数类型 说明 示例 下级对象 result Boolean 能否订购 error String 原因 枚举参数 无 请求示例 请求url 无 请求头header { "regionid": "100054c0416811e9a6690242ac110002", "urlType": "CTAPI" } 请求体body {}

接口功能介绍 查询访问云电脑的IP和MAC限制 接口约束 无 URI GET /v3/desktop/getAccessIpAndMac 路径参数 无 Query参数 参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池ID。 d8bbd132b53a11e9b0e40242ac110002 desktopOid 是 String 云电脑ID D0023092101180485 请求参数 请求头header参数 无 请求体body参数 无 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 状态码。可能值： 800：请求成功。 900：请求失败。 800 error String 错误码。 message String 提示信息。 OK. returnObj Object 返回数据对象 { } returnObj 表 returnObj 参数 参数类型 说明 示例 下级对象 externalIpListString String 外网IP地址 ipListString String 客户端IP地址 macListString String MAC地址 hardwareCodeListString String 设备唯一码 routerMacListString String 限制路由器MAC地址 枚举参数 无 请求示例 请求url 无 请求头header 无 请求体body 无 响应示例 {"statusCode":800,"message":"OK.","returnObj":{"externalIpListString":"123.123.123.123"}}

接口功能介绍 查询弹性伸缩组设备的实时监控数据。 接口约束 regionID（资源池）存在，且存在弹性伸缩组设备。 URI POST /v4/monitor/queryscalinglatestmetricdata 请求参数 请求体body参数 参数 参数类型 是否必填 示例 说明 下级对象 regionID String 是 81f7728662dd11ec810800155d307d5b 资源池ID deviceUUIDList Array of String 是 ["scalb474007ec035455bbc683ed6c431bc431992"] 查询设备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 获取对象数据条数 2 totalPage Integer 总页数 1 currentCount Integer 当前页记录数 2 page Integer 页码，建议参考请求参数pageNo，该参数后续会下线 1 pageSize Integer 页大小，建议参考请求参数pageSize，该参数后续会下线 10 表result 参数 参数类型 说明 示例 下级对象 regionID String 所属资源池ID 81f7728662dd11ec810800155d307d5b fUID String 唯一键 scalb474007ec035455bbc683ed6c431bc431992 fuserLastUpdated String 最近更新时间 20221107 18:25:12 deviceUUID String 设备ID scalb474007ec035455bbc683ed6c431bc431992 itemList Object 监控项内容 itemList 表itemList 参数 参数类型 说明 示例 下级对象 samplingTime Integer 监控数据采集时间 1667816712 {item1} String 监控项具体内容 0.1168 {item2} String 监控项具体内容 0.1168 ... String 监控项具体内容

接口功能介绍 查询云磁盘设备的实时监控数据。 接口约束 regionID（资源池）存在，且存在云磁盘设备。 URI POST /v4/monitor/querydisklatestmetricdata 请求参数 请求体body参数 参数 参数类型 是否必填 示例 说明 下级对象 regionID String 是 73f321ea62ff11eca8bc005056898fe0 资源池ID deviceUUIDList Array of String 是 ["02a168a3263144deb"] 查询设备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 73f321ea62ff11eca8bc005056898fe0 fUID String 唯一键 02a168a3263144deb fuserLastUpdated String 最近更新时间 20221107 18:25:12 deviceUUID String 设备ID 02a168a3263144deb itemList Object 监控项内容 itemList 表itemList 参数 参数类型 说明 示例 下级对象 samplingTime Integer 监控数据采集时间 1667816712 {item1} String 监控项具体内容 0.1168 {item2} String 监控项具体内容 0.1168 ... String 监控项具体内容

接口功能介绍 查询云主机设备的实时监控数据。 接口约束 regionID（资源池）存在，且存在云主机设备。 URI POST /v4/monitor/queryvmlatestmetricdata 请求参数 请求体body参数 参数 参数类型 是否必填 示例 说明 下级对象 regionID String 是 81f7728662dd11ec810800155d307d5b 资源池ID deviceUUIDList Array of String 是 ["000f03221f4d8cc8bb2e1c30fb751aa5"] 查询设备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 唯一键 3c7b4997ca5148858e530d1a2b37ccc0 fuserLastUpdated String 最近更新时间 20221107 18:25:12 deviceUUID String 设备ID 3c7b4997ca5148858e530d1a2b37ccc0 itemList Object 监控项内容 itemList 表itemList 参数 参数类型 说明 示例 下级对象 samplingTime Integer 监控数据采集时间 1667816712 {item1} String 监控项具体内容 0.1168 {item2} String 监控项具体内容 0.1168 ... String 监控项具体内容

参数 参数类型 说明 示例 下级对象 statusCode Integer 状态码 800 message String 消息提示 SUCCESS returnObj Array 返回对象 PgHbaHistory表

响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 返回状态码（800为成功，900为失败），默认值：800 800 errorCode String 失败时的错误代码，参见公共错误码说明 message String 失败时的错误描述，一般为英文描述 Success msgDesc String 失败时的错误描述，一般为中文描述 成功 error String 错误码，请求成功时，不返回该字段 Openapi.Parameter.Error returnObj Object 返回对象 returnObj 表 returnObj 参数 参数类型 说明 示例 下级对象 itemList Array of Objects 监控项数据 itemList 表 itemList 参数 参数类型 说明 示例 下级对象 itemName String 监控项名称 cpuutil itemDesc String 监控项中文介绍 CPU使用率 itemUnit String 监控项单位 bit/s value Double 监控项值，具体请参考对应监控项文档 0.2169 timestamp Long 监控数据采样Unix时间戳 1667816712 dimensions Array of Objects 监控项标签 dimension unitRelations Array of Objects 单位转换字典 unitRelation 表 dimension 参数 参数类型 说明 示例 下级对象 name String 监控项标签键 uuid value String 监控项标签键对应的值 9dc489794e1945e2b5235d3c70d516b3 表 unitRelation 参数 参数类型 说明 示例 下级对象 unit String 单位 % weight Double 权重 1

接口功能介绍 查询密钥别名 接口约束 请保证账户余额大于0 URI POST /v1/keyName/listAlias 路径参数 无 Query参数 无 请求参数 请求头header参数 参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池id fecnjniakfkn2314ndekqldedcsadfg 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 pageNumber 是 String 页数 1 pageSize 是 String 每页展示的别名数量 10 instanceId 否 String 实例Id，非必传，当为空时列出所有别名，不为空时列出指定实例下的别名 insX63C8r 响应参数 参数 参数类型 说明 示例 下级对象 statusCode String 返回码 取值范围：200 成功 200 error String 错误码 KMS0514 message String 调用结果信息 查询成功 returnObj Object 接口返回结果 returnObj 表 returnObj 参数 参数类型 说明 示例 下级对象 totalCount String 别名总数 100 requestId String 请求id 1d6d65ac761d4276ad0f1b94ef2ea29d pageSize String 每页展示的别名数量 10 pageNumber String 页数 1 aliases String 别名信息 aliases 表 aliases 参数 参数类型 说明 示例 下级对象 alias Array of Strings 别名信息 aliasList 表 aliasList 参数 参数类型 说明 示例 下级对象 aliasName String 别名 addqweqwsd cmkUuid String 密钥id 00f57b8191d54b6590076195528f8a37

接口功能介绍 通过密钥id查询别名 接口约束 请保证账户余额大于0 URI POST /v1/keyName/listAliasByUuid 路径参数 无 Query参数 无 请求参数 请求头header参数 参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池id fecnjniakfkn2314ndekqldedcsadfg 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 cmkUuid 是 String 主密钥加密的数据密钥密文 474e569e8814474a948bdbcf6d853eff pageNumber 是 String 页数 1 pageSize 是 String 每页展示的别名数量 10 响应参数 参数 参数类型 说明 示例 下级对象 statusCode String 返回码 取值范围：200 成功 200 error String 错误码 KMS0514 message String 调用结果信息 查询成功 returnObj Object 接口返回结果 returnObj 表 returnObj 参数 参数类型 说明 示例 下级对象 totalCount String 别名总数 100 requestId String 请求id cb3deacae51e489ab7d1ed361bd62292 pageSize String 每页展示的别名数量 10 pageNumber String 页数 1 aliases Array of Strings 别名信息 aliases 表 aliases 参数 参数类型 说明 示例 下级对象 alias Array of Objects 别名信息 aliasList 表 aliasList 参数 参数类型 说明 示例 下级对象 aliasName String 别名 addqweqwsd cmkUuid String 密钥id 00f57b8191d54b6590076195528f8a37

接口功能介绍 通过密钥id查询别名 接口约束 请保证账户余额大于0 URI POST /v1/keyName/listAliasByUuid 路径参数 无 Query参数 无 请求参数 请求头header参数 参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池id fecnjniakfkn2314ndekqldedcsadfg 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 cmkUuid 是 String 主密钥加密的数据密钥密文 474e569e8814474a948bdbcf6d853eff pageNumber 是 String 页数 1 pageSize 是 String 每页展示的别名数量 10 响应参数 参数 参数类型 说明 示例 下级对象 statusCode String 返回码 取值范围：200 成功 200 error String 错误码 KMS0514 message String 调用结果信息 查询成功 returnObj Object 接口返回结果 returnObj 表 returnObj 参数 参数类型 说明 示例 下级对象 totalCount String 别名总数 100 requestId String 请求id cb3deacae51e489ab7d1ed361bd62292 pageSize String 每页展示的别名数量 10 pageNumber String 页数 1 aliases Array of Strings 别名信息 aliases 表 aliases 参数 参数类型 说明 示例 下级对象 alias Array of Objects 别名信息 aliasList 表 aliasList 参数 参数类型 说明 示例 下级对象 aliasName String 别名 addqweqwsd cmkUuid String 密钥id 00f57b8191d54b6590076195528f8a37

响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 返回状态码（800为成功，900为失败），默认值：800 800 errorCode String 失败时的错误代码，参见公共错误码说明 message String 失败时的错误描述，一般为英文描述 Success msgDesc String 失败时的错误描述，一般为中文描述 成功 error String 错误码，请求成功时，不返回该字段 Openapi.Parameter.Error returnObj Object 返回对象 returnObj 表 returnObj 参数 参数类型 说明 示例 下级对象 itemList Array of Objects 监控项列表 item 表 item 参数 参数类型 说明 示例 下级对象 itemName String 监控项名称 cpuutil itemDesc String 监控项中文介绍 CPU使用率 itemUnit String 监控项单位 bit/s itemData Array of Objects 监控项内容 itemData dimensions Array of Objects 监控项标签 dimension 表 itemData 参数 参数类型 说明 示例 下级对象 value Float 监控项值，具体请参考对应监控项文档 524288 timestamp Integer 监控数据Unix时间戳 1667815639 表 dimension 参数 参数类型 说明 示例 下级对象 name String 监控项标签键 uuid value String 监控项标签键对应的值 9dc489794e1945e2b5235d3c70d516b3

添加审核人 在数据架构中，数据建模流程中的步骤都需要经过审批，因此，需要先添加审核人。DAYU Administrator角色或该工作空间管理员，具备对应的添加审核人的权限。 1. 在DataArts Studio控制台首页，选择实例，点击“进入控制台”，选择对应工作空间的“数据架构”模块，进入数据架构页面。 2. 单击左侧导航树中的“配置中心”，进入相应页面后，在“审核人管理”页签，单击“添加”按钮。 3. 选择审核人（工作空间管理员或开发者），输入正确的电子邮箱和手机号，单击“确定”完成审核人添加。 您也可以添加自己当前帐号为审核人，在后续提交审批的相关操作中，支持进行“自助审批”。根据需要，可以添加多个审核人。 管理配置中心 数据架构中提供了丰富的自定义选项，统一通过配置中心提供，您可有根据自己的业务需要进行自定义配置。 1. 在数据架构控制台，单击左侧菜单栏的“配置中心”，进入配置中心页面。 2. 进入“功能配置”页签，按照您的需求，进行自定义设置。 3. 单击“确定”完成配置。 主题设计 在本示例中，主题设计如表所示，说明如下： 新建1个主题域分组：城市交通。 在主题域分组“城市交通”下，新建4个主题域：行程记录、集团、时空、公共维度。 在主题域“行程记录”下，新建4个业务对象：原始记录、标准记录、行程事实、记录统计。 在主题域“集团”下，新建1个业务对象：供应商。 在主题域“时空”下，新建1个业务对象：时间。 在主题域“公共维度”下，新建1个业务对象：公共维度。 下表为主题设计信息 主题域分组名称（L1） 主题域分组编码（L1） 主题域名称（L2） 主题域编码（L2） 业务对象名称（L3） 业务对象编码（L3） 城市交通 citytraffic 行程记录 strokereminder 原始记录 originstroke 城市交通 citytraffic 行程记录 strokereminder 标准记录 standstroke 城市交通 citytraffic 行程记录 strokereminder 行程事实 strokefact 城市交通 citytraffic 行程记录 strokereminder 记录统计 strokestatistic 城市交通 citytraffic 集团 people 供应商 vendor 城市交通 citytraffic 时空 timelocation 时间 date 城市交通 citytraffic 公共维度 publicdimension 公共维度 publicdimension 操作步骤如下： 1. 登录DataArts Studio控制台。找到已创建的DataArts Studio实例，单击实例卡片上的“进入控制台”。 2. 在工作空间概览列表中，找到所需要的工作空间，单击“数据架构”，进入数据架构控制台。 3. 在数据架构控制台，单击左侧菜单栏的“配置中心”。选择“ 主题层级”，使用默认的3层层级。 L1L7表示主题层级，默认3层，最大7层，最少2层，最后一层是业务对象，其他层级名称可编辑修改。配置中心配置的层级数，将在“主题设计”模块生效。 4. 在数据架构控制台，单击左侧菜单栏的“主题设计”，进入相应页面后，单击“新建”创建L1层主题，即主题域分组。 在弹出窗口中，按图所示填写参数，然后单击“确定”完成主题域分组的创建。 5. 在L1层主题“城市交通”下，依次新建4个L2层主题，即主题域：行程记录、集团、时空、公共维度。 以主题域“行程记录”为例，新建主题域的步骤如下，其他主题域也请参照以下步骤进行添加： a.选中已创建的L1层主题“城市交通”。单击右键，选择“新建”。或者单击右侧的“新建”按钮。 b.在弹出窗口中，“名称”和“编码”请参照上方 主题设计信息 表中的“主题域名称”和“主题域编码”进行填写，其他参数可根据实际情况进行填写，配置完成后单击“确定”完成主题域的新建。 6. 新建业务对象。 在主题域“行程记录”下，新建4个业务对象：原始记录、标准记录、行程事实、记录统计。 在主题域“集团”下，新建1个业务对象：供应商。 在主题域“时空”下，新建1个业务对象：时间。 在主题域“公共维度”下，新建1个业务对象：公共维度。 以在主题域“行程记录”下新建业务对象“原始记录”为例，新建业务对象的步骤如下，其他业务对象也请参照以下步骤进行添加： a.选中已创建的L2层主题“行程记录”。单击右键，选择“新建”。或者单击右侧的“新建”按钮。 b.在弹出窗口中，“名称”和“编码”请参照上方 主题设计信息 表中的“业务对象名称”和“业务对象编码”进行填写，其他参数可根据实际情况进行填写，配置完成后单击“确定”完成业务对象新建。

接口功能介绍 切换文档数据库集群实例中的主备节点 接口约束 实例运行正常 URI POST /DDS2/v2/openApi/switchoverInstHA 路径参数 无 Query参数 无 请求参数 请求头header参数 参数 是否必填 参数类型 说明 示例 下级对象 projectid 否 String 项目id 0 regionId 是 String 资源池id bb9fdb42056f11eda1610242ac110002 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 prodInstId 是 String 文档数据库对外的实例标识，需为副本集或者分片集群实例 60d420bffb394 resId 是 String 机器id 14258 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 响应码 取值范围：800为成功，900为失败 800 message String 响应信息 切换文档数据库实例中的主备节点成功 returnObj Object 返回对象 returnObj error String 错误码。当接口失败时才返回具体错误编码，成功不返回或者为空。 表 returnObj 参数 参数类型 说明 示例 下级对象 taskId String 任务id信息 16

接口功能介绍 云硬盘快照功能请联系客户经理开通。 接口约束 无 URI GET /v3/cloudVolumeSnapshot/describe 路径参数 无 Query参数 参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池ID。 xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx volumeOid 否 String 关联的云硬盘ID status 否 String 云硬盘快照状态（CREATING创建中;AVAILABLE可用;CREATEVOLUMEING创建云盘中;REVERTING回滚中;DELETING删除中） pageNum 否 Integer 页码，至少1，默认1 pageSize 否 Integer 每页数量，最大100，默认10 请求参数 请求头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 参数 参数类型 说明 示例 下级对象 snapshotOid String 云硬盘快照ID XXXXXXXXXXXXX snapshotName String 云硬盘快照名称 volumeOid String 关联的云硬盘ID status String 云硬盘快照状态（CREATING创建中;AVAILABLE可用;CREATEVOLUMEING创建云盘中;REVERTING回滚中;DELETING删除中） createTime String 创建时间。以ISO 8601为标准，并使用UTC+0时间，格式为yyyyMMddTHH:mm:ssZ。

事件监控 事件监控：获取服务维度信息 接口功能介绍 获取资源池下服务维度信息。 接口约束 资源池ID不能为空。 URI GET /v4/monitor/events/queryservices 路径参数 无 Query参数 参数 是否必填 参数类型 说明 示例 下级对象 regionID 是 String 资源池ID 81f7728662dd11ec810800155d307d5b service 否 String 服务 ecs monitorType 否 String 用于选择监控类型，如果为event则表示事件类型 event 请求参数 请求头header参数 无 请求体body参数 无 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 返回状态码（800为成功，900为失败），默认值：800 800 errorCode String 失败时的错误代码，参见公共错误码说明 message String 失败时的错误描述，一般为英文描述 Success msgDesc String 失败时的错误描述，一般为中文描述 成功 error String 错误码，请求成功时，不返回该字段 Openapi.Parameter.Error returnObj Object 返回对象 returnObj 表 returnObj 参数 参数类型 说明 示例 下级对象 services Array of Objects 服务列表 serviceObj 表 serviceObj 参数 参数类型 说明 示例 下级对象 service String 服务 ecs description String 描述 云主机 dimensions Array of Objects 维度列表 dimensionObj 表 dimensionObj 参数 参数类型 说明 示例 下级对象 dimension String 维度 ecs description String 描述 云主机

本页介绍天翼云TeleDB数据库存储过程执行的语法。 不带参数 plaintext teledb create or replace procedure pnopara() as $$ begin raise notice 'nopara procedure'; end; $$ language plpgsql; CREATE PROCEDURE teledb call pnopara(); NOTICE: nopara procedure CALL teledb 带参数 plaintext teledb create or replace procedure ppara(aint integer) as $$ begin raise notice 'aint %',aint; end; $$ language plpgsql; CREATE PROCEDURE teledb call ppara(1); NOTICE: aint 1 CALL teledb