华为云用户手册

约束与限制 云审计服务中的追踪器数量和关键操作通知有限定的配额，均不支持修改，云审计服务的具体限制如下。 表1 CTS约束与限制 限制项 最大值 一个华为云账号允许创建的追踪器数目 管理追踪器：1个 数据追踪器：100个 一个华为云账号允许配置的关键操作通知数目 100个 一个追踪器允许配置的OBS桶数目 1个 用户操作后多久才能通过控制台查询数据 管理类事件：1分钟 数据类事件：5分钟 组织成员退出组织或被移除组织后，组织追踪器的收回时间 5分钟 用户通过控制台能查询多久的操作事件 说明： 云审计默认为每个华为云账号记录最近7天的操作事件，如果不配置转储，您将无法追溯7天以前的操作事件。 7天

细粒度权限说明 使用自定义细粒度策略，请使用管理员用户进入统一身份认证（IAM）服务，按需选择CTS的细粒度权限进行授权操作。CTS细粒度权限说明请参见表3。 表3 CTS细粒度权限说明 权限名称 权限描述 权限依赖 应用场景 cts:quota:get 查询租户追踪器配额信息 - 查询租户追踪器配额信息 cts:trace:list 查询审计事件 - 查出系统记录的7天内资源操作记录 cts:trace:listResource - cts:trace:listTraceUser - cts:notification:create 创建关键操作通知 smn:topic:listTopic iam:agencies:listAgencies iam:agencies:createAgency iam:permissions:grantRoleToAgencyOnProject iam:permissions:listRolesForAgencyOnProject iam:projects:listProjects iam:groups:listGroups iam:users:listUsers iam:users:listUsersForGroup 创建关键操作通知 cts:notification:update 修改关键操作通知 修改关键操作通知 cts:notification:delete 删除关键操作通知 - 删除关键操作通知 cts:notification:list 查询所有关键操作通知 - 查询所有关键操作通知 cts:tracker:delete 删除追踪器 - 删除已创建的追踪器 cts:tracker:update 更新追踪器 iam:agencies:listAgencies iam:agencies:createAgency iam:permissions:grantRoleToAgencyOnProject iam:permissions:listRolesForAgencyOnProject iam:projects:listProjects iam:groups:listGroups iam:users:listUsersForGroup lts:topics:list lts:topics:create lts:topics:get lts:logstreams:list lts:groups:get lts:groups:list lts:groups:create obs:bucket:CreateBucket obs:bucket:HeadBucket obs:bucket:GetLifecycleConfiguration obs:bucket:PutLifecycleConfiguration obs:bucket:GetBucketAcl obs:bucket:PutBucketAcl obs:bucket:ListAllMyBuckets kms:cmk:list kms:cmk:get eps:enterpriseProjects:list organizations:trustedServices:list organizations:organizations:get organizations:deletgatedAdministrators:list organizations:accounts:list organizations:deletgatedServices:list 修改已创建追踪器的配置项 cts:tracker:create 创建追踪器 创建一个追踪器用来关联系统记录的所有操作 cts:tracker:list 查询所有追踪器 obs:bucket:GetBucketAcl obs:bucket:ListAllMyBuckets 查看追踪器的详细信息 cts:tag:create 批量添加资源标签 - 批量添加资源标签 cts:tag:delete 批量删除资源标签 - 批量删除资源标签

CTS权限 默认情况下，新建的IAM用户没有任何权限，您需要将其加入用户组，并给用户组授予策略或角色，才能使得用户组中的用户获得对应的权限，这一过程称为授权。授权后，用户就可以基于被授予的权限对云服务进行操作。 CTS部署时通过物理区域划分，为项目级服务。授权时，“作用范围”需要选择“区域级项目”，然后在指定区域（如华北-北京1）对应的项目（cn-north-1）中设置相关权限，并且该权限仅对此项目生效；如果在“所有项目”中设置权限，则该权限在所有区域项目中都生效。访问CTS时，需要先切换至授权区域。 权限根据授权精细程度分为角色和策略，策略是角色的升级版。 角色：IAM最初提供的一种根据用户的工作职能定义权限的粗粒度授权机制。该机制以服务为粒度，提供有限的服务相关角色用于授权。由于华为云各服务之间存在业务依赖关系，因此给用户授予角色时，可能需要一并授予依赖的其他角色，才能正确完成业务。角色并不能满足用户对精细化授权的要求，无法完全达到企业对权限最小化的安全管控要求。 策略：IAM最新提供的一种细粒度授权的能力，可以精确到具体服务的操作、资源以及请求条件等。基于策略的授权是一种更加灵活的授权方式，能够满足企业对权限最小化的安全管控要求。例如：针对ECS服务，CTS管理员能够控制IAM用户仅能对某一类云服务器资源进行指定的管理操作。多数细粒度策略以API接口为粒度进行权限拆分。 如表1所示，包括了CTS的所有系统权限。 表1 CTS系统权限 系统角色/策略名称 描述 类别 依赖关系 CTS FullAccess 云审计服务的所有权限。 系统策略 无 CTS ReadOnlyAccess 云审计服务的只读权限。 系统策略 无 CTS Administrator 云审计服务的管理员权限，拥有CTS的所有权限。 拥有该权限的用户拥有除IAM外，其他所有服务的只读权限。 系统角色 该角色有依赖，需要在同项目中勾选依赖的角色：Tenant Guest、OBS Administrator和Security Administrator。 表2列出了CTS常用操作与系统权限的授权关系，您可以参照该表选择合适的系统权限。 表2 常用操作与系统权限的关系 操作 CTS FullAccess CTS ReadOnlyAccess CTS Administrator 查询事件列表 √ √ √ 查询配额 √ √ √ 创建追踪器 √ × √ 修改追踪器 √ × √ 停用追踪器 √ × √ 启用追踪器 √ × √ 查询追踪器 √ √ √ 删除追踪器 √ × √ 创建关键操作通知 √ × √ 修改关键操作通知 √ × √ 停用关键操作通知 √ × √ 启用关键操作通知 √ × √ 查询关键操作通知 √ √ √ 删除关键操作通知 √ × √

操作场景 当您在应用设计态完成应用的构建和发布后，需要将已发布的应用代码包部署至工业数字模型驱动引擎-数据建模引擎（xDM Foundation，简称xDM-F），才可在应用运行态调用API和管理应用的模型数据。 应用部署完成后，应用运行态会自动加载应用代码包，同步部署应用时选择的已发布版本应用代码包，初始化应用运行态。初始化过程中，可能受网络不稳定或其他因素影响，导致应用运行态的API和模型数据出现异常。xDM-F提供初始化异常监控服务，可视化展示应用运行态初始化异常的原因，支持手动重新加载应用代码包。

后续操作 完成实例创建后，我们可根据实际需求进行管理文件，例如下载文件、预览图片类型文件等操作。 下载文件：在数据实例页面，选择实例的唯一编码，并在展开的实例数据页面下载相应的文件。支持下载单个文件和下载全部文件。 文件闪传：如果实例中已上传某个文件，后续再上传该文件时，该文件具有闪传能力。例如在实例中上传了A文件，后续再上传A文件时，该A文件具有闪传能力。 预览文件（图片）：在实例中上传文件后，会生成一个可获取文件路径的接口，其接口格式为：数据建模引擎所在域名或IP地址/rdm_应用ID_app/services/rdm/basic/api/file/images?fileId=（文件ID），我们可通过该接口进行预览。

开发环境 开发过程中，您有任何问题可以在华为云工业数字模型驱动引擎论坛中发帖求助。 从Oracle官网下载并安装推荐使用的JDK版本。 推荐使用的JDK版本：JDK 8 以上版本。 根据开发需要，下载并安装开发工具。 从Eclipse官网下载并安装Eclipse IDE for Java Developers最新版本。 从IntelliJ IDEA官网下载并安装IntelliJ IDEA开发工具。

计费场景1-包年/包月的iDME商品 某用户于2023/03/18 15:30:00购买了一个包年/包月的iDME商品，计费时长为1个月，如基础版数据建模引擎，用于部署在公有云上，购买规格配置如下： 基础版 数据建模引擎 节点：2个 基础版 数据建模引擎 用户：5人 用了一段时间后，用户发现iDME服务当前规格无法满足业务需要，于2023/03/20 9:00:00升级规格为基础版 数据建模引擎 节点*4，基础版 数据建模引擎 用户*10，并加购以下增量包类型及数量进行扩容。 结构化数据增量包(20GB）：2个 文件数据增量包(500GB)：1个 基线数据增量包(20GB*2)：1个 那么该服务总共需要支付多少费用呢？

计费构成分析-按需计费的iDME商品 按需计费iDME资源变更配置后，会产生一个新订单并开始按新配置的价格计费，旧订单自动失效。您可以将服务的使用阶段按照计费信息条数分为多个计费周期。 第一个计费周期为9:00:00 ~ 10:00:00，在9:00:00 ~ 10:00:00间产生费用，该计费周期内的计费时长为3600秒。 第二个计费周期为10:00:00 ~ 11:00:00，在10:00:00 ~ 10:45:46间产生费用，该计费周期内的计费时长为2746秒。 您需要为每个计费周期付费，数字主线引擎各服务能力的计费公式如表1所示。产品价格详情中标出了单位MCU的每小时价格，您需要将每小时价格除以3600，得到每秒价格。 表1 计费公式 服务能力类型 计费公式 数字主线模型 MCU单价*MCU数量*计费时长 数字主线算力 MCU单价*MCU数量*计费时长 数字主线容量 MCU单价*MCU数量*计费时长 图1给出了上述示例配置的费用计算过程。 图中价格仅供参考。 图1 按需计费的iDME费用计算示例

计费场景2-按需计费的iDME商品 某用户于2023/04/18 9:00:00购买了一个按需计费的iDME商品，如数字主线引擎，MCU分配规格配置如下： 数字主线模型：3MCU 数字主线算力：3MCU 数字主线容量：1MCU 用了一段时间后，用户发现iDME服务当前规格无法满足业务需要，于2023/04/18 10:00:00升级规格为数字主线模型3MCU、数字主线算力3MCU和数字主线容量2MCU。后因业务中断然后在2023/04/18 10:45:46将其删除。那么该服务的费用如何计算呢？

计费构成分析-包年/包月的iDME商品 以下计算价格仅作示例用，非官网实际价格，实际价格请参考工业数字模型驱动引擎价格详情。 可以将服务的使用阶段按照购买次数分为两段：2023/03/18 15:30:00 ~ 2023/04/18 23:59:59期间为初次购买的包年/包月计费，2023/03/20 9:00:00 ~ 2023/04/18 23:59:59期间二次购买，计升配费用，计费时长为剩余周期。 在2023/03/18 15:30:00 ~ 2023/04/18 23:59:59期间初次购买，为包年/包月计费，计费时长为1个月。费用计算如下： 在2023/03/20 9:00:00 ~ 2023/04/18 23:59:59期间二次购买，计升配费用，计费时长为剩余周期。费用计算如下： 根据资源升配的计费公式，可知： 剩余周期 = 11 / 31 + 18 / 30 = 0.9548（月） 其中，11表示3月份剩余天数，31表示3月份最大天数；18表示4月份剩余天数，30表示4月份最大天数。 升配费用 = (52,168 - 25,950) * 0.9548 = 25,032.95（元） 由此可见，在3~4月份，该iDME服务总共产生的费用为：25,950 + 25,032.95 = 50,982.95（元）。

适用计费项 数字主线引擎只有为各服务能力，即数字主线模型、数字主线容量和数字主线算力进行MCU分配后，才能确定一个数字主线引擎的具体服务规格。以下计费项支持按需计费。 表1 适用计费项 计费项 说明 数字主线引擎 MCU 随按需计费的数字主线引擎进行MCU分配的各服务能力，其计费模式也为按需计费。 假设您计划购买一个数字主线引擎，并同时进行MCU分配，规格如数字主线模型3MCU、数字主线算力3MCU和数字主线容量2MCU。在购买iDME服务页面底部，您将看到所需的费用，如图1所示。 图1 配置费用示例

计费周期 按需计费iDME商品按秒计费，每一个小时整点结算一次费用（以GMT+8时间为准），结算完毕后进入新的计费周期。计费的起点以iDME资源创建成功的时间点为准，终点以资源开始删除时间为准。 iDME从下单到资源创建成功需要一定时长，计费的起点是资源创建成功的时间点，而非下单时间。 例如，您在8:45:30创建成功一个按需计费的数字主线引擎，然后在8:55:30将其删除，则计费周期为8:00:00 ~ 9:00:00，在8:45:30 ~ 8:55:30间产生费用，该计费周期内的计费时长为600秒。

变更配置后对计费的影响 当前按需计费的iDME商品规格不满足您的业务需要时，您可以在iDME控制台发起变更操作。按需计费的iDME商品仅支持资源升配，不支持资源降配。 如果您在购买按需计费iDME资源后变更了配置，会产生一个新订单并开始按新配置的价格计费，旧订单自动失效。 如果您在一个小时内变更了配置，将会产生多条计费信息。每条计费信息的开始时间和结束时间对应不同配置在该小时内的生效时间。 这里以资源升配且无任何优惠的场景为例，计算价格仅作示例用，非官网实际价格。 例如，您在9:00:00购买了一台按需计费的数字主线引擎，MCU分配规格为数字主线模型3MCU、数字主线算力3MCU和数字主线容量1MCU，并在9:30:00升配规格为数字主线模型3MCU、数字主线算力3MCU和数字主线容量2MCU，那么在9:00:00 ~ 10:00:00间会产生两条计费信息。 第一条对应9:00:00 ~ 9:30:00，规格按照数字主线模型3MCU、数字主线算力3MCU和数字主线容量1MCU计费。 第二条对应9:30:00 ~ 10:00:00，规格按照数字主线模型3MCU、数字主线算力3MCU和数字主线容量2MCU计费。

到期后影响 图2描述了包年/包月的iDME商品各个阶段的状态。购买后，在计费周期内正常运行，此阶段为有效期；资源到期而未续费时，将陆续进入宽限期和保留期。 图2 包年/包月的iDME商品生命周期 到期预警 包年/包月的iDME商品在到期前第7天内，系统将向用户推送到期预警消息。预警消息将通过邮件、短信和站内信的方式通知到华为账号的创建者。 到期后影响 当您的包年/包月的iDME商品到期未续费，首先会进入宽限期，宽限期内您可以正常访问iDME的对应资源。 如果您在宽限期内仍未续费包年/包月的iDME商品，那么就会进入保留期。保留期内，数据仍予以保留，但是您将无法访问处在保留期的商品，介时将影响使用。 保留期到期后，如果包年/包月的iDME商品仍未续费，对应的iDME商品将终止服务，系统中的数据也将被永久删除且无法恢复。 华为云根据客户等级定义了不同客户的宽限期和保留期时长。 关于续费的详细介绍请参见续费概述。

变更配置后对计费的影响 当前包年/包月的iDME商品规格不满足您的业务需要时，您可以在iDME控制台发起变更或扩容操作。包年/包月的iDME商品仅支持资源升配，不支持资源降配。 资源升配的计算公式： 升配费用 =（新配置价格 - 旧配置价格）* 剩余周期 其中，剩余周期 = 每个自然月的剩余天数 / 对应自然月的最大天数。 这里以资源升配且无任何优惠的场景为例，计算价格仅作示例用，非官网实际价格，实际价格请参考工业数字模型驱动引擎价格详情。 假设您在2023/04/08购买了一个包年/包月的用于部署在公有云上的基础版数据建模引擎，并同时购买节点*1和读写用户*1，购买时长为1个月。在2023/04/18变更规格为节点*2和读写用户*2。旧配置价格为12,750.00元/月，新配置价格为25,500.00元/月。 剩余周期 = 12 / 30 + 8 / 31 = 0.6581（月） 其中，12表示4月份剩余天数，30表示4月份最大天数；8表示5月份剩余天数，31表示5月份最大天数。 升配费用 = (25,500 - 12,750) * 0.6581 = 8,392.78（元） 更多信息请参见变更资源规格费用说明。

使用限制 随基础版数据建模引擎购买时所配置的节点、增量包（可选）和用户资源不支持转移，后续变更规格或扩容时仅支持资源升配，不支持资源降配。即变更规格或扩容时，节点、增量包和用户数量可以增加，不可以减少。 此处以部署在公有云上为例，某用户依次购买了两套基础版数据建模引擎，分别命名为测试运行服务和生产运行服务。其中，测试运行服务在购买时配置了一个节点和一个用户，生产运行服务配置了三个节点、每种类型增量包各一个和三个用户。在使用过程中，用户发现测试运行服务的规格无法满足业务需要。此时，仅支持用户通过变更规格或扩容进行资源升配，增加测试运行服务中的节点、增量包和用户数量。但不支持将生产运行服务中的节点、增量包和用户资源转移到测试运行服务。

适用计费项 基础版数据建模引擎只有同时配置节点、增量包（可选）和用户，才能确定一个数据建模引擎的具体服务形态。以下计费项支持包年/包月。 表1 适用计费项 计费项 说明 基础版 数据建模引擎 节点 随包年/包月的数据建模引擎配置的节点，部署在公有云上，其计费模式也为包年/包月。 价格随购买节点数量增加而倍数递增。 基础版 数据建模引擎 用户 随包年/包月的数据建模引擎配置的用户，部署在公有云上，其计费模式也为包年/包月。 价格随购买用户数量增加而倍数递增。 结构化数据增量包(20GB） 随包年/包月的“基础版 数据建模引擎 节点”扩容使用的结构化数据增量包，其计费模式也为包年/包月。 价格随购买结构化数据增量包数量增加而倍数递增。 文件数据增量包(500GB) 随包年/包月的“基础版 数据建模引擎 节点”扩容使用的文件数据增量包，其计费模式也为包年/包月。 价格随购买文件数据增量包数量增加而倍数递增。 基线数据增量包(20GB*2) 随包年/包月的“基础版 数据建模引擎 节点”扩容使用的基线数据增量包，其计费模式也为包年/包月。 价格随购买基线数据增量包数量增加而倍数递增。 基础版 数据建模引擎 边缘节点 随包年/包月的数据建模引擎配置的边缘节点，部署在边缘云上，其计费模式也为包年/包月。 价格随购买节点数量增加而倍数递增。 基础版 数据建模引擎 边缘用户 随包年/包月的数据建模引擎配置的边缘用户，部署在边缘云上，其计费模式也为包年/包月。 价格随购买用户数量增加而倍数递增。 假设您计划购买一个用于部署在公有云上的基础版数据建模引擎，并同时购买一个基础版节点、每种类型的增量包各一个和一个基础版用户。在购买iDME服务页面底部，您将看到所需费用的明细，如图1所示。 图1 配置费用示例 配置费用将包括以下部分： 基础版节点：根据所选服务对应的节点类型计算的费用。 基础版读写用户：根据所选服务对应的用户类型计算的费用。 增量包：根据所选服务对应的增量包类型分别计算的费用。

适用场景 包年/包月的iDME商品当前是指用于运行iDME应用的基础版数据建模引擎。一套基础版数据建模引擎中至少需要同时包含节点和用户资源，以保证应用能正常运行和被用户操作。 节点：表示应用运行所需的一组固定规格的底层云服务组合（包含计算资源、数据库等）。 用户：表示使用您的应用程序的个人。 当公有云场景下的“基础版 数据建模引擎 节点”提供的规格无法满足使用需求时，您可选择变更或扩容。变更节点数量可同时增加节点的计算资源和数据容量，如果仅需增加节点的数据容量，您可使用增量包灵活扩容对应类型的数据容量。 结构化数据增量包(20GB)：此类型增量包可对节点的结构化数据容量进行扩容。单个结构化数据增量包可提供20GB的结构化数据容量。 文件数据增量包(500GB)：此类型增量包可对节点的文件数据容量进行扩容。单个文件数据增量包可提供500GB的文件数据容量。 基线数据增量包(20GB*2)：此类型增量包可对节点的基线数据容量进行扩容。单个基线数据增量包可提供40GB的基线数据容量。

请求消息体（可选） 该部分可选。请求消息体通常以结构化格式（如JSON或XML）发出，与请求消息头中Content-Type对应，传递除请求消息头之外的内容。若请求消息体中的参数支持中文，则中文字符必须为UTF-8编码。 每个接口的请求消息体内容不同，也并不是每个接口都需要有请求消息体（或者说消息体为空），GET、DELETE操作类型的接口就不需要消息体，消息体具体内容需要根据具体接口而定。 对于获取用户Token接口，您可以从接口的请求部分看到所需的请求参数及参数说明。将消息体加入后的请求如下所示，加粗的斜体字段需要根据实际值填写，其中username为用户名，domainname为用户所属的账号名称，********为用户登录密码，xxxxxxxxxxxxxxxxxx为project的名称，如“cn-north-1”，您可以从地区和终端节点获取。 scope参数定义了Token的作用域，下面示例中获取的Token仅能访问project下的资源。您还可以设置Token的作用域为某个账号下所有资源或账号的某个project下的资源，详细定义请参见获取用户Token。 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 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": "domainname" } } } }, "scope": { "project": { "name": "xxxxxxxxxxxxxxxxxx" } } } } 到这里为止这个请求需要的内容就具备齐全了，您可以使用curl、Postman或直接编写代码等方式发送请求调用API。对于获取用户Token接口，返回的响应消息头中的“x-subject-token”就是需要获取的用户Token。有了Token之后，您就可以使用Token认证调用其他API。

请求消息头 附加请求头字段，如指定的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

请求方法 HTTP请求方法（也称为操作或动词），它告诉服务您正在请求什么类型的操作。 表2 HTTP方法 方法 说明 GET 请求服务器返回指定资源。 PUT 请求服务器更新指定资源。 POST 请求服务器新增资源或执行特殊操作。 DELETE 请求服务器删除指定资源，如删除对象等。 HEAD 请求服务器资源头部。 PATCH 请求服务器更新资源的部分内容。 当资源不存在的时候，PATCH可能会去创建一个新的资源。 在获取用户Token的URI部分，您可以看到其请求方法为“POST”，则其请求为： 1 POST https://iam.cn-north-1.myhuaweicloud.com/v3/auth/tokens

请求URI 请求URI由如下部分组成： {URI-scheme}://{Endpoint}/{resource-path}?{query-string} 尽管请求URI包含在请求消息头中，但大多数语言或框架都要求您从请求消息中单独传递它，所以在此单独强调。 表1 URI中的参数说明 参数 描述 URI-scheme 表示用于传输请求的协议，当前所有API均采用HTTPS协议。 Endpoint 指定承载REST服务端点的服务器域名或IP，不同服务不同区域的Endpoint不同，您可以从地区和终端节点获取。 例如IAM服务在“华北-北京四”区域的Endpoint为“iam.cn-north-4.myhuaweicloud.com”。 resource-path 资源路径，即API访问路径。从具体API的URI模块获取，例如“获取用户Token”API的resource-path为“/v3/auth/tokens”。 query-string 查询参数，是可选部分，并不是每个API都有查询参数。查询参数前面需要带一个“?”，形式为“参数名=参数取值”，例如“?limit=10”，表示查询不超过10条数据。 例如您需要获取IAM在“华北-北京四”区域的Token，则需使用“华北-北京四”区域的Endpoint（iam.cn-north-4.myhuaweicloud.com），并在获取用户Token的URI部分找到resource-path（/v3/auth/tokens），拼接起来如下所示。 1 https://iam.cn-north-4.myhuaweicloud.com/v3/auth/tokens 图1 URI示意图 为方便查看，在每个具体API的URI部分，只给出resource-path部分，并将请求方法写在一起。这是因为URI-scheme都是HTTPS，而Endpoint在同一个区域也相同，所以简洁起见将这两部分省略。

调用API获取项目ID 您还能通过调用查询指定条件下的项目信息API获取项目ID。 获取项目ID的接口为“GET https://{Endpoint}/v3/projects/”，其中{Endpoint}为IAM的终端节点，可以从地区和终端节点获取。接口的认证鉴权请参见认证鉴权。 响应示例如下，其中projects下的“id”即为项目ID。 { "projects": [ { "domain_id": "65382450e8f64ac0870cd180d14e684b", "is_domain": false, "parent_id": "65382450e8f64ac0870cd180d14e684b", "name": "region01", "description": "", "links": { "next": null, "previous": null, "self": "https://www.example.com/v3/projects/a4a5d4098fb4474fa22cd05f897d6b99" }, "id": "a4a5d4098fb4474fa22cd05f897d6b99", "enabled": true } ], "links": { "next": null, "previous": null, "self": "https://www.example.com/v3/projects" } }

响应参数 状态码： 200 表4 响应Header参数 参数 参数类型 描述 X-Request-Id String 请求的唯一标识 表5 响应Body参数 参数 参数类型 描述 total Integer 总数 limit Integer 查询结果限制 offset Integer 查询偏移量 room_info_list Array of RtcServerRoomInfo objects 房间列表信息 表6 RtcServerRoomInfo 参数 参数类型 描述 domain String 域名 app String 应用标识 room_id String 房间ID state String 房间状态，取值如下： RUNNING：开启中 CLOSED：已关闭 duration Integer 房间持续时长，单位：秒 start_time String 房间开始时间，即第一个用户加入房间时间，UTC时间，格式：YYYY-MM-DDThh:mm:ssZ，如2020-04-23T07:00:00Z end_time String 房间关闭时间，即最后一个room_uuid关闭的时间，UTC时间，格式：YYYY-MM-DDThh:mm:ssZ，如2020-04-23T07:00:00Z，若房间未关闭，则返回 “-” 状态码： 400 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。

请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 否 String 用户Token。使用Token鉴权方式时必选。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 Authorization 否 String 使用AK/SK方式认证时必选，携带的鉴权信息。 X-Sdk-Date 否 String 使用AK/SK方式认证时必选，请求的发生时间。 X-Project-Id 否 String 使用AK/SK方式认证时必选，携带项目ID信息，与路径参数中的项目ID相同。

URI GET /v1/{project_id}/rtc/rooms 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID，获取方法请参考获取项目ID。 表2 Query参数 参数 是否必选 参数类型 描述 app 是 String 应用标识 room_id 否 String 房间id state 否 String 房间状态，取值如下： RUNNING：开启中 CLOSED：已关闭 start_time 否 String 查询起始时间。UTC时间，格式：YYYY-MM-DDThh:mm:ssZ，如2020-04-23T06:00:00Z，不写默认读取过去1小时数据数据。 end_time 否 String 查询结束时间。UTC时间，格式：YYYY-MM-DDThh:mm:ssZ，如2020-04-23T07:00:00Z，不写默认为当前时间。 limit 否 Integer 查询结果条数 offset 否 Integer 查询偏移量

响应示例 状态码： 200 查询成功返回。 { "total" : 1, "room_info_list" : [ { "domain" : "603f71bdfa163e500aff1106c8xxxxxx.sparkrtc.myhuaweicloud.com", "app" : "603f71bdfa163e500aff1106c8xxxxxx", "room_id" : "ac146d0f2779916191716070xxxxxx", "state" : "RUNNING", "start_time" : "2021-04-23T09:55:30Z", "end_time" : "-" } ], "offset" : 0, "limit" : 2 } 状态码： 400 查询失败返回 { "error_code" : "DATA.100011001", "error_msg" : "Required String parameter 'app' is not present" }

状态码 调用实时音视频API时，可能返回的状态码如表1所示。 表1 状态码 返回值 说明 200 OK 请求正常。 201 Created 创建类的请求完全成功。 202 Accepted 已经接受请求，但未处理完成。 204 No Content 请求完全成功，同时HTTP响应不包含响应体。 400 Bad Request 非法请求。 建议直接修改该请求，不要重试该请求。 401 Unauthorized 在客户端提供认证信息后，返回该状态码，表明服务端指出客户端所提供的认证信息不正确或非法。 403 Forbidden 请求被拒绝访问。 返回该状态码，表明请求能够到达服务端，且服务端能够理解用户请求，但是拒绝做更多的事情，因为该请求被设置为拒绝访问，建议直接修改该请求，不要重试该请求。 404 Not Found 所请求的资源不存在。 建议直接修改该请求，不要重试该请求。 405 Method Not Allowed 请求中带有该资源不支持的方法。 建议直接修改该请求，不要重试该请求。 406 Not Acceptable 服务器无法根据客户端请求的内容特性完成请求。 407 Proxy Authentication Required 请求要求代理的身份认证，与401类似，但请求者应当使用代理进行授权。 408 Request Timeout 服务器等候请求时发生超时。 客户端可以随时再次提交该请求而无需进行任何更改。 409 Conflict 服务器在完成请求时发生冲突。 返回该状态码，表明客户端尝试创建的资源已经存在，或者由于冲突请求的更新操作不能被完成。 500 Internal Server Error 表明服务端能被请求访问到，但是不能理解用户的请求。 501 Not Implemented 服务器不支持请求的功能，无法完成请求。 502 Bad Gateway 充当网关或代理的服务器，从远端服务器接收到了一个无效的请求。 503 Service Unavailable 被请求的服务无效。 建议直接修改该请求，不要重试该请求。 504 Gateway Timeout 网关超时。 父主题： 附录

数据统计分析接口 表9 数据统计分析接口 接口 说明 GET /v1/{project_id}/rtc/rooms 查询房间列表 GET /v1/{project_id}/rtc/users 查询用户列表 GET /v1/{project_id}/rtc/realtime/scale 查询实时规模 GET /v1/{project_id}/rtc/realtime/scale/dimension 查询实时规模分布 GET /v1/{project_id}/rtc/realtime/quality 查询实时质量数据 GET /v1/{project_id}/rtc/realtime/network 查询实时网络 GET /v1/{project_id}/rtc/history/usage 查询用量 GET /v1/{project_id}/rtc/history/scale 查询历史规模 GET /v1/{project_id}/rtc/history/quality 查询历史质量 GET /v1/{project_id}/rtc/client/qos/details 查询用户通话指标 GET /v1/{project_id}/rtc/client/event 查询详情事件 GET /v1/{project_id}/rtc/client/abnormalevent 查询指定项目用户异常体验事件 GET /v1/rtc/data/abnormal-events 查询用户异常体验事件 GET /v1/rtc/data/abnormal-event/dimension 查询异常事件用户分布

合流任务管理接口 表5 合流任务管理接口 接口 说明 POST /v2/apps/{app_id}/mix-stream-jobs 启动合流任务 GET /v2/apps/{app_id}/mix-stream-jobs/{job_id} 查询合流任务 PUT /v2/apps/{app_id}/mix-stream-jobs/{job_id} 修改合流任务 DELETE /v2/apps/{app_id}/mix-stream-jobs/{job_id} 停止合流任务