华为云用户手册

请求消息头 附加请求头字段，如指定的URI和HTTP方法所要求的字段。例如定义消息体类型的请求头“Content-Type”，请求鉴权信息等。 详细的公共请求消息头字段请参见表3。 表3 公共请求消息头 名称 描述 是否必选 示例 Host 请求的服务器信息，从服务API的URL中获取。值为hostname[:port]。端口缺省时使用默认的端口，https的默认端口为443。 否 使用AK/SK认证时该字段必选。 code.test.com or code.test.com:443 Content-Type 消息体的类型（格式）。推荐用户使用默认值application/json，有其他取值时会在具体接口中专门说明。 是 application/json Content-Length 请求body长度，单位为Byte。 否 3495 X-Project-Id project id，项目编号。请参考获取项目ID章节获取项目编号。 否 如果是专属云场景采用AK/SK认证方式的接口请求，或者多project场景采用AK/SK认证的接口请求，则该字段必选。 e9993fc787d94b6c886cbaa340f9c0f4 X-Auth-Token 用户Token。 用户Token也就是调用获取用户Token接口的响应值，该接口是唯一不需要认证的接口。 请求响应成功后在响应消息头（Headers）中包含的“X-Subject-Token”的值即为Token值。 否 使用Token认证时该字段必选。 注：以下仅为Token示例片段。 MIIPAgYJKoZIhvcNAQcCo...ggg1BBIINPXsidG9rZ API同时支持使用AK/SK认证，AK/SK认证使用SDK对请求进行签名，签名过程会自动往请求中添加Authorization（签名认证信息）和X-Sdk-Date（请求发送的时间）请求头。 AK/SK认证的详细说明请参见认证鉴权的“AK/SK认证”。 对于获取用户Token接口，由于不需要认证，所以只添加“Content-Type”即可，添加消息头后的请求如下所示。 1 2 POST https://iam.cn-north-1.myhuaweicloud.com/v3/auth/tokens Content-Type: application/json

请求示例 重装云服务器操作系统，重装后采用密码方式登录鉴权，建议将密码在配置文件或者环境变量中密文存放，使用时解密，确保安全。 POST https://{endpoint}/v2/{project_id}/cloudservers/{server_id}/reinstallos { "os-reinstall": { "adminpass": "$ADMIN_PASS", "userid": "7e25b1da389f4697a79df3a0e5bd494e", "mode": "withStopServer" } } 重装云服务器操作系统，重装后采用密钥方式登录鉴权。 POST https://{endpoint}/v2/{project_id}/cloudservers/{server_id}/reinstallos { "os-reinstall": { "keyname": "KeyPair-350b", "userid": "7e25b1da389f4697a79df3a0e5bd494e" } }

功能介绍 重装弹性云服务器的操作系统。支持弹性云服务器数据盘不变的情况下，使用原镜像重装系统盘。 本接口为异步接口，当前重装弹性云服务器操作系统请求下发成功后会返回job_id，此时重装弹性云服务器操作系统并没有立即完成，需要通过调用查询任务的执行状态查询job状态，当Job状态为 SUCCESS 时代表云服务器操作系统重装成功。 调用该接口后，系统将卸载系统盘，然后使用原镜像重新创建系统盘，并挂载至弹性云服务器，实现重装操作系统功能。

获取Token 接口调用前需要认证鉴权，因此需要提前获取token信息。后续调用API的消息头中“X-Auth-Token”的值即为Token值。 本例以获取华东-上海二区域的Token为例： 请求URI：POST https://iam.cn-east-2.myhuaweicloud.com/v3/auth/tokens 请求消息头：Content-Type=application/json 请求消息体： { "auth": { "identity": { "methods": [ "password" ], "password": { "user": { "name": "请填写用户名", "password": "$ADMIN_PASS", //建议在配置文件或者环境变量中密文存放，使用时解密，确保安全 "domain": { "name": "用户所属的账号名称" } } } }, "scope": { "project": { "name": "区域名称，本例为cn-east-2" } } } } 查看获取的Token：单击响应头，x-subject-token的取值即为获取的Token。请妥善保存Token信息，在后续的创建云服务器的请求头信息中需要使用Token认证。 General: Request URL: https://iam.cn-east-2.myhuaweicloud.com/v3/auth/tokens Request Method: POST Status Code: 201 Response Headers: cache-control: no-cache, no-store, must-revalidate connection: keep-alive content-length: 18401 content-type: application/json; charset=UTF-8 date: Thu, 27 May 2021 01:24:49 GMT expires: Thu, 01 Jan 1970 00:00:00 GMT pragma: no-cache server: api-gateway strict-transport-security: max-age=31536000; includeSubdomains; via: proxy A x-content-type-options: nosniff x-download-options: noopen x-frame-options: SAMEORIGIN x-iam-trace-id: token_cn-east-2_null_9bbec3983f3c7a5c146e709251760467 x-request-id: d7796611318416bc8ffb2948a47fede8 x-subject-token: MIISMAYJKoZIhvcNAQ...7xMUw== x-xss-protection: 1; mode=block; 查看Token过期时间：响应体中“expires_at”表示该Token过期时间。 { "token": { "expires_at": "2021-05-28T01:24:49.905000Z", ... } }

检验Token的有效期 调用API时判断Token有效期是否充足，若您的应用程序缓存了Token，建议每12小时刷新一次Token。以确保Token有足够长的有效期。 您还可以主动查询某个Token的过期时间。通过调用检验Token有效性的接口查看Token的有效时期。 您可以在API Explorer中调试该接口。 本例以检验华东-上海二区域的Token为例： 请求URI：GET https://iam.cn-east-2.myhuaweicloud.com/v3/auth/tokens 请求消息头： Content-Type=application/json;charset=utf8 X-Auth-Token：管理员校验本账号中IAM用户的token的有效性：拥有Security Administrator权限的token。 IAM用户校验自己token的有效性：该IAM用户的token（无需特殊权限）。 本例中使用的是IAM用户因此X-Auth-Token与待校验的Token相同。 X-Subject-Token：待校验的token。 查看Token过期时间：响应体中“expires_at”表示该Token过期时间。 若Token即将超期（无法满足一次完整的API调用或者完整的一套组合的调用）则需要重新获取Token，防止调用过程中Token超期，调用中断。 { "token": { "expires_at": "2021-05-28T01:24:49.905000Z", ... } }

示例 请求示例 POST https://{endpoint}/v1/{project_id}/cloudservers/resource_instances/action { "offset": "100", "limit": "1", "action": "filter", "matches":[ { "key": "resource_name", "value": "ecs_test" }], "tags": [ { "key": "key1", "values": [ "value1", "value2" ] }] } 响应示例 { "resources": [ { "resource_detail": null, "resource_id": "31760ffa-6711-406d-bc94-bce4ae925a8a", "resource_name": "ecs_test", "tags": [ { "key": "key1"， "value": "value1" } ] } ], "total_count": 1000 }

请求消息 请求参数如表2所示。 表2 请求参数 参数 是否必选 参数类型 描述 action 是 String 值为filter：表示按标签过滤弹性云服务器，返回符合条件的云服务器列表。 limit 否 String 查询返回的云服务器数量限制，最多为1000，不能为负数。 如果action的值为count时，此参数无效。 如果action的值为filter时，limit必填，取值范围[0-1000]，如果不传值，系统默认limit值为1000。 offset 否 String 偏移量：指定返回记录的开始位置，必须为数字，取值范围为大于或等于0。 查询第一页数据时，可以不传入此参数。 如果action的值为count时，此参数无效。 如果action的值为filter时，必填，如果用户不传值，系统默认offset值为0。 tags 否 Array of objects 查询包含所有指定标签的弹性云服务器，详情请参见表3。 结构体不能缺失。 key不能为空或者空字符串。 key不能重复。 同一个key中values不能重复。 not_tags 否 Array of strings 查询不包含所有指定标签的弹性云服务器。 结构体不能缺失。 key不能为空或者空字符串。 Key不能重复。 同一个key中values不能重复。 matches 否 Array of objects 搜索字段，用于按条件搜索弹性云服务器。 当前仅支持按resource_name进行搜索。更多信息，请参见表4。 表3 tag字段数据结构说明 参数 是否必选 参数类型 描述 key 是 String 键。 最大长度127个unicode字符。 key不能为空。 values 是 Array of strings 值列表。 value不允许重复。 每个值最大长度255 个unicode字符。 如果values为空则表示any_value。 value之间为或的关系。 表4 match字段数据结构说明 参数 是否必选 参数类型 描述 key 是 String 键，表示要匹配的字段。 当前key的参数值只能取“resource_name”，此时value的参数值为云服务器名称。 key不能重复，value为匹配的值。 此字段为固定字典值。 不允许为空字符串。 value 是 String 值。 当前key的参数值只能取“resource_name”，此时value的参数值为云服务器名称。 每个值最大长度255个unicode字符。 不可以为空 。

响应消息 响应参数 响应参数如表5所示。 表5 响应参数 参数 参数类型 描述 resources Array of objects 返回的云服务器列表，详情参见表6。 total_count Integer 总记录数 表6 resource字段数据结构说明 参数 参数类型 描述 resource_id String 云服务器ID resouce_detail String 预留字段。 tags Array of objects 标签列表。 resource_name String 资源名称，即弹性云服务器名称。 表7 resource_tag字段数据结构说明 参数 参数类型 描述 key String 键。 最大长度127个unicode字符。 key不能为空。 只能包含字母、数字、下划线“_”、中划线“-”。 value String 值。 每个值最大长度255个unicode字符。 可以为空字符串。 只能包含字母、数字、下划线“_”、中划线“-”。

请求示例 一键重置指定云服务器的管理员账号（root用户或Administrator用户）的密码，建议将密码在配置文件或者环境变量中密文存放，使用时解密，确保安全。 PUT https://{endpoint}/v1/{project_id}/cloudservers/{server_id}/os-reset-password { "reset-password": { "new_password": "$ADMIN_PASS", } }

请求消息 请求参数如表2所示。 表2 请求参数 参数 参数类型 是否必选 描述 new_password String 是 新密码。 当dry_run字段为true时，该字段为非必填字段，否则为必填字段。 新密码的校验规则： 长度为8-26位。 密码至少必须包含大写字母（A-Z）、小写字母（a-z）、数字（0-9）和特殊字符（!@%-_=+[]:./?）中的三种。 密码不能包含用户名或用户名的逆序。 Windows系统密码不能包含用户名或用户名的逆序，不能包含用户名中超过两个连续字符的部分。 dry_run Boolean 否 是否只预检此次请求。 true：发送检查请求，不会重置密码。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过，则返回对应错误。如果检查通过，则返回响应结果。 false：发送正常请求，通过检查后并且进行重置密码请求。 默认值：false servers Array of objects 是 待批量重置密码的弹性云服务器ID信息，详情参见 表3。 表3 servers字段数据结构说明 参数 参数类型 是否必选 描述 id String 是 弹性云服务器ID。

请求示例 批量重置ID为“1bd0eb17-4466-4c15-a9ce-87727ad311b5”和“fd6b6e9d-64a1-40fa-b7dc-f491be42fdd2”的云服务器的密码，建议将密码在配置文件或者环境变量中密文存放，使用时解密，确保安全。 PUT https://{endpoint}/v1/{project_id}/cloudservers/os-reset-passwords { "new_password": "$ADMIN_PASS", "dry_run": true, "servers": [ { "id":"1bd0eb17-4466-4c15-a9ce-87727ad311b5" }, { "id":"fd6b6e9d-64a1-40fa-b7dc-f491be42fdd2" } ] }

响应示例 响应示例请参见响应（批量操作类）所示。 { "response": [ { "id": "616fb98f-46ca-475e-917e-2563e5a8cd19" }, { "id": "516fb98f-46ca-475e-917e-2563e5a8cd12" } ] }

请求消息 请求参数如表2所示。 表2 请求参数 参数 参数类型 是否必选 描述 reset-password Object 是 reset-password信息详情，参考表3。 表3 reset-password字段结构说明 参数 参数类型 是否必选 描述 new_password String 是 弹性云服务器新密码。 该接口不做密码安全性校验，设置的密码复杂度请遵循密码规则。 密码规则： 密码长度范围为8到26位。 密码至少包含以下4种字符中的3种： 大写字母 小写字母 数字 特殊字符，包括!@$%^-_=+[{}]:,./? 密码不能包含用户名或用户名的逆序。 Windows系统的弹性云服务器，不能包含用户名中超过两个连续字符的部分。

版本生命周期 表1给出了GaussDB(DWS)版本生命周期（仅体现发布号），帮助您规划自己的版本更新节奏。 对于已经停止服务与支持（EOS）的版本或非推荐版本，建议参见版本收编策略升级到最新稳定版本。 表1 GaussDB(DWS)版本生命周期 版本名称 状态 发布时间 EOM时间（停止销售） EOS时间（停止服务与支持） 8.2.0.x 已发布 2022年11月30日 2025年9月30日 2027年3月30日 8.1.3.x 已发布 2022年04月15日 2024年6月30日 2025年12月31日 8.1.1.x EOM 2021年7月30日 2023年6月30日 2025年12月31日 8.1.0.x EOM 2021年5月15日 2023年6月30日 2025年12月31日 8.0.1.x EOM 2020年7月31日 2023年6月30日 2024年12月31日

版本收编策略 表2 版本收编 当前版本 是否EOS 收编建议 升级方案 1.5.x/1.6.x 是 不支持直接升级，建议迁移到8.1.3.325（推荐版本）。 建议联系技术支持评估后操作。 1.7.x 是 建议升级到8.1.3.325（推荐版本）。 不支持跨多版本直接升级到8.1.3.325，需要多跳升级，建议联系技术支持评估后升级。 8.0.1.x 否 建议升级到8.1.3.325（推荐版本）。 不支持跨多版本直接升级到8.1.3.325，需要多跳升级，建议联系技术支持评估后升级。 8.1.0.x 否 建议升级到8.1.3.325（推荐版本）。 不支持跨多版本直接升级到8.1.3.325，需要多跳升级，建议联系技术支持评估后升级。 8.1.1.x~8.1.3.323 否 建议升级到8.1.3.325（推荐版本）。 支持直接升级到8.1.3.325，建议联系技术支持评估后升级，支持在控制台升级，参见升级集群。 8.2.0.x（白名单用户版本） 否 建议升级到8.2.1.119（白名单用户推荐版本）。 支持直接升级到8.2.1.119，建议联系技术支持评估后升级，支持在控制台升级，参见升级集群。 8.2.1.1xx（白名单用户版本） 否 建议升级到8.2.1.119（白名单用户推荐版本）。 支持直接升级到8.2.1.119，建议联系技术支持评估后升级，支持在控制台升级，参见升级集群。

DataArts Insight应用场景 智能数据洞察（DataArts Insight）致力于用更生动、友好的形式，即时呈现隐藏在瞬息万变且庞杂数据背后的业务洞察。无论在零售、物流、电力、水利、环保、还是交通领域，通过交互式实时数据可视化视屏墙来帮助业务人员发现、诊断业务问题。 DataArts Insight提供丰富的可视化组件，除了针对业务展示优化过的常规图表外，还有拓扑关系等异形图表供您自由搭配。 DataArts Insight无缝集成华为云数据仓库服务、支持本地CSV、在线API及企业内部私有云数据；满足您各类大数据实时计算、监控的需求，充分发挥大数据计算的能力。 拖拽即可完成组件自由配置与布局、所见即所得，无需编程就能轻松搭建可视化大屏。 DataArts Insight特别针对拼接大屏端的展示做了分辨率优化，能够适配非常规的拼接分辨率。创建的大屏能够发布分享，作为您对外数据业务展示的窗口。

如何选择区域？ 选择区域时，您需要考虑以下几个因素： 地理位置 一般情况下，建议就近选择靠近您或者您的目标用户的区域，这样可以减少网络时延，提高访问速度。不过，在基础设施、BGP网络品质、资源的操作与配置等方面，中国大陆各个区域间区别不大，如果您或者您的目标用户在中国大陆，可以不用考虑不同区域造成的网络时延问题。 香港、曼谷等其他地区和国家提供国际带宽，主要面向非中国大陆地区的用户。如果您或者您的目标用户在中国大陆，使用这些区域会有较长的访问时延，不建议使用。 在除中国大陆以外的亚太地区有业务的用户，可以选择“中国-香港”、“亚太-曼谷”或“亚太-新加坡”区域。 在非洲地区有业务的用户，可以选择“南非-约翰内斯堡”区域。 在欧洲地区有业务的用户，可以选择“欧洲-巴黎”区域。

什么是区域、可用区？ 用户用区域和可用区来描述数据中心的位置，您可以在特定的区域、可用区创建资源。 区域（Region）：从地理位置和网络时延维度划分，同一个Region内共享弹性计算、块存储、对象存储、VPC网络、弹性公网IP、镜像等公共服务。Region分为通用Region和专属Region，通用Region指面向公共租户提供通用云服务的Region；专属Region指只承载同一类业务或只面向特定租户提供业务服务的专用Region。 可用区（AZ，Availability Zone）：一个AZ是一个或多个物理数据中心的集合，有独立的风火水电，AZ内逻辑上再将计算、网络、存储等资源划分成多个集群。一个Region中的多个AZ间通过高速光纤相连，以满足用户跨AZ构建高可用性系统的需求。 图1阐明了区域和可用区之间的关系。 图1 区域和可用区 目前，华为云已在全球多个地域开放云服务，您可以根据需求选择适合自己的区域和可用区。更多信息参考华为云全球站点。

注册华为账号并开通华为云 如果您已完成华为账号注册，可以跳过该步骤。 打开华为云官方网站。 单击华为云官网右上角“注册”进入注册页面。 在注册页面，输入手机号，并获取并输入手机收到的验证码。 请使用中国大陆的手机号码。 一个手机号可以注册3个华为账号，如账号数量已达到3个，将不支持使用该手机号注册新的华为账号。 设置账号密码，并单击“注册”。 至少包含8个字符。 至少包含字母和数字，不能包含空格。 勾选服务条款，单击“开通”。

访问方式 云服务平台提供了Web化的服务管理平台，即管理控制台管理方式。 如果用户已注册云服务平台，可直接登录DataArts Insight管理控制台。 使用DataArts Insight的其他相关操作，请参考用户指南。 管理控制台方式 云服务平台提供了Web化的服务管理平台，即管理控制台管理方式。 如果用户已注册，可直接登录DataArts Insight管理控制台。如果未注册，参考注册华为账号并开通华为云。 API方式 如果用户需要将云平台上的DataArts Insight服务集成到第三方系统，用于二次开发，可以使用API方式访问DataArts Insight服务。 具体操作参考《DataArts Insight API参考》。

产品功能 自助式分析 DataArts Insight提供的智能图表可以帮助您直观、清晰地展示数据分析结果。 DataArts Insight提供了多种图表样式，覆盖了表格、线图/面图、柱状图/条形图、指标图、圆盘图、散点图、气泡图等分析图表，满足您灵活多样的可视化分析需求。 数据大屏 DataArts Insight管理控制台数据大屏打造高可视化要求、易上手的大屏搭建工具。 内置丰富的行业模板和素材内容，支持一键安装应用，快速搭建大屏。 将可视化与叙事技术结合，支持多场景、多页面的故事性大屏。 图表配置精细化程度再提升，支持动画效果，更有助于气氛渲染。 数据指标、分析加工一键复用，加工效率高。 智能分析助手 将智能报表转化为智能工具，提供更加直观和高效的数据分析方式。 通过机器学习和数据挖掘，自动发现数据中的关联与趋势，提供有效的洞察与建议。 更多产品功能请参考产品功能。

响应消息 参数说明 表9 参数说明 名称 参数类型 是否必选 描述 id String 否 实例ID。 name String 否 实例名称，与请求参数相同。 datastore Object 否 数据库信息，与请求参数相同。详情请参见表10。 created String 否 创建时间为本地时间，格式为“yyyy-mm-dd hh:mm:ss”。 status String 否 实例状态，取值为“creating”。 region String 否 区域ID，与请求参数相同。 availability_zone String 否 可用区ID，与请求参数相同。 vpc_id String 否 虚拟私有云ID，与请求参数相同。 subnet_id String 否 子网ID，与请求参数相同。 security_group_id String 否 实例所属的安全组ID列表，与请求参数相同。 port Integer 否 数据库访问端口。 disk_encryption_id String 否 磁盘加密的密钥ID，与请求参数相同。 mode String 否 实例类型，与请求参数相同。 configurations Array of objects 否 参数组配置信息。 详情请参见表11。 flavor Array of objects 否 实例规格详情，与请求参数相同。详情请参见表5。 backup_strategy Object 否 高级备份策略，与请求参数相同。详情请参见表6。 enterprise_project_id String 否 企业项目ID。取值为“0”，表示为default企业项目。 dss_pool_id String 否 Dec用户专属存储ID。 job_id String 否 创建实例的工作流ID。 ssl_option String 否 SSL开关选项，与请求参数相同。 tags Array of objects 否 标签列表，与请求参数相同。 详情请参见表14。 order_id String 否 创建实例的订单ID，仅创建包年包月实例时返回该参数。 charge_info Object 否 付费方式信息，与请求参数相同。 详情请参见表15。 表10 datastore字段数据结构说明 名称 参数类型 是否必选 描述 type String 是 数据库版本类型。取值为“DDS-Community”。 version String 是 数据库版本。支持4.4、4.2、4.0、3.4版本，取值为“4.4”、“4.2”、“4.0”、“3.4”。 storage_engine String 是 存储引擎。支持WiredTiger/RocksDB存储引擎。 数据库版本为4.2时，存储引擎为RocksDB，取值为“rocksDB”。 数据库版本为4.0和3.4时，存储引擎为WiredTiger，取值为“wiredTiger”。 表11 configurations字段数据结构说明 参数 参数类型 是否必选 描述 type String 是 节点类型。取值： 集群实例包含mongos、shard和config节点，各节点下该参数取值分别为“mongos”、“shard”和“config”。 副本集实例下该参数取值为“replica”。 单节点实例下该参数取值为“single”。 枚举值： mongos shard config replica single configuration_id String 是 参数组id。 表12 flavor字段数据结构说明 名称 参数类型 是否必选 描述 type String 是 节点类型。 取值： 集群实例包含mongos、shard和config节点，各节点下该参数取值分别为“mongos”、“shard”和“config”。 副本集实例下该参数取值为“replica”。 单节点实例下该参数取值为“single”。 num String 是 节点数量或组数量。 取值： type取值“mongos”，num表示集群实例下mongos节点的数量，取值2~16。 type取值“shard”，num表示集群实例下shard组的数量，取值2~16。 type取值“config”，num表示集群实例下config组的数量，只能取值1。 type取值“replica”，num表示副本集实例下副本节点的数量，可取值3，5，7。 type取值“single”，num表示单节点实例下节点的数量，只能取值1。 storage String 否 磁盘类型。 size String 否 磁盘大小。 对于除mongos外的其他节点，该参数必选。mongos节点下，该参数无意义。 取值：必须为10的整数倍。单位为GB。 对于集群实例，shard组可取10GB~2000GB，config组仅可取20GB。mongos节点不涉及选择磁盘，该参数无意义。 对于副本集实例，可取10GB~3000GB。 对于单节点实例，可取10GB~1000GB。 spec_code String 是 资源规格编码。获取方法请参见查询数据库规格中响应参数“spec_code”的值。 集群实例下，需要指定多个规格，要求所有规格的系列一致，均为通用型（s6）、增强型（c3）、或增强Ⅱ型（c6）。 示例： dds.mongodb.s6.large.4.mongos和dds.mongodb.s6.large.4.config是同一规格系列。 dds.mongodb.s6.large.4.mongos和dds.mongodb.c3.large.4.config不是同一规格系列。 表13 backup_strategy字段数据结构说明 名称 参数类型 是否必选 描述 start_time String 是 备份时间段。自动备份将在该时间段内触发。 取值范围：非空，格式必须为hh:mm-HH:MM，且有效，当前时间指UTC时间。 HH取值必须比hh大1。 mm和MM取值必须相同，且取值必须为00。 不传该参数，默认的备份时间段不传该参数，默认的备份时间段为00:00-01:00。 取值示例： 23:00-00:00 keep_days String 否 指定已生成的备份文件可以保存的天数。 取值范围：0~732。 取0值，表示不设置自动备份策略。 不传该参数，默认开启自动备份策略，备份文件默认保存7天。 表14 tags字段数据结构说明 名称 参数类型 是否必选 描述 key String 是 标签键。最大长度36个unicode字符。 key不能为空，不能为空字符串，不能重复。 字符集：A-Z，a-z ， 0-9，‘-’，‘_’，UNICODE字符（\u4E00-\u9FFF）。 value String 是 标签值。最大长度43个unicode字符。 可以为空字符串。 字符集：A-Z，a-z ， 0-9，‘.’，‘-’，‘_’，UNICODE字符（\u4E00-\u9FFF）。 表15 charge_info字段数据结构说明 参数 参数类型 是否必选 描述 charge_mode String 是 计费模式。 取值范围： prePaid：预付费，即包年/包月。 postPaid：后付费，即按需付费。 period_type String 否 订购周期类型。 “charge_mode”为“prePaid”时生效，且为必选值。 取值范围： month：包月。 year：包年。 period_num Integer 否 “charge_mode”为“prePaid”时生效，且为必选值，指定订购的时间。 取值范围： 当“period_type”为“month”时，取值为1~9。 当“period_type”为“year”时，取值为1~3 is_auto_renew Boolean 否 创建包周期实例时可指定，表示是否自动续订，续订的周期和原周期相同，且续订时会自动支付。 取值范围： true，表示自动续订。 false，表示不自动续订，默认为该方式。 is_auto_pay Boolean 否 创建包周期实例时可指定，表示是否自动从账户中支付，该字段不影响自动续订的支付方式。 取值范围： true，表示自动从账户中支付。 false，表示手动从账户中支付，默认为该支付方式。 响应示例中参数“region”和“availability_zone”的值为示例值。 响应示例 集群实例： { "id": "39b6a1a278844ac48119d86512e0000bin02", "name": "test-cluster-01", "datastore": { "type": "DDS-Community", "version": "3.4", "storage_engine": "wiredTiger" }, "created": "2019-01-16 09:34:36", "status": "creating", "region": "aaa", "availability_zone": "az1xahz", "vpc_id": "490a4a08-ef4b-44c5-94be-3051ef9e4fce", "subnet_id": "0e2eda62-1d42-4d64-a9d1-4e9aa9cd994f", "security_group_id": "2a1f7fc8-3307-42a7-aa6f-42c8b9b8f8c5", "disk_encryption_id": "2gfdsh-844a-4023-a776-fc5c5fb71fb4", "mode": "Sharding", "configurations": [ { "type": "mongos", "configuration_id": "acb288dbd1174f26a8960b45591bd98apr02" }, { "type": "shard", "configuration_id": "5bca546f0be64b038124ef9cedd1bfa1pr02" }, { "type": "config", "configuration_id": "4d123b3ba8294921802b11bf4d8c5735pr02" } ], "flavor": [ { "type": "mongos", "num": "2", "spec_code": "dds.mongodb.c6.medium.4.mongos" }, { "type": "shard", "num": "2", "storage": "ULTRAHIGH", "spec_code": "dds.mongodb.c6.medium.4.shard", "size": "20" }, { "type": "config", "num": "1", "storage": "ULTRAHIGH", "spec_code": "dds.mongodb.c6.large.2.config", "size": "20" } ], "backup_strategy": { "start_time": "08:15-09:15", "keep_days": "8" }, "enterprise_project_id": "", "ssl_option": "1", "dss_pool_id": "f5f84ed7-6f19-4bd4-99d7-b450ad6cc4dd", "job_id": "c010abd0-48cf-4fa8-8cbc-090f093eaa2f", "tags" : [{ "key" : "dds001", "value" : "dds001" }] }

请求示例 集群根据备份文件恢复到新实例： { "name": "test-cluster-01", "datastore": { "type": "DDS-Community", "version": "3.2", "storage_engine": "wiredTiger" }, "region": "aaa", "availability_zone": "az1xahz", "vpc_id": "674e9b42-cd8d-4d25-a2e6-5abcc565b961", "subnet_id": "f1df08c5-71d1-406a-aff0-de435a51007", "security_group_id": "7aa51dbf-5b63-40db-9724-dad3c4828b58", "password": "******", "mode": "Sharding", "configurations": [ { "type": "mongos", "configuration_id": "acb288dbd1174f26a8960b45591bd98apr02" }, { "type": "shard", "configuration_id": "5bca546f0be64b038124ef9cedd1bfa1pr02" }, { "type": "config", "configuration_id": "4d123b3ba8294921802b11bf4d8c5735pr02" } ], "flavor": [ { "type": "mongos", "num": "2", "spec_code": "dds.mongodb.c6.medium.4.mongos" }, { "type": "shard", "num": 2, "storage": "ULTRAHIGH", "size": 20, "spec_code": "dds.mongodb.c6.medium.4.shard" }, { "type": "config", "num": 1, "storage": "ULTRAHIGH", "size": 20, "spec_code": "dds.mongodb.c6.large.2.config" } ], "backup_strategy": { "start_time": "08:15-09:15", "keep_days": "8" }, "ssl_option": "1", "dss_pool_id": "f5f84ed7-6f19-4bd4-99d7-b450ad6cc4dd", "server_group_policies": [ "anti-affinity" ], "tags": [ { "key": "dds001", "value": "dds001" } ] } 副本集根据备份文件恢复到新实例： { "name": "test-replicaset", "datastore": { "type": "DDS-Community", "version": "3.4", "storage_engine": "wiredTiger" }, "region": "aaa", "availability_zone": "az1xahz", "vpc_id": "674e9b42-cd8d-4d25-a2e6-5abcc565b961", "subnet_id": "f1df08c5-71d1-406a-aff0-de435a51007", "security_group_id": "7aa51dbf-5b63-40db-9724-dad3c4828b58", "password": "******", "mode": "ReplicaSet", "configurations": [ { "type": "replica", "configuration_id": "f17e3aad778440fbb68603c8c9032003pr02" } ], "flavor": [ { "type": "replica", "num": "1", "storage": "ULTRAHIGH", "size": "30", "spec_code": "dds.mongodb.s2.medium.4.shard" } ], "backup_strategy": { "start_time": "08:15-09:15", "keep_days": "8" }, "ssl_option": "1", "tags" : [{ "key" : "dds001", "value" : "dds001" }] } 单节点根据备份文件恢复到新实例： { "name": "test-singlenode", "datastore": { "type": "DDS-Community", "version": "3.2", "storage_engine": "wiredTiger" }, "region": "aaa", "availability_zone": "az1xahz", "vpc_id": "674e9b42-cd8d-4d25-a2e6-5abcc565b961", "subnet_id": "f1df08c5-71d1-406a-aff0-de435a51007", "security_group_id": "7aa51dbf-5b63-40db-9724-dad3c4828b58", "password": "******", "mode": "Single", "configurations": [ { "type": "single", "configuration_id": "b8e962e66ede47609a94cba591735b49pr02" } ], "flavor": [ { "type": "single", "num": "1", "storage": "ULTRAHIGH", "size": "30", "spec_code": "dds.mongodb.c6.medium.4.single" } ], "backup_strategy": { "start_time": "08:15-09:15", "keep_days": "8" }, "ssl_option": "1", "tags" : [{ "key" : "dds001", "value" : "dds001" }] } 副本集根据时间点恢复到新实例： { "name": "replica-liuyunj1", "datastore": { "type": "DDS-Community", "version": "3.2", "storage_engine": "wiredTiger" }, "region": "aaa", "availability_zone": "az1xahz", "vpc_id": "dcdadabc-efed-4518-8b34-4af66fcd97e7", "subnet_id": "4a9348f2-f232-4700-a440-2f1641d80960", "security_group_id": "c57b9db2-cccb-4c0d-b058-7ea51dda0c99", "flavor": [ { "type": "replica", "num": 1, "storage": "ULTRAHIGH", "size": 100, "spec_code": "dds.mongodb.c6.large.2.repset" } ], "backup_strategy": { "start_time": "08:00-09:00", "keep_days": "8" }, "ssl_option": "1", "tags" : [{ "key" : "dds001", "value" : "dds001" }] }

AK/SK认证 AK/SK签名认证方式仅支持消息体大小12MB以内，12MB以上的请求请使用Token认证。 AK/SK认证就是使用AK/SK对请求进行签名，在请求时将签名信息添加到消息头，从而通过身份认证。 AK(Access Key ID)：访问密钥ID。与私有访问密钥关联的唯一标识符；访问密钥ID和私有访问密钥一起使用，对请求进行加密签名。 SK(Secret Access Key)：与访问密钥ID结合使用的密钥，对请求进行加密签名，可标识发送方，并防止请求被修改。 使用AK/SK认证时，您可以基于签名算法使用AK/SK对请求进行签名，也可以使用专门的签名SDK对请求进行签名。详细的签名方法和SDK使用方法请参见API签名指南。 签名SDK只提供签名功能，与服务提供的SDK不同，使用时请注意。

Token认证 Token的有效期为24小时，需要使用同一个Token鉴权时，可以缓存起来，避免频繁调用。 Token在计算机系统中代表令牌（临时）的意思，拥有Token就代表拥有某种权限。Token认证就是在调用API的时候将Token加到请求消息头，从而通过身份认证，获得操作API的权限。 Token可通过调用获取用户Token接口获取，调用本服务API需要project级别的Token，即调用获取用户Token接口时，请求body中“auth.scope”的取值需要选择“project”，请求示例如下。 { "auth": { "identity": { "methods": ["password"], "password": { "user": { "name": "username", //替换为实际用户名 "password": "**********",//替换为实际的用户密码 "domain": { "name": "domianname" //替换为实际账号名 } } } }, "scope": { "project": { "name": "cn-north-1 " //替换为实际的project name，获取作用范围为指定project的Token } } } } 获取Token后，再调用其他接口时，您需要在请求消息头中添加“X-Auth-Token”，其值即为获取到的Token。例如Token值为“ABCDEFJ....”，则调用接口时将“X-Auth-Token: ABCDEFJ....”加到请求消息头即可，如下所示。 GET https://iam.cn-north-1.myhuaweicloud.com/v3/auth/projects Content-Type: application/json X-Auth-Token: ABCDEFJ....

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 service_id String 服务ID service_name String 服务名称 logo String 算法图标，Base64编码格式的字符串，非空时返回 function_version String 功能版本 release_flag Boolean 是否已发布，取值为“true”或者“false” description String 算法描述，非空时返回 created_at Long 创建时间 updated_at Long 更新时间 release_at Long 发布时间 api String API pool_id String 资源池ID alg_name String 算法名称 alg_id String 算法ID request_mode String 请求模式，取值为“sync”或者“async” package_name String 算法包名称 package_id String 算法包ID alg_version String 算法版本 alg_versions Array of strings 算法历史版本 diagram String 算法场景图，Base64编码格式的字符串，非空时返回 service_api_list Array of ServiceApiDto objects 服务API列表 deployment_constraints DeploymentConstraintsDto object 模型部署约束 company String 厂商名称 tags Array of strings 应用场景标签 deploy_type String 部署类型，取值为“cloud”或者“edge” alg_class String 算法类别，取值为“self”或者“partner” alg_status String 算法状态，取值为“service_running”、“service_deploying”、“service_failed”、“service_stopping”、“service_stopped”、“service_upgrading”、“service_finished”、“service_concerning”或者“not_deployed” error_msg String 服务异常信息，非空时返回 表4 ServiceApiDto 参数 参数类型 描述 request_type String 请求类型，get, post zh String 中文描述 en String 英文描述 request_url String 请求url 表5 DeploymentConstraintsDto 参数 参数类型 描述 request_mode String 请求模式，取值为“sync”或者“async” cpu_type String CPU类型，取值为“x86_64”或者“aarch64” accelerators Array of AcceleratorsDto objects 推理加速卡 input_types Array of strings 支持的输入类型，列表元素取值为“OBS”、“URL”、“Restful”、“VCN”、“EdgeCamera” output_types Array of strings 支持的输出类型，列表元素取值为“OBS”、“DIS”或者“Webhook” service_config String 服务启动参数 task_config String 作业配置参数 表6 AcceleratorsDto 参数 参数类型 描述 type String 加速卡类型 最小长度：1 最大长度：256 name String 加速卡名称 最小长度：1 最大长度：256 cuda_version String CUDA版本 最小长度：1 最大长度：256 driver_version_section String 昇腾驱动版本 最小长度：1 最大长度：256

操作步骤 登录管理控制台。 鼠标移动到右上角的用户名上，在下拉列表中选择“我的凭证”。 在“我的凭证”页面，可以查看用户名、账号名，在项目列表中查看项目ID。 图1 查看项目ID 单击“管理访问密钥”，可以查看已添加的访问密钥ID（Access Key ID，AK）。 如果没有AK/SK，可单击“新增访问密钥”来添加。 如果已生成过AK/SK，找到原来已下载的AK/SK文件，文件名一般为：credentials.csv。

请求消息头 附加请求头字段，如指定的URI和HTTP方法所要求的字段。例如定义消息体类型的请求头“Content-Type”，请求鉴权信息等。 需要添加到请求中的公共消息头如表3所示。 表3 公共请求消息头 参数名 说明 是否必选 示例 Content-type 消息体的类型（格式），默认取值为“application/json”。 是 application/json Content-Length 请求body长度，单位为Byte。 POST/PUT请求必填。GET不能包含。 3495 X-Project-Id project id，用于不同project取token。 否 e9993fc787d94b6c886cbaa340f9c0f4 X-Auth-Token 用户Token，也就是调用获取用户Token接口的响应值，该接口是唯一不需要认证的接口。 否 使用Token认证时必选。 - X-Sdk-Date 请求的发生时间，格式为(YYYYMMDD'T'HHMMSS'Z')。 取值为当前系统的GMT时间。 否 如果使用ak/sk做接口认证的时候，那么此字段必须设置；如果使用PKI token的时候，不必设置。 20190307T101459Z Authorization 签名认证信息。 该值来源于请求签名结果，使用AK/SK进行加密签名的时候需要。 类型：字符串 默认值：无 否 使用AK/SK认证时必选。 SDK-HMAC-SHA256 Credential=ZIRRKMTWPTQFQI1WKNKB/20150907//ec2/sdk_request, SignedHeaders=content-type;host;x-sdk-date, Signature=55741b610f3c9fa3ae40b5a8021ebf7ebc2a28a603fc62d25cb3bfe6608e1994 Host 请求的服务器信息，从服务API的URL中获取。 值为hostname[:port]。 端口缺省时使用默认的端口，https的默认端口为443。 否 使用AK/SK认证时必选。 code.test.com or code.test.com:443 公有云API同时支持使用AK/SK认证，AK/SK认证是使用SDK对请求进行签名，签名过程会自动往请求中添加Authorization（签名认证信息）和X-Sdk-Date（请求发送的时间）请求头。AK/SK认证的详细说明请参见API签名指南。 对于获取用户Token接口，由于不需要认证，所以只添加“Content-Type”即可，添加消息头后的请求如下所示。 POST https://iam.cn-north-1.myhuaweicloud.com/v3/auth/tokens Content-Type: application/json

请求消息体 请求消息体通常以结构化格式发出，与请求消息头中Content-type对应，传递除请求消息头之外的内容。若请求消息体中参数支持中文，则中文字符必须为UTF-8编码。 每个接口的请求消息体内容不同，也并不是每个接口都需要有请求消息体（或者说消息体为空），GET、DELETE操作类型的接口就不需要消息体，消息体具体内容需要根据具体接口而定。 对于获取用户Token接口，您可以从接口的请求部分看到所需的请求参数及参数说明。将消息体加入后的请求如下所示。 加粗的斜体字段需要根据实际值填写，其中username为用户名，domainname为用户所属的账号名称，********为用户登录密码，cn-north-1为project的name，获取方法请参见获取用户名、账号名和项目name。 scope参数定义了Token的作用范围，取值为project或domain，示例中取值为project，表示获取的Token仅能访问指定project下的资源，取值为domainname时，表示获取的token可以访问指定账号下所有资源，scope参数的详细说明，请参见获取用户Token接口。 POST https://iam.cn-north-1.myhuaweicloud.com/v3/auth/tokens Content-Type:application/json { "auth": { "identity": { "methods": ["password"], "password": { "user": { "name": "username", //替换为实际用户名 "password": "**********",//替换为实际的用户密码 "domain": { "name": "domianname" //替换为实际账号名 } } } }, "scope": { "project": { "name": "cn-north-1" //替换为实际的project name，获取作用范围为指定project的Token } } } } 到这里为止这个请求需要的内容就具备齐全了，您可以使用curl、Postman或直接编写代码等方式发送请求调用API，Postman建议使用7.24.0版本。 对于获取用户Token接口，返回的响应消息头中“x-subject-token”的值，就是需要获取的用户Token。有了Token之后，您就可以使用Token认证调用其他API。

请求URI 请求URI由如下部分组成。 {URI-scheme} :// {Endpoint} / {resource-path} ? {query-string} 表1 请求URI 参数 说明 URI-scheme 传输请求的协议，当前所有API均采用HTTPS协议。 Endpoint 承载REST服务端点的服务器域名或IP，不同服务在不同区域时，对应Endpoint不同，可以从终端节点中获取。 例如视频智能分析服务在“华北-北京一”区域的Endpoint为“iam.cn-north-1.myhuaweicloud.com”。 resource-path 资源路径，即API访问路径。从具体API的URI模块获取，例如“获取用户Token”API的resource-path为“/v3/auth/tokens”。 query-string 查询参数，可选，查询参数前面需要带一个“？”，形式为“参数名=参数取值”，例如“limit=10”，表示查询不超过10条数据。 例如您需要获取“华北-北京一”区域的Token，则需使用“华北-北京一”区域的Endpoint（iam.cn-north-1.myhuaweicloud.com），并在获取用户Token的URI部分找到resource-path（/v3/auth/tokens），拼接起来如下所示。 https://iam.cn-north-1.myhuaweicloud.com/v3/auth/tokens 图1 URI示意图 为查看方便，服务每个具体API的URI，只给出resource-path部分，并将请求方法写在一起。这是因为URI-scheme都是HTTPS，而Endpoint在同一个区域也相同，所以简洁起见将这两部分省略。