华为云用户手册

API概览 文档数据库服务所提供的接口为扩展接口。通过使用文档数据库服务接口，您可以使用文档数据库服务的部分功能，具体如下表所示。 表1 接口说明 类型 描述 查询API版本 包括查询API版本信息列表、查询指定API版本信息接口。 查询数据库版本信息 查询指定实例类型的数据库版本信息。 查询数据库规格 查询指定条件下的所有实例规格信息。 查询数据库磁盘类型 查询当前区域下的数据库磁盘类型。 实例管理 包括创建实例、重启实例、删除实例、查询实例列表、扩容实例存储容量、扩容集群实例的节点数量、变更实例规格、切换副本集实例的主备节点、切换SSL开关、修改实例名称、修改数据库端口、变更实例安全组、绑定弹性公网IP、解绑弹性公网IP、修改实例内网地址、打开集群的Shard/Config IP开关接口、副本集跨网段访问配置、查询实例可迁移到的可用区、实例可用区迁移。 连接管理 包括查询实例节点会话、终结实例节点会话、查询实例节点连接数统计接口。 备份与恢复 包括创建手动备份、删除手动备份、查询备份列表、查询自动备份策略、设置自动备份策略、恢复到新实例、获取备份下载链接、查询可恢复的时间段、获取可恢复的数据库列表、获取可恢复的数据库集合列表、获取到当前实例、库表级时间点恢复接口。 参数配置 包括获取参数模板列表、创建参数模板、删除参数模板、获取参数模板的详情、修改参数模板、应用参数模板、获取指定实例的参数信息、修改指定实例的参数接口。 获取日志信息 包括查询数据库慢日志、获取慢日志下载链接、查询数据库错误日志、获取错误日志下载链接、设置审计日志策略、查询审计日志策略、获取审计日志列表、获取审计日志下载链接接口。 标签管理 包括查询资源实例、批量添加或删除资源标签、查询资源标签、查询项目标签接口。 管理数据库和用户 包括创建数据库用户、创建数据库角色、查询数据库用户列表、查询数据库角色列表、修改数据库用户密码、检查数据库密码接口、查询集群均衡设置、设置集群均衡开关、设置集群均衡活动时间窗、删除数据库用户、删除数据库角色。 配额管理 查询单租户在DDS服务下的资源配额，包括集群实例配额、单节点实例配额和副本集实例配额。 任务管理 获取DDS任务中心指定ID的任务信息。

基本概念 账号 用户注册时的账号，账号对其所拥有的资源及云服务具有完全的访问权限，可以重置用户密码、分配用户权限等。由于账号是付费主体，为了确保账号安全，建议您不要直接使用账号进行日常管理工作，而是创建用户并使用他们进行日常管理工作。 用户 由账号在 IAM 中创建的用户，是云服务的使用人员，具有身份凭证（密码和访问密钥）。 在我的凭证下，您可以查看账号ID和用户ID。通常在调用API的鉴权过程中，您需要用到账号、用户和密码等信息。 区域 指云资源所在的物理位置，同一区域内可用区间内网互通，不同区域间内网不互通。通过在不同地区创建云资源，可以将应用程序设计的更接近特定客户的要求，或满足不同地区的法律或其他要求。 可用区 一个可用区是一个或多个物理数据中心的集合，有独立的风火水电，AZ内逻辑上再将计算、网络、存储等资源划分成多个集群。一个Region中的多个AZ间通过高速光纤相连，以满足用户跨AZ构建高可用性系统的需求。 项目 区域默认对应一个项目，这个项目由系统预置，用来隔离物理区域间的资源（计算资源、存储资源和网络资源），以默认项目为单位进行授权，用户可以访问您账号中该区域的所有资源。如果您希望进行更加精细的权限控制，可以在区域默认的项目中创建子项目，并在子项目中购买资源，然后以子项目为单位进行授权，使得用户仅能访问特定子项目中资源，使得资源的权限控制更加精确。 图1 项目隔离模型 企业项目 企业项目是项目的升级版，针对企业不同项目间资源的分组和管理，是逻辑隔离。企业项目中可以包含多个区域的资源，且项目中的资源可以迁入迁出。 关于企业项目ID的获取及企业项目特性的详细信息，请参见《企业管理服务用户指南》。 父主题： 使用前必读

API概况 消息&短信服务所提供的接口，根据不同的API调用方式分为应用、签名、模板API和发送接收短信API。 表1 接口说明 类型 子类型 说明 应用、签名、模板API 短信应用API 可以实现查询短信应用、创建短信应用、查询应用数量、获取应用详情、修改短信应用等操作。 短信签名API 可以实现查询签名信息、创建短信签名、获取签名详情、修改短信签名、删除短信签名、申请激活签名、查询申请文件、上传申请文件等操作。 短信模板API 可以实现查询发送国家、查询短信模板、创建短信模板、获取模板详情、修改短信模板、删除短信模板、查询模板变量等操作。 发送接收短信API 发送短信API 向单个或多个用户发送相同内容的短信。 发送分批短信API 向多个用户发送不同内容的短信。 接收状态报告API 用于接收短信发送状态报告。 接收上行短信API 用于接收用户回复的短信。 如有任何疑问，请联系华为云智能客服，将有专人为您解答。

功能 成本中心是华为云免费向用户提供的 云财务管理 服务，可帮助您收集华为云成本和使用量的相关信息、探索和分析华为云成本使用情况、监控和跟踪华为云成本，及时了解云支出的趋势和动因，减少异常支出，持续成本优化。 目前，成本中心提供的主要工具如下。 分类 工具 描述 功能点 成本计划与规划 成本与使用量预测 运用一定的科学方法，基于用户在华为云上的历史成本和历史用量情况，对未来的成本和用量进行预测。 预测机制 预算管理 您可以设置预算来跟踪您的成本和使用量，并在成本或使用量超过您设置的提醒条件时收到提醒通知。 新建预算 预算报告 您可以创建“预算报告”来定期跟踪预算执行情况。 预算报告 成本管理与控制 IAM 您可以使用IAM对成本中心进行精细的权限管理，以达到不同员工之间的权限隔离。 权限管理 账单 账单是用户在华为云消费的汇总或明细数据，真实的反映了用户的历史消费记录，供用户对账使用。 费用账单 预算提醒 当实际成本或使用量达到提醒阈值时，系统会通过短信、邮件形式发送预警提醒。 新建预算 成本监控 成本中心可以监控您按需资源的成本情况，以检测异常成本，减少不必要的支出。 异常成本监控 成本组织与报告 成本分析 以图表形式提供可视化的成本数据，您可以跨多个账期查看您的成本和使用量趋势，并按照产品类型、区域、关联账号、计费模式、成本标签等维度汇总和过滤图表。 查看成本分析数据 分析报告 您可以将成本分析结果保存为分析报告在账号内分享，“分析报告”中还预置了常见的分析报告，您可以直接使用。 分析报告 成本明细 成本中心提供摊销成本的月度明细数据导出。 导出成本明细数据 成本标签 您在使用标签标识和管理资源的同时，还可以将标签激活为成本标签来归集成本。成本标签可以应用在成本分析和预算管理中。 成本标签介绍|激活成本标签 成本单元 成本单元是一种基于规则引擎自动归集用户成本的工具。用户可以根据关联账号、产品类型、账单类型、成本标签、企业项目甚至是其他成本单元自定义条件规则，将名下的成本按照实际需求分组到有意义的分类。 成本单元概述 成本优化与节省 按需转包年包月建议 成本中心可分析用户E CS 、EVS、RDS、ELB和SFS Turbo按需资源的使用情况，为用户提供按需资源转包年包月的优化评估，帮助用户发现节省成本的机会。 按需转包年包月建议 资源包分析 您可以查看资源包分析数据，通过数据展示了解购买资源包是否被合理使用，以达节约成本的目的。 查看使用率分析数据|查看覆盖率分析数据 资源包购买建议 成本中心支持根据OBS、SFS产品的按需资源消费情况，生成相应的资源包购买建议。旨在为您提供成本优化的机会，您可以根据实际需要决定是否进行资源包购买。 资源包购买建议 资源优化建议 成本中心可以通过监控您的历史消费和资源使用情况，为您提供资源的空闲识别、状态检查和优化建议，寻找节约成本的机会。 资源优化建议 父主题： 概述

解决方法 登录ServiceStage控制台。 在区域列表选择您的业务所在区域，例如“华东二”。 在浏览器地址栏，获取“region”字段对应的值。 region取值示例如下面加粗内容所示： https://console.huaweicloud.com/servicestage/?agencyId=df****************************c1®ion=cn-east-4&locale=zh-cn#/overview 分别为表1所示服务创建 VPC终端节点 ，请参考购买连接“接口”型终端节点服务的终端节点。 区域：请选择2所选择的区域。 服务类别：选择“按名称查找服务”。 服务名称：请参考表1填写各云服务对应的终端节点服务名称，然后单击“验证”。 请将下表中的${region}替换为3获取到的值。 表1 连接“接口”型终端节点服务说明 云服务 终端节点服务名称 LTS com.myhuaweicloud.${region}.lts-access AOM com.myhuaweicloud.${region}.aom-access APM com.myhuaweicloud.${region}.apm-master 说明： 仅“西南-贵阳一”区域需要为APM服务创建VPC终端节点。 SWR com.myhuaweicloud.${region}.swr 说明： 如果您选择的是“华南-广州”区域，SWR的终端节点服务名称是：swr.cn-south-1.myhuaweicloud.com。 APIG com.myhuaweicloud.${region}.api 勾选“创建内网 域名 ”。 虚拟私有云：根据您的实际业务需要，为表1所示的所有终端节点服务选择同一个虚拟私有云。 子网：根据您的实际业务需要，为表1所示的所有终端节点服务分别选择子网。 其他参数请根据实际业务需要进行设置。 为OBS服务创建VPC终端节点，请参考购买连接“网关”型终端节点服务的终端节点。 需要为表2所示的OBS服务的终端节点服务分别创建VPC终端节点。 区域：请选择2所选择的区域。 服务类别：选择“按名称查找服务”。 服务名称：请参考表2填写对应区域OBS服务的终端节点服务名称。 表2 连接“网关”型终端节点服务说明 区域 终端节点服务名称 西南-贵阳一 cn-southwest-2.com.myhuaweicloud.v4.obsv2 cn-southwest-2.myhuaweicloud.v4.obsv2.lz05 华南-广州 cn-south-1.com.myhuaweicloud.v4.obsv2 cn-south-1.com.myhuaweicloud.v4.obsv2.lz05 cn-south-1.com.myhuaweicloud.v4.obsv2.lz08 cn-south-1.com.myhuaweicloud.v4.obsv2.lz09 华东二 com.myhuaweicloud.cn-east-4.obslb01.v4.obsv2.vxlan com.myhuaweicloud.cn-east-4.obslb01.v6.obsv2.vxlan 亚太-新加坡 ap-southeast-3.com.myhuaweicloud.v4.obsv2 ap-southeast-3.com.myhuaweicloud.v6.obsv2 非洲-约翰内斯堡 af-south-1.myhuaweicloud.v4.obsv2 af-south-1.myhuaweicloud.v6.obsv2 虚拟私有云：为表2所示的所有终端节点服务选择4所选择的虚拟私有云。 子网：根据您的实际业务需要，为表2所示的终端节点服务分别选择子网。 其他参数请根据您的实际业务需要进行设置。 在终端节点列表，获取4中为APIG、SWR服务创建的VPC终端节点对应的服务地址。 其中，${region}为3获取到的值。 创建内网域名，请参考创建内网域名。 域名：请分别填写以下内网域名。 请将以下内网域名中的${region}替换为3获取到的值。 servicestage.${region}.myhuaweicloud.com ecs.${region}.myhuaweicloud.com vpc.${region}.myhuaweicloud.com aom.${region}.myhuaweicloud.com swr-api.${region}.myhuaweicloud.com swr.${region}.myhuaweicloud.com VPC：选择4所选择的虚拟私有云。 其他参数请根据您的实际业务需要进行设置。 为7创建的所有内网域名添加记录集，请参考添加A类型记录集。 记录类型：选择“A – 将域名指向IPv4地址”。 记录值：参考下表填写。 请将下表中的${region}替换为3获取到的值。 内网域名 记录值 servicestage.${region}.myhuaweicloud.com 输入6获取到的com.myhuaweicloud.${region}.api终端节点服务对应的服务地址。 ecs.${region}.myhuaweicloud.com vpc.${region}.myhuaweicloud.com aom.${region}.myhuaweicloud.com swr-api.${region}.myhuaweicloud.com swr.${region}.myhuaweicloud.com 输入6获取到的com.myhuaweicloud.${region}.swr终端节点服务对应的服务地址。 其他参数请根据您的实际业务需要进行设置。

问题描述 VPC终端节点（VPC Endpoint），能够将VPC私密地连接到终端节点服务，使VPC中的云资源无需弹性公网IP就能够访问终端节点服务，提高了访问效率，为您提供更加灵活、安全的组网方式。 为虚拟机类型环境纳管的ECS安装虚拟机Agent时，可以通过已创建的VPC终端节点与LTS、AOM、OBS、SWR服务通信，并使用APIG通过配置好的内网域名调用ServiceStage、ECS、VPC、AOM的功能接口。 仅“西南-贵阳一”、“华东二”、“华南-广州”、“亚太-新加坡”、“非洲-约翰内斯堡”区域的ServiceStage支持通过VPC终端节点访问依赖的服务。

解决方法 登录ServiceStage控制台。 在区域列表选择您的业务所在区域，例如“华东二”。 在浏览器地址栏，获取“region”字段对应的值。 region取值示例如下面加粗内容所示： https://console.huaweicloud.com/servicestage/?agencyId=df****************************c1®ion=cn-east-4&locale=zh-cn#/overview 分别为SWR、APIG服务创建VPC终端节点，请参考购买连接“接口”型终端节点服务的终端节点。 区域：请选择2所选择的区域。 服务类别：选择“按名称查找服务”。 服务名称：请参考表1填写各云服务对应的终端节点服务名称。 请将下表中的${region}替换为3获取到的值。 表1 连接“接口”型终端节点服务说明 云服务 终端节点服务名称 SWR com.myhuaweicloud.${region}.swr 说明： 如果您选择的是“华南-广州”区域，SWR的终端节点服务名称是：swr.cn-south-1.myhuaweicloud.com。 APIG com.myhuaweicloud.${region}.api 勾选“创建内网域名”。 虚拟私有云：根据您的实际业务需要，为表1所示的所有终端节点服务选择同一个虚拟私有云。 子网：根据您的实际业务需要，为表1所示的终端节点服务分别选择子网。 其他参数请根据实际业务需要进行设置。 为OBS服务创建VPC终端节点，请参考购买连接“网关”型终端节点服务的终端节点。 需要为表2所示的OBS服务的终端节点服务分别创建VPC终端节点。 区域：请选择2所选择的区域。 服务类别：选择“按名称查找服务”。 服务名称：请参考表2填写OBS服务对应的终端节点服务名称。 表2 连接“网关”型终端节点服务说明 区域 终端节点服务名称 西南-贵阳一 cn-southwest-2.com.myhuaweicloud.v4.obsv2 cn-southwest-2.myhuaweicloud.v4.obsv2.lz05 华南-广州 cn-south-1.com.myhuaweicloud.v4.obsv2 cn-south-1.com.myhuaweicloud.v4.obsv2.lz05 cn-south-1.com.myhuaweicloud.v4.obsv2.lz08 cn-south-1.com.myhuaweicloud.v4.obsv2.lz09 华东二 com.myhuaweicloud.cn-east-4.obslb01.v4.obsv2.vxlan com.myhuaweicloud.cn-east-4.obslb01.v6.obsv2.vxlan 亚太-新加坡 ap-southeast-3.com.myhuaweicloud.v4.obsv2 ap-southeast-3.com.myhuaweicloud.v6.obsv2 非洲-约翰内斯堡 af-south-1.myhuaweicloud.v4.obsv2 af-south-1.myhuaweicloud.v6.obsv2 虚拟私有云：为表2所示的所有终端节点服务选择4所选择的虚拟私有云。 子网：根据您的实际业务需要，为表2所示的终端节点服务分别选择子网。 其他参数请根据实际业务需要进行设置。 在终端节点列表，获取4中为APIG、SWR服务创建的VPC终端节点对应的服务地址。 其中，${region}为3获取到的值。 创建内网域名，请参考创建内网域名。 域名：请分别填写以下内网域名。 请将以下内网域名中的${region}替换为3获取到的值。 servicestage.${region}.myhuaweicloud.com swr-api.${region}.myhuaweicloud.com swr.${region}.myhuaweicloud.com VPC：选择4所选择的虚拟私有云。 其他参数请根据您的实际业务需要进行设置。 为7创建的所有内网域名添加记录集，请参考添加A类型记录集。 记录类型：选择“A – 将域名指向IPv4地址”。 记录值：参考下表填写。 请将下表中的${region}替换为3获取到的值。 内网域名 记录值 servicestage.${region}.myhuaweicloud.com 输入6获取到的com.myhuaweicloud.${region}.api终端节点服务对应的服务地址。 swr-api.${region}.myhuaweicloud.com swr.${region}.myhuaweicloud.com 输入6获取到的com.myhuaweicloud.${region}.swr终端节点服务对应的服务地址。 其他参数请根据您的实际业务需要进行设置。

问题描述 VPC终端节点（VPC Endpoint），能够将VPC私密地连接到终端节点服务，使VPC中的云资源无需弹性公网IP就能够访问终端节点服务，提高了访问效率，为您提供更加灵活、安全的组网方式。 在Kubernetes类型环境下创建并部署组件时的组件镜像构建过程中，可以通过已创建的VPC终端节点与OBS、SWR服务通信，并使用APIG通过配置好的内网域名调用ServiceStage的功能接口。 仅“西南-贵阳一”、“华东二”、“华南-广州”、“亚太-新加坡”、“非洲-约翰内斯堡”区域的ServiceStage支持通过VPC终端节点访问依赖的服务。

操作步骤： 在专职人员激励“付款申请”页面选择状态为“付款申请审核通过”的激励，单击“查看开票清单”。 邮寄发票 在“发票清单”页面，核对信息后单击“打印”； 填写发票号码后将开票清单和发票邮寄到华为公司。 结算币种，根据伙伴商业信息认证时填写的币种来进行结算。 若华为云对您的发票审核未通过，请根据审核意见修改后重新提交。 查看付款进展 在“付款申请”页签中，选择状态为“待华为付款”的申请，单击付款申请编码可在详情页查看华为付款详情。

申请门槛 合作伙伴已加入服务伙伴发展路径且达到角色认证阶段。 本年度内至少获得1个激励范围内的一级能力标签。 表1 一级能力标签范围及申请区域 一级能力标签 区域范围 数据库服务能力 全球 大数据服务能力 全球 数据仓库 服务能力 仅限中国区 AI平台服务能力 仅限中国区 DevSecOps服务能力 仅限中国区 解决方案集成实施服务能力 仅限中国区 公有云云运维服务能力 仅限中国区 卓越运营服务能力 仅限中国区 应用现代化服务能力 仅限中国区 注：华为云可能对以上激励范围做不定期变更（包括新增或移除）。

操作步骤 在专职人员激励（FH）“付款申请”页面选择可申请付款的季度，单击操作列的“申请付款”。 在申请付款弹框中确认信息并单击“提交”。 FH付款申请提交成功后，华为云进行审核，审核结果会邮件通知您，请耐心等待。 查看付款申请审核状态。 付款申请审核中 伙伴在“付款申请”页签中，单击付款申请编号，在申请详情页查看申请详情及审核进度。 付款申请审核不通过 若伙伴付款申请审核未通过，请根据审核意见修改申请信息后重新提交申请。 付款申请审核通过 付款申请审核通过后，可在“付款申请”页签中单击付款申请编码查看详情。

售前工程师申请条件 已成为数字化转型咨询与系统集成发展路径的项目专员，岗位为解决方案架构师； 同时持有华为云业务方向专业认证中级HCSP（基于华为云构建客户的业务体系)及HCCDP – Solution Architectures或HCCDE – Solution Architectures或HCIP-Cloud Service Solutions Architect或HCIE-Cloud Service Solutions Architect认证，且证书在有效期内； 从事华为云的时间大于半年； 补贴期内最多可申请2次激励。 补贴期指项目专员从事华为云业务之日起一年内。

操作步骤 在专职人员激励（FH）“激励确认”页面选择CCoE能力构建专职人员激励，单击操作列的“核对激励”。 在核对激励页面，核对信息并上传证明材料后，单击“确定提交”。 上传证明材料：请下载对应模板，按照要求填写后再上传。 人员在职证明； 第三方社保证明：社保证明仅保留姓名、参保地/城市、单位、社保打印日期、缴费起止年月（其中上海为上月缴费状态、杭州为参保年月、西安为签章日期）。 激励申请提交成功后华为方进行审核，审核结果会邮件通知您，请耐心等待。 查看激励申请详情。 激励审核中： 伙伴在“激励确认”页签中可单击激励编号，在激励申请详情页查看提交的申请信息及审核进度。 激励审核不通过： 若伙伴激励申请审核未通过，请根据审核意见修改信息后重新提交申请。 激励审核通过： 激励申请审核通过后，可在“激励确认”页签中单击激励编码查看详情。

产品功能 选择Linux kernel 5.10作为HCE的内核，为云上应用程序环境提供企业级高可靠性保障，并同步更新Linux社区的最新功能。 支持云原生调度增强、内存分级扩展，支持操作系统迁移、兼容性评估。 支持SM2等国密算法，等保2.0/CC EAL4+安全能力。 提供gcc 10.3、binutils 2.37、glibc 2.34编译器，增强稳定性并提高与其它软件的兼容性。 对Intel、AMD、Arm等平台进行功能适配、性能调优和稳定性加固，保证操作系统在各平台都能稳定可靠地长期运行。

错误码说明 当您调用API时，如果遇到“APIGW”开头的错误码，请参见API网关错误码进行处理。 更多服务错误码请参见API错误中心。 状态码 错误码 错误信息 描述 处理措施 400 IDE.00010070 Free user limit not Found! 免费资源的配置无法找到，请稍后再试 请稍后再试 403 IDE.00000004 not subscribe cloudide 未开通CloudIDE服务 开通CloudIDE服务 403 IDE.00000005 suspended 您的账户已欠费冻结 账户充值 403 IDE.00000007 not verified 账号未实名认证，请认证后再试 账号实名认证 403 IDE.00000010 account is not normal 账号状态异常，请稍后再试 检查账号是否异常 403 IDE.00010000 OPERATE LIMIT 操作受限，请确认后再操作 请确认是否有权限 403 IDE.00010085 User already exists 用户已经存在，请确认后再试 确认用户是否已存在 403 IDE.00010086 blackList user 黑名单用户不能添加 使用白名单用户 403 IDE.00010092 no such action 没有这样的动作 请确认是否有权限 406 IDE.00000011 unusual limit 15 minute 15分钟内累计输入用户名错误5次，请15分钟后再试 请15分钟后再试 406 IDE.00000097 parameter is null or error 参数错误 参数规格：参考相应的API文档 406 IDE.00010027 Instance name is exist 实例已经存在 修改实例名 406 IDE.00010028 Instance is Starting, Can't remove it now 实例正在启动，不能被删除，请稍后再试 实例停止后在删除 406 IDE.00010029 Instance has been deleted or is in deleting 实例已经被删除或正在删除，请勿重复删除 等待操作完成 406 IDE.00010030 instance not exist 实例不存在，请确认后操作 确认实例是否存在 406 IDE.00010048 active error:instance status error 实例状态异常 请稍后再试 406 IDE.00010054 Could not stop the ide, instance status is not running or starting 实例不在运行状态，无法停止，请稍后再试 实例运行后在停止 406 IDE.00010058 current user is not subUser in Domain 当前用户不是该组织下的子账号，请确认后操作 确认用户是否为组织下子账号 406 IDE.00010071 Free resource not enough! 免费资源不足，请稍后再试 使用其他免费技术栈资源或购买cloudide服务 406 IDE.00010087 not whiteList user 您不是白名单用户，请确认后操作 确认是否为白名单用户 406 IDE.00010091 Organization already existed 组织已经存在，请确认后操作 确认组织是否存在 406 IDE.00010101 INSTANCE_START_ERROR 实例启动失败，请稍后再试 请稍后再试 406 IDE.00010103 instance number limit 实例数量已经超过上限，请删除旧有实例后再试 删除旧实例 406 IDE.00010104 instance resource limit 实例资源受限，请稍后再试 请稍后再试 406 IDE.00010105 instance arm number limit arm实例数量已经超过上限，请删除旧有实例后再试 删除旧实例 406 IDE.00040001 config error 配置错误 检查配置 406 IDE.00040002 label is not correct 标签不正确 参数规格：参考相应的API文档 406 IDE.00040004 The character string length is incorrect. 字符串长度不匹配 检查字符串 406 IDE.00040005 Unsupported for spec platform or stack 不支持的平台或技术栈规格 参数规格：参考相应的API文档 500 IDE.00000040 outer http request error 外部HTTP请求错误 请稍后再试 500 IDE.00000100 Internal Server Error 服务异常，请稍后再试 服务异常，请稍后再试 500 IDE.00020001 get Repository By ProjectId error 获取仓库失败 请稍后再试 500 IDE.00020002 get Branches By RepoName error 获取分支失败 请稍后再试 500 IDE.00020003 get Related Project error 获取工程失败，请稍后再试 请稍后再试 500 IDE.00020004 get Project user error 获取工程用户信息失败，请稍后再试 请稍后再试

更改安全组 安全组是一个逻辑上的分组，为同一个 虚拟私有云VPC 内具有相同安全保护需求并相互信任的弹性云服务器提供访问策略。安全组创建后，用户可以在安全组中定义各种访问规则，当弹性云服务器加入该安全组后，即受到这些访问规则的保护。安全组的默认规则是在出方向上的数据报文全部放行，安全组内的弹性云服务器无需添加规则即可互相访问。系统会为每个云账号默认创建一个默认安全组，用户也可以创建自定义的安全组。 使用VMware备份恢复前需要先更改安全组。云备份为了您的网络安全考虑，在使用前未设置安全组入方向，需要您手动进行配置。 安全组的出方向需要设置允许100.125.0.0/16网段的1-65535端口，入方向需要设置允许100.125.0.0/16网段的59526-59528端口。出方向规则默认为0.0.0.0/0，即数据报文全部放行。如果未修改出方向默认规则，则无需重新设置。 进入云服务器控制台。 单击左侧导航树中的“弹性云服务器”或“裸金属服务器”，在服务器界面选择目标服务器。进入目标服务器详情。 选择“安全组”页签，选择目标安全组，弹性云服务器界面单击列表右侧“更改安全组规则”。裸金属服务器单击“更改安全组”，在弹出框中单击“管理安全组”。 在安全组界面，选择“入方向规则”页签，单击“添加规则”，弹出“添加入方向规则”对话框，如图1所示。选择“TCP”协议，在“端口”中输入“59526-59528”，在源地址中选择“IP地址”，输入“100.125.0.0/16”。适当补充描述后，单击“确定”，完成入方向规则设置。 图1 增加入方向规则 选择“出方向规则”页签，单击“添加规则”，弹出“添加出方向规则”对话框，如图2所示。选择“TCP”协议，在“端口”中输入“1-65535”，在目的地址中选择“IP地址”，输入“100.125.0.0/16”。适当补充描述后，单击“确定”，完成出方向规则设置。 图2 增加出方向规则

背景说明 同步至云端的备份无法创建服务器。 同步的备份只能用于恢复至其他的云服务器，可以恢复至系统盘和数据盘。 执行恢复操作前，请务必按照操作步骤完成安全组的配置，否则可能会导致恢复失败。 VMware虚拟机使用LVM管理系统盘时，不支持云上恢复虚拟机。 云上恢复仅支持恢复到同类型操作系统，如Linux到Linux，Windows到Windows。 操作系统（OS）的启动方式需要与镜像的启动方式相同，如果IDC内VMware虚拟机的启动方式为UEFI（或BIOS），CBR执行备份后备份数据的启动方式与备份源相同，上云副本在云上恢复时，恢复的目标主机原始镜像的启动方式也需要是UEFI（或BIOS），如果OS的启动方式与镜像启动方式不匹配，可能会导致无法启动。

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Authorization 是 String 该字段存储的是Access Token。调用KooDrive的API使用Token认证，拥有Token就代表拥有某种权限，在调用API的时候将Token加到请求消息头中，从而通过身份认证，获得操作API的权限。Access Token的获取请参考对应的开发手册，格式参考：Bearer+{access_token} X-Traceid 否 String 业务跟踪id（必须58位）

请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 Authorization 是 String 该字段存储的是Access Token。调用KooDrive的API使用Token认证，拥有Token就代表拥有某种权限，在调用API的时候将Token加到请求消息头中，从而通过身份认证，获得操作API的权限。Access Token的获取请参考对应的开发手册，格式参考：Bearer+{access_token} X-Traceid 否 String 业务跟踪id（必须58位） 表2 请求Body参数 参数 是否必选 参数类型 描述 shortUrl 是 String 分享shortUrl extractCode 是 String 分享码

响应示例 状态码： 200 OK { "code" : "string", "msg" : "string", "shareLink" : { "shareId" : "string", "shortUrl" : "string", "extractCode" : "string", "createTime" : "2024-06-03T02:00:39.953Z", "updateTime" : "2024-06-03T02:00:39.953Z", "expireTime" : "2024-06-03T02:00:39.953Z" } }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Authorization 是 String 该字段存储的是Access Token。调用KooDrive的API使用Token认证，拥有Token就代表拥有某种权限，在调用API的时候将Token加到请求消息头中，从而通过身份认证，获得操作API的权限。Access Token的获取请参考对应的开发手册，格式参考：Bearer+{access_token} X-Traceid 否 String 业务跟踪id（必须58位） 表3 请求Body参数 参数 是否必选 参数类型 描述 deptIds 否 Array of strings 部门id列表 groupIds 否 Array of strings 用户组id列表 userIds 否 Array of strings 用户id列表 permission 否 SharePermission object 分享权限（后续支持） expireTime 否 String 失效时间 extractCode 否 String 提取码 comment 否 String 分享留言 validDays 是 Integer 分享有效天数0-365. 0表示不变 表4 SharePermission 参数 是否必选 参数类型 描述 preview 否 Boolean 预览权限 edit 否 Boolean 编辑权限 download 否 Boolean 下载权限

响应参数 状态码： 200 表5 响应Body参数 参数 参数类型 描述 code String 响应码 msg String 响应信息 shareLink shareLink object 分享链接信息 表6 shareLink 参数 参数类型 描述 shareId String 分享id shortUrl String 分享链接 extractCode String 提取码 createTime String 创建时间 updateTime String 修改时间 expireTime String 失效时间 linkUrl String 分享链接 shareTime String 分享时间 scope Integer 范围 displayName String 显示名称 status Integer 状态 viewCnt String 浏览次数 downloadCnt String 下载次数 saveCnt String 保存次数

请求示例 PUT /koodrive/ose/v1/share/{shareId} { "deptIds" : [ "string" ], "groupIds" : [ "string" ], "userIds" : [ "string" ], "permission" : { "preview" : true, "edit" : true, "download" : true }, "expireTime" : "2024-06-03T02:00:39.952Z", "extractCode" : "string", "comment" : "string", "validDays" : 0 }

请求示例 将空间标识为IAADfsBFCO6WtAtuA315074383680425b8aa9a130cba2d4 空间下，文件id为FtSCRFXCYtFjo315lPfRHeKRiqrDdmm_Y的文件重命名为“下载”。 POST /koodrive/ose/v1/files/rename/FtSCRFXCYtFjo315lPfRHeKRiqrDdmm_Y Authorization:Bearer+10f88*********4791e9ff { "name": "下载", "containerId": "IAADfsBFCO6WtAtuA315074383680425b8aa9a130cba2d4", "renameMode": 2 }

请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 Authorization 是 String 该字段存储的是Access Token。调用KooDrive的API使用Token认证，拥有Token就代表拥有某种权限，在调用API的时候将Token加到请求消息头中，从而通过身份认证，获得操作API的权限。Access Token的获取请参考对应的开发手册，格式参考：Bearer+{access_token} X-Traceid 否 String 消息日志跟踪标识（必须58位） language 否 String 国际化语言标识，符合i18n规范，如zh-CN表示简体中文，en-US表示美式英语，不传默认美式英语 x-session-id 是 String 会话标识

请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 Authorization 否 String 该字段存储的是Access Token。调用KooDrive的API使用Token认证，拥有Token就代表拥有某种权限，在调用API的时候将Token加到请求消息头中，从而通过身份认证，获得操作API的权限。Access Token的获取请参考对应的开发手册，格式参考：Bearer+{access_token} X-Traceid 否 String 消息日志跟踪标识（必须58位） language 否 String 国际化语言标识，符合i18n规范，如zh-CN表示简体中文，en-US表示美式英语，不传默认美式英语

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 code Integer 响应码 msg String 响应信息 nextCursor String 分页游标，如果不存在，代表已返回最后一个 shareLinks Array of ShareWithMeLink objects 分享链接列表 表4 ShareWithMeLink 参数 参数类型 描述 shareId String 分享ID shortUrl String 分享短码 linkUrl String 分享链接 shareTime String 分享时间 ownerId String 分享人id ownerName String 分享人姓名 displayName String 展示名称 files Array of ShareFileInfo objects 分享的文件列表 permission SharePermission object 分享权限（后续支持） expireTime String 失效时间 status Integer 分享状态，0：根据失效时间判断，1：文件已被删除，2：已失效 comment String 分享留言 containerId String 空间id downloadCnt Integer 下载次数 saveCnt Integer 保存次数 scope String 范围 updateTime String 更新时间 viewCnt String 浏览次数 表5 ShareFileInfo 参数 参数类型 描述 id String *文件id fileName String *文件名，最长160个字节 fileType String 文件类型，外部输入，最长250个字符 mimeType String *内容类型 size Integer 文件大小 parentFolder Array of strings 父目录ID列表，注意：当前只取第一个父母Id fileSuffix String 文件后缀，fullFileExtension最后一个字符串 containers Array of strings 空间标识 downloadLinks Array of downloadLinks objects 下载链接 recycled Boolean 是否在回收站标识 表6 downloadLinks 参数 参数类型 描述 usage String 用途默认：'content'-实体内容、'thumbnail'-缩略图,业务可以扩展该字段 downloadLink String 下载链接 表7 SharePermission 参数 参数类型 描述 preview Boolean 预览权限 edit Boolean 编辑权限 download Boolean 下载权限

响应示例 状态码： 200 OK { "code" : "string", "msg" : "string", "nextCursor" : "string", "shareLinks" : [ { "shareId" : "string", "shortUrl" : "string", "linkUrl" : "string", "shareTime" : "2024-06-03T02:02:00.797Z", "ownerId" : "string", "ownerName" : "string", "displayName" : "string", "files" : [ { "id" : "string", "fileName" : "string", "fileType" : "string", "mimeType" : "string", "size" : 0, "parentFolder" : [ "string" ], "fileSuffix" : "string", "containers" : [ "string" ] } ], "permission" : { "preview" : true, "edit" : true, "download" : true }, "expireTime" : "2024-06-03T02:02:00.797Z", "status" : 0, "comment" : "string" } ] }

URI GET /koodrive/ose/v1/share/received 表1 Query参数 参数 是否必选 参数类型 描述 pageSize 否 Integer 每页返回的个数，默认是100，可接受值最大值是100。注意在到达最后的列表之前，实际有可能返回部分或者空结果 pageCursor 否 String 当前页游标，由前一个响应的nextCursor获取，默认为0 sortType 否 Integer 排序类型，4：分享时间（默认） sortDirection 否 Integer 排序方向，1：升序，2：降序（默认） displayName 否 String 支持按照展示名称模糊匹配

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Authorization 是 String 该字段存储的是Access Token。调用KooDrive的API使用Token认证，拥有Token就代表拥有某种权限，在调用API的时候将Token加到请求消息头中，从而通过身份认证，获得操作API的权限。Access Token的获取请参考对应的开发手册，格式参考：Bearer+{access_token} X-Traceid 否 String 业务跟踪id（必须58位）