华为云用户手册

计费说明 AI Gallery的计费规则如表1所示。 表1 计费说明 规则 说明 话单上报规则 仅当AI Gallery工具链服务创建成功且实际开始运行时，才会上报话单并开始计费，其他状态不上报就不计费，各个服务开始计费的状态如下。 微调大师：“训练中” AI应用：“运行中” 在线推理服务：“运行中” 计费规则 资源整点扣费，按需计费。 计费的最小单位为秒，话单上报后的每一小时对用户账号进行一次扣费。如果使用过程中暂停、终止了消耗资源的AI Gallery工具链服务，即服务不处于计费的状态中，则系统不会立即扣费，依然等到满1小时后再进行扣费，且基于当前1小时内的实际使用时长进行扣费。 实际计费规则 资源按时价扣费，真正计费的价格以实际账单为准。查看账单请参见账单介绍。 用户在创建AI Gallery工具链服务选择付费资源时，可以查看到付费资源的单价，在使用过程中，该资源可能由于平台的折扣优惠变化导致单价发生变化，而云服务是先使用后通过话单进行记录，计费会存在延时，因此，实际价格和折扣优惠可能与当前询价会不完全相同，请以真正计费的价格和优惠为准。 欠费说明 当用户账号余额不足造成扣费失败时，账号将变成欠费状态。 欠费后，按需资源不会立即停止服务，资源进入宽限期。如果在宽限期内仍未支付欠款，那么付费资源（如计算规格、OBS桶）、等都将被冻结，资源进入保留期。保留期的资源不支持任何操作。如果用户在宽限期内充值，则华为云会自动扣取欠费金额（含宽限期内产生的费用） 保留期到期时仍未支付欠款（含宽限期内产生的费用），则付费资源将释放，数据无法恢复。 宽限期和保留期的详细规则请参见宽限期保留期。

编辑资产详情 资产发布成功后，发布者可以进入详情页修改该资产的名称、描述，让资产更吸引人。也可以修改资产的可见性。 编辑Notebook介绍 在Notebook详情页，单击“项目介绍”。 在基础设置中设置“许可证”、“语言”、“框架”、“任务类型”和“硬件资源”等信息。 单击“确定”。 编辑设置 基本设置 单击右侧的，可以更改Notebook名称和描述。 编辑完成之后单击“确定”。 关联资产 在输入框中输入资产ID后，单击“关联”即可关联其他资产，更方便其他使用者进行查找。算法可以关联数据集资产。 选择“关联资产”，在输入框中输入待关联资产的ID，单击“关联”。 在弹出的“资产信息”页面，单击“确定”即可关联资产。 可见范围设置 您可以选择更改您的资产可见性，可选择“公开”或“私密”（私密状态下，也可以选择“仅自己可见”或“指定成员可见”）。 在编辑资产详情时，请勿输入涉政、迷信、违禁等相关敏感词汇。

微调产物说明 模型微调完成后，会得到一个新模型，即微调产物。 在微调大师页面，单击操作列的“查看模型”跳转到微调获得的新模型的详情页面。选择“模型文件”页签可以查看微调产物。各文件说明请参见表3。 图1 微调产物示例 表3 微调产物说明 文件名 文件说明 gallery_train文件夹 自定义模型的模型训练文件，仅当使用自定义模型微调时才会有这个微调产物，内容和预训练模型里的gallery_train文件一致。 training_logs/user_params.json 微调配置参数信息，AI Gallery会自动将微调设置的参数信息记录在此文件下。 “README.md” 模型的基础信息。内容和预训练模型里“模型文件”页签的“README.md”一致。 其他文件 当使用自定义模型微调时，可能还会有一些其他微调产物，这是由自定义模型的训练脚本文件train.py决定的，如果训练脚本定义了归档其他训练产物，就会在此处呈现。

查看训练效果 启动模型微调任务后，在微调大师列表单击操作列的“任务详情”，在弹窗中选择“指标效果”页签，可以查看训练效果。 表2 训练效果的指标介绍 指标名称 指标说明 NPU/GPU利用率 在训练过程中，机器的NPU/GPU占用情况（横坐标时间，纵坐标占用率）。 显存利用率 在训练过程中，机器的显存占用情况（横坐标时间，纵坐标占用率）。 吞吐 在训练过程中，每卡处理tokens数量（tokens/s/p）。每种框架计算方式不一致，例如，ATB可通过“samples per second*seq_lenth/总卡数”得到tokens/s/p，输出给throughout字段，seq_lenth取值在训练脚本中可以查看。 单机8卡吞吐量一般为1650tokens/s/p，双机16卡吞吐量一般为1625tokens/s/p。 说明： 自定义训练或 自定义镜像 训练，需要提前在训练启动脚本（例如“train.py”）中定义好迭代次数、LOSS和吞吐数据的存放位置，以及存放格式（必须是“迭代次数|loss|吞吐”），才能在此处正常查看吞吐和“训练LOSS”曲线。 训练LOSS 训练阶段的LOSS变化，模型在日志里用LOSS关键词记录数据，按照训练迭代周期记录LOSS值。

选择训练任务类型 选择模型微调的训练任务类型。 当模型的“任务类型”是“文本问答”或“文本生成”时，“训练任务类型”默认和模型“任务类型”一致。“训练任务类型”支持修改，如果模型文件满足自定义模型规范（训练），则“训练任务类型”支持选择“自定义”。 当模型的“任务类型”是除“文本问答”和“文本生成”之外的类型（即自定义模型）时，则“训练任务类型”默认为“自定义”，支持修改为“文本问答”或“文本生成”。 当使用自定义镜像进行模型微调时，“训练任务类型”默认为“自定义”，且不支持修改。

管理模型文件 预览文件 在模型详情页，选择“模型文件”页签。单击文件名称即可在线预览文件内容。 仅支持预览大小不超过10MB、格式为文本类或图片类的文件。 下载文件 在模型详情页，选择“模型文件”页签。单击操作列的“下载”，即可下载文件到本地。 删除文件 在模型详情页，选择“模型文件”页签。单击操作列的“删除”，确认后即可将已经托管的文件从AI Gallery仓库中删除。 文件删除后不可恢复，请谨慎操作。

编辑模型介绍 资产发布上架后，准确、完整的资产介绍有助于提升资产的排序位置和访问量，能更好的支撑用户使用该资产。 在模型详情页，选择“模型介绍”页签，单击右侧“编辑介绍”。 编辑模型基础设置和模型描述。 表1 模型介绍的参数说明 参数名称 说明 基础设置 中文名称 显示模型的名称，不可编辑。 许可证 模型遵循的使用许可协议，根据业务需求选择合适的许可证类型。 语言 选择使用模型时支持的输入输出语言。 框架 选择构建模型使用的AI开发框架。 任务类型 选择模型支持的任务类型，不同任务类型支持的AI Gallery工具链服务请参见表2。 文本问答：从给定文本中检索问题的答案，适用于从文档中搜索答案的场景。 文本生成：基于给定文本进行续写，生成新的文本。 其他类型：基于实际场景选择合适的任务类型。 说明： 如果模型的“任务类型”是除“文本问答”和“文本生成”之外的类型，则被定义为自定义模型。自定义模型必须要满足自定义模型规范，才支持使用AI Gallery工具链服务。 硬件资源 选择支持运行该模型的硬件类型。 最低可运行规格 设置能够运行该模型的最低计算规格。在AI Gallery工具链服务中使用该模型时，只能选取等同或高于该规格的算力资源进行任务下发。 是否支持分布式训练/推理 选择该模型资产是否支持在单机多卡的资源节点上进行并行训练或推理。 README.md - 资产的README内容，支持添加资产的简介、使用场景、使用方法等信息。 当托管的是自定义镜像时，填写的内容要满足自定义镜像规范，否则该镜像无法正常使用AI Gallery工具链服务（微调大师和在线推理服务）。 说明： 建议写清楚模型的使用方法，方便使用者更好的完成训练、推理任务。 表2 任务类型支持的AI Gallery工具链服务 任务类型 微调大师 在线推理服务 AI应用 文本问答/文本生成 支持 支持 支持 其他类型 支持 支持 不支持 编辑完成后，单击“确认”保存修改。

使用流程 本节主要介绍在AI Gallery中管理资产的整体流程。 在AI Gallery中，需要先将本地数据上传到AI Gallery仓库，创建AI Gallery模型、AI Gallery数据集、AI应用等资产，具体可参见托管模型到AI Gallery、托管数据集到AI Gallery、发布本地AI应用到AI Gallery。 资产创建完成后，需要将资产进行发布操作，具体可参见发布模型到AI Gallery、发布数据集到AI Gallery。对于支持部署为AI应用的AI Gallery模型，可将此模型部署为AI应用，具体可参见将AI Gallery中的模型部署为AI应用。 发布后的资产，可通过微调大师训练模型和在线推理服务部署模型，具体可参见使用AI Gallery微调大师训练模型、使用AI Gallery在线推理服务部署模型。

前提条件 给用户组授权之前，请您了解用户组可以添加的 RAM 权限，并结合实际需求进行选择，RAM支持的系统权限如表1所示。若您需要对除RAM之外的其他服务授权， IAM 支持服务的所有权限请参见系统权限。 表1 RAM系统权限 权限名称 描述 RAM FullAccess 资源访问管理 服务所有权限。 RAM ReadOnlyAccess 资源访问管理服务只读权限。 RAM ResourceShareParticipantAccess 资源访问管理服务资源共享邀请的处理权限。

支持共享的资源 表1 支持共享的云服务和资源类型 云服务 资源类型 是否支持主动退出共享 应用场景 VPC Subnet：子网 是 共享VPC功能支持多个账号在一个集中管理、共享的VPC内创建云资源，比如E CS 、ELB、RDS等。VPC的所有者可以将VPC内的子网共享给一个或者多个账号使用。通过共享VPC功能，可以简化网络配置，帮助您统一配置和运维多个账号下的资源，有助于提升资源的管控效率，降低运维成本。 更多信息请参见共享VPC。 DNS Private Zones：内网 域名 是 基于资源访问管理（Resource Access Manager，简称RAM）服务，云解析服务可以实现跨账号共享内网域名，资源所有者将内网域名同时共享给多个其他账号使用，资源使用者接受共享邀请后就可以访问和使用共享的内网域名。 更多信息请参见共享内网域名。 Resolver Rules：解析器规则 是 基于资源访问管理（Resource Access Manager，简称RAM）服务，云解析服务可以实现跨账号共享转发规则，资源所有者将转发规则同时共享给多个其他账号使用，资源使用者接受共享邀请后就可以访问和使用共享的转发规则。 更多信息请参见共享转发规则。 SCM Cert：证书 是 云证书管理服务 提供共享功能，用户可以将SSL证书同时共享给同一组织单元内的所有成员账号，这些账号可以将共享证书部署到ELB、WAF和CDN等服务，以启用HTTPS协议。 更多信息请参见共享证书。 PCA CA：私有CA 是 云证书管理 服务私有证书管理提供共享功能，用户可以将私有CA同时共享给同一组织单元内的所有成员账号，这些账号可以使用共享CA来签发证书。 更多信息请参见共享私有CA。 ER Instances：实例 是 暂无 FunctionGraph Function：函数 是 基于资源访问管理（Resource Access Manager，简称RAM）服务， 函数工作流 服务可以实现跨账号共享函数，资源所有者将函数同时共享给多个其他账号使用，资源使用者接受共享邀请后就可以访问和使用共享的函数。 更多信息请参见共享函数。 父主题： 附录

为什么某些云服务的资源存在标签，但无法在Config中使用该资源的标签进行相关的业务操作，例如在“资源清单”中无法通过标签搜索到相应资源？ 部分云服务资源（如OBS桶）的标签信息暂未上传至Config服务，“资源清单”页面无法获取相关的标签信息则会认为该资源无标签，因此无法通过标签搜索到相应资源。 另外，Config服务的高阶能力基于“资源清单”收集到的数据来进行分析，部分云服务资源（如OBS桶）的标签信息未上传至Config，还会导致相关资源涉及标签场景的资源合规评估结果可能出现误差。 Config服务将跟踪并持续推动相关云服务资源同步的完整性。

为什么云服务资源发生了变化，“资源清单”中相应资源未发生变化？ 资源数据同步到Config存在延迟。 对于已开启资源记录器且在监控范围内的资源，Config会在24小时内校正资源数据。如您未开启资源记录器，或相关资源不在资源记录器配置的监控范围内，则Config不会校正这些资源的数据。 另外，并非已对接Config的云服务资源发生的所有变化都会被Config收集，这取决与各对接服务向Config上报的资源属性，例如IAM用户的SK（SecretAccessKey ）属性未上报Config，那么SK字段的变化Config不会感知。

如何获取各对接云服务上报Config的资源属性？ 获取各对接云服务上报Config的资源属性有如下两种方式： 通过Config管理控制台的高级查询功能，进入查询编辑器即可在界面左侧获取，如下步骤仅为进入查询编辑器的其中一种方式。 登录管理控制台。 进入Config服务的高级查询界面。 在“预设查询”列表中单击任一查询操作列的“使用查询”。 图1 使用查询 进入查询编辑器，界面左侧显示各对接云服务资源类型的详细属性，并支持输入资源类型名称进行搜索。 图2 查看资源类型详细属性 通过“列举高级查询Schema”接口获取，其中type字段为资源类型，schema字段为此资源类型上报Config的资源属性。

为什么开启并配置资源记录器后，将数据转储至当前账号或其他账号的OBS桶时报错？ 如果界面出现“Failed to write the ConfigWritabilityCheckFile file to the OBS bucket because the OBS bucket or the IAM agency is invalid.”报错，则需要确认如下场景： 资源记录器使用的IAM委托权限中，需要具有OBS服务的“obs:object:PutObject”权限； 将数据存储至当前账号的OBS桶时，桶策略不能显式Deny掉来自IAM委托的PutObject操作（Action）；如果是跨账号存储场景，桶策略需要显式Allow来自IAM委托的PutObject操作（Action），具体请参见跨账号授权，关于桶策略的权限判断逻辑请参见桶策略参数说明； 用于存储的OBS桶是否开启服务端加密。如果已开启服务端加密，则还需要配置KMS的权限，具体请参见资源变更消息和资源快照转储至OBS加密桶。

约束与限制 以下为使用配置审计（Config）服务的主要约束与限制： 表1 Config约束与限制 描述 限制值 资源数据同步周期 说明： 已对接Config的服务的资源数据同步到Config存在延迟，不同服务的延迟时间并不相同。 对于已开启资源记录器且在监控范围内的资源，Config会在24小时内校正资源数据。如未开启资源记录器，或相关资源不在资源记录器配置的监控范围内，则Config不会校正这些资源的数据。 24小时 资源快照存储周期 24小时 资源变更消息存储周期 6小时 每个账号最多可以添加的合规规则数（包括组织合规规则） 500个 每个账号最多可以添加的合规规则包数（包括组织合规规则包） 50个 每个账号最多能创建的账号类型的资源聚合器数 30个 单个资源聚合器最多能聚合的源账号数 30个 单个账号类型资源聚合器每7天添加、更新和删除的最大源账号数 1000个 单个账号最多能创建的组织类型的资源聚合器数 1个 单个账号每天最多能创建的组织类型资源聚合器次数 1次 每个账号最多能创建的高级查询数 200个 单个高级查询语句返回的结果条数 4000条 资源记录器收集到的资源配置信息数据的保留周期 7年 Config服务的相关功能均依赖于资源记录器收集的资源数据，不开启资源记录器将会影响其他功能的正常使用，例如资源清单页面无法获取资源最新数据、合规规则无法创建、修改、启用和触发规则评估、资源聚合器无法聚合源账号的资源数据等，因此强烈建议您保持资源记录器的开启状态。如何开启并配置资源记录器请参见配置资源记录器。

Config权限 默认情况下，新建的IAM用户没有任何权限，您需要将其加入用户组，并给用户组授予策略或角色，才能使用户组中的用户获得相应的权限，这一过程称为授权。授权后，用户就可以基于被授予的权限对云服务进行操作。 Config部署时不区分物理区域，为全局级服务。授权时，在全局级服务中设置权限，访问Config时，不需要切换区域。 具有Config服务只读权限的用户具有查看“资源清单”页面的权限，可以查看用户账号下的全部资源，不需要用户具有相应云服务的只读权限。 根据授权精细程度分为角色和策略。 角色：IAM最初提供的一种根据用户的工作职能定义权限的粗粒度授权机制。该机制以服务为粒度，提供有限的服务相关角色用于授权。由于云服务平台各服务之间存在业务依赖关系，因此给用户授予角色时，可能需要一并授予依赖的其他角色，才能正确完成业务。角色并不能满足用户对精细化授权的要求，无法完全达到企业对权限最小化的安全管控要求。 策略：IAM最新提供的一种细粒度授权的能力，可以精确到具体服务的操作、资源以及请求条件等。基于策略的授权是一种更加灵活的授权方式，能够满足企业对权限最小化的安全管控要求。多数细粒度策略以API接口为粒度进行权限拆分，权限的最小粒度为API授权项（action），Config支持的API授权项请参见《配置审计接口参考》中的“权限策略及授权项说明”章节。 如表1 Config系统权限所示，包括了Config的所有系统权限。 表1 Config系统权限 系统策略名称 描述 依赖关系 RMS ConsoleFullAccess 配置审计 服务控制台使用所有权限，包含查看资源，以及资源记录器、资源合规、高级查询、资源聚合器、合规规则包的查看和操作权限。 RF FullAccess RMS FullAccess 配置审计服务所有权限，包含查看资源，以及资源记录器、资源合规、高级查询、资源聚合器、合规规则包的查看和操作权限。 RF FullAccess RMS ReadOnlyAccess 配置审计服务只读权限，包含查看资源，以及资源记录器、资源合规、高级查询、资源聚合器、合规规则包的查看权限。 无 当添加了RMS ConsoleFullAccess权限的IAM用户或IAM身份中心用户在控制台对资源记录器、合规规则和合规规则包进行操作时仍提示没有操作权限，是因为相关功能需要特定权限的IAM委托，因此需要您单独添加操作IAM委托的权限。具体详情如下： 您在对资源记录器、合规规则和合规规则包进行操作时会提示需要创建委托并添加相应权限，创建委托需要您先添加iam:agencies:createAgency（创建委托），iam:permissions:grantRoleToAgency（为委托授予指定权限）权限，其中iam:permissions:grantRoleToAgency需根据不同的操作授予指定权限。 表2列出了Config常用操作与系统权限的授权关系，您可以参照该表选择合适的系统权限。“√”表示支持，“×”表示暂不支持。 表2 常用操作与系统权限的关系 操作 RMS ConsoleFullAccess RMS FullAccess RMS ReadOnlyAccess 查看所有资源列表 √ √ √ 查看单个资源详情 √ √ √ 筛选资源 √ √ √ 导出资源列表 √ √ √ 查看资源合规 √ √ √ 查看资源关系 √ √ √ 查看资源历史 √ √ √ 查看资源记录器 √ √ √ 开启/配置/修改资源记录器 √ √ x 关闭资源记录器 √ √ x 查看合规策略定义 √ √ √ 更新合规规则 √ √ x 创建合规规则 √ √ x 查看合规规则 √ √ √ 删除合规规则 √ √ x 创建组织合规规则 √ √ x 修改组织合规规则 √ √ x 查看组织合规规则 √ √ √ 删除组织合规规则 √ √ x 查看合规规则结果 √ √ √ 触发合规规则评估 √ √ x 更新合规评估结果 √ √ x 创建合规修正配置 √ √ x 查看合规修正配置 √ √ √ 修改合规修正配置 √ √ x 删除合规修正配置 √ √ x 查看合规修正执行状态 √ √ √ 执行合规修正 √ √ x 添加合规修正例外 √ √ x 删除合规修正例外 √ √ x 查看合规修正例外列表 √ √ √ 运行高级查询 √ √ x 新建高级查询 √ √ x 查看高级查询 √ √ √ 列举高级查询 √ √ √ 更新高级查询 √ √ x 删除高级查询 √ √ x 创建资源聚合器 √ √ x 查看资源聚合器 √ √ √ 修改资源聚合器 √ √ x 删除资源聚合器 √ √ x 查看聚合的合规规则 √ √ √ 查看聚合的资源 √ √ √ 授权资源聚合器账号 √ √ x 删除资源聚合器账号授权 √ √ x 删除资源聚合器的待授权请求 √ √ x 查看资源聚合器的待授权列表 √ √ √ 运行资源聚合器高级查询 √ √ x 查看授权列表 √ √ √ 创建合规规则包 √（依赖RF FullAccess） √（依赖RF FullAccess） x 查看合规规则包 √ √ √ 列举合规规则包 √ √ √ 删除合规规则包 √（依赖RF FullAccess） √（依赖RF FullAccess） x 更新合规规则包 √（依赖RF FullAccess） √（依赖RF FullAccess） x 列举合规规则包示例模板 √ √ √ 创建组织合规规则包 √ √ x 查看组织合规规则包 √ √ √ 列举组织合规规则包 √ √ √ 删除组织合规规则包 √ √ x 更新组织合规规则包 √ √ x

URI POST /v1/organizations/{resource_type}/{resource_id}/tags/delete 表1 路径参数 参数 是否必选 参数类型 描述 resource_type 是 String 资源类型。枚举值：organizations:policies（服务策略）、organizations:ous（组织OU）、organizations:accounts（账号信息） 、organizations:roots：（根）。 resource_id 是 String 根、组织单元、账号或策略的唯一标识符（ID）。 最大长度：130

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Security-Token 否 String 如果正在使用临时安全凭据，则此header是必需的，该值是临时安全凭据的安全令牌（会话令牌）。 最小值：1 表3 请求Body参数 参数 是否必选 参数类型 描述 tags 是 Array of TagDto objects 要添加到指定资源的标签列表。 数组长度：1 - 20 表4 TagDto 参数 是否必选 参数类型 描述 key 是 String 标签键的密钥标识符或名称。 最小长度：1 最大长度：128 value 是 String 与标签键关联的字符串值。您可以将标签的值设置为空字符串，但不能将标签的值设置为NULL。 最小长度：0 最大长度：255

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 handshake HandshakeDto object 两个账号（发起者和接收者）之间为了能安全地建立关系，所需要交换的信息。例如，当管理账号（发起者）邀请另一个账号（接收者）加入其组织时，两个账号一系列邀请（握手）请求和响应交换信息。 表4 HandshakeDto 参数 参数类型 描述 id String 邀请（握手）的唯一标识符（ID）。源账号在发起邀请（握手）时创建ID。 最大长度：34 urn String 邀请（握手）的统一资源名称。 最小长度：1 最大长度：1500 updated_at String 邀请（握手）请求被接受、取消、拒绝或到期的日期和时间。 created_at String 提出邀请（握手）请求的日期和时间。 expired_at String 邀请（握手）过期的日期和时间。 management_account_id String 组织管理账号的唯一标识符（ID）。 最大长度：64 management_account_name String 组织管理账号的名称。 最大长度：64 organization_id String 组织的唯一标识符（ID）。 最大长度：34 notes String 给收件账号所有者的邮件中的附加信息。 最大长度：1024 target TargetDto object 要邀请加入组织的账号的标识符（ID）。 status String 邀请（握手）的当前状态, pending：邀请中；accepted：接受邀请；cancelled：取消邀请；declined：拒绝邀请；expired：邀请过期。 最小长度：1 最大长度：64 表5 TargetDto 参数 参数类型 描述 type String 目标类型，account：账户id，name：账户名称。 最小长度：1 最大长度：64 entity String 如果指定 'type:account'，则必须提供账号ID作为实体。如果指定 'type:name'，则必须指定账号名称作为实体。 最小长度：1 最大长度：100

响应示例 状态码： 200 Successful. { "handshake" : { "id" : "h-awjp43m7bz3b8jgy5v61jrfwakt3og8w", "urn" : "organizations::0a6d25d23900d45c0faac010e0fb4de0:handshake:o-fhkmi6mek7wlqdp6nideqhb47qwtjdsv/h-awjp43m7bz3b8jgy5v61jrfwakt3og8w", "updated_at" : "2022-08-25T08:11:53Z", "created_at" : "2022-08-25T08:11:20Z", "expired_at" : "2022-09-08T08:11:20Z", "management_account_id" : "0a6d25d23900d45c0faac010e0fb4de0", "management_account_name" : "paas_iam_573331", "organization_id" : "o-fhkmi6mek7wlqdp6nideqhb47qwtjdsv", "notes" : "test-notes", "target" : { "type" : "account", "entity" : "05c734152f00d4200f2bc0179ac6c5e0" }, "status" : "cancelled" } }

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 entities Array of EntityDto objects 组织中的根、组织单元和账号的列表。 page_info PageInfoDto object 分页信息 表4 EntityDto 参数 参数类型 描述 name String 实体的名称。 最小长度：1 最大长度：64 id String 实体的唯一标识符（ID）。 最大长度：100 type String 实体的类型。account：账号；organizational_unit：组织单元；root：根。 最小长度：1 最大长度：64 表5 PageInfoDto 参数 参数类型 描述 next_marker String 如果存在，则表示可用的输出比当前响应中包含的输出多。在对操作的后续调用中，在标签请求参数中使用此值，以获取输出的下一部分。您应该重复此操作，直到next_marker响应元素返回为null。 current_count Integer 本页返回条目数量 最小值：1 最大值：2000

URI GET /v1/organizations/entities 表1 Query参数 参数 是否必选 参数类型 描述 parent_id 否 String 父节点（根或组织单元）的唯一标识符（ID）。 最大长度：100 child_id 否 String 子节点（组织单元）的唯一标识符（ID）。 最大长度：100 limit 否 Integer 页面中最大结果数量。 最小值：1 最大值：2000 缺省值：200 marker 否 String 分页标记。 最小长度：4 最大长度：400

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 handshakes Array of HandshakeDto objects 邀请（握手）对象的列表，其中包含与指定账号关联的每个邀请（握手）的详细信息。 page_info PageInfoDto object 分页信息 表4 HandshakeDto 参数 参数类型 描述 id String 邀请（握手）的唯一标识符（ID）。源账号在发起邀请（握手）时创建ID。 最大长度：34 urn String 邀请（握手）的统一资源名称。 最小长度：1 最大长度：1500 updated_at String 邀请（握手）请求被接受、取消、拒绝或到期的日期和时间。 created_at String 提出邀请（握手）请求的日期和时间。 expired_at String 邀请（握手）过期的日期和时间。 management_account_id String 组织管理账号的唯一标识符（ID）。 最大长度：64 management_account_name String 组织管理账号的名称。 最大长度：64 organization_id String 组织的唯一标识符（ID）。 最大长度：34 notes String 给收件账号所有者的邮件中的附加信息。 最大长度：1024 target TargetDto object 要邀请加入组织的账号的标识符（ID）。 status String 邀请（握手）的当前状态, pending：邀请中；accepted：接受邀请；cancelled：取消邀请；declined：拒绝邀请；expired：邀请过期。 最小长度：1 最大长度：64 表5 TargetDto 参数 参数类型 描述 type String 目标类型，account：账户id，name：账户名称。 最小长度：1 最大长度：64 entity String 如果指定 'type:account'，则必须提供账号ID作为实体。如果指定 'type:name'，则必须指定账号名称作为实体。 最小长度：1 最大长度：100 表6 PageInfoDto 参数 参数类型 描述 next_marker String 如果存在，则表示可用的输出比当前响应中包含的输出多。在对操作的后续调用中，在标签请求参数中使用此值，以获取输出的下一部分。您应该重复此操作，直到next_marker响应元素返回为null。 current_count Integer 本页返回条目数量 最小值：1 最大值：2000

响应示例 状态码： 200 Successful. { "handshakes" : [ { "id" : "h-2tnfkrhe64qokwripd2kqrhd7d3079u5", "urn" : "organizations::0a6d25d23900d45c0faac010e0fb4de0:ou:o-fhkmi6mek7wlqdp6nideqhb47qwtjdsv/ou-fi0rv9jbjgc6nifokh65jjo8c24fnujv", "updated_at" : "2022-09-23T07:38:15Z", "created_at" : "2022-09-23T07:38:15Z", "management_account_id" : "0a6d25d23900d45c0faac010e0fb4de0", "management_account_name" : "paas_iam_573331", "organization_id" : "o-fhkmi6mek7wlqdp6nideqhb47qwtjdsv", "notes" : "test-notes", "target" : { "type" : "account", "entity" : "644c579bea6d473e8ce386e0e8ec449d" }, "status" : "cancelled" } ], "page_info" : { "next_marker" : "ou-taowxgy4xbme6m4x3c2iijbxw7yj8fcw", "current_count" : 100 } }

响应示例 状态码： 200 Successful. { "accounts" : [ { "id" : "05261f923e80d3890f33c0056e9b3f80", "urn" : "organizations::0a6d25d23900d45c0faac010e0fb4de0:account:o-fhkmi6mek7wlqdp6nideqhb47qwtjdsv/05261f923e80d3890f33c0056e9b3f80", "join_method" : "invited", "joined_at" : "2022-08-24T06:41:15Z", "name" : "paas_iam_573331", "status" : "active", "mobile_phone" : "null,", "intl_number_prefix" : "null,", "email" : null } ], "page_info" : { "next_marker" : "ou-taowxgy4xbme6m4x3c2iijbxw7yj8fcw", "current_count" : 100 } }

URI GET /v1/organizations/accounts 表1 Query参数 参数 是否必选 参数类型 描述 parent_id 否 String 父节点（根或组织单元）的唯一标识符（ID）。 最大长度：100 with_register_contact_info 否 Boolean 是否返回账号邮箱、手机号信息。缺省值为False，若此参数为True时，Limit最多200。 limit 否 Integer 页面中最大结果数量。 最小值：1 最大值：2000 缺省值：200 marker 否 String 分页标记。 最小长度：4 最大长度：400

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 accounts Array of AccountDto objects 组织中的账号列表。 page_info PageInfoDto object 分页信息 表4 AccountDto 参数 参数类型 描述 id String 账号的唯一标识符（ID）。 最大长度：64 urn String 账号的统一资源名称。 最小长度：1 最大长度：1500 join_method String 账号加入组织的方式。invited：邀请加入，created：创建加入。 最小长度：1 最大长度：64 status String 账号当前的状态。active：有效； suspended：已关闭； pending_closure：关闭中。 最小长度：1 最大长度：64 joined_at String 账号加入组织的日期。 name String 账号名称 最大长度：64 mobile_phone String 手机号码 最小长度：1 最大长度：32 intl_number_prefix String 手机号前缀。 最小长度：1 最大长度：10 email String 与此账号关联的电子邮件地址。 最大长度：64 description String 描述信息。 最小长度：1 最大长度：128 表5 PageInfoDto 参数 参数类型 描述 next_marker String 如果存在，则表示可用的输出比当前响应中包含的输出多。在对操作的后续调用中，在标签请求参数中使用此值，以获取输出的下一部分。您应该重复此操作，直到next_marker响应元素返回为null。 current_count Integer 本页返回条目数量 最小值：1 最大值：2000

响应示例 状态码： 200 Successful. { "policy" : { "content" : "{\"Version\":\"5.0\",\"Statement\":[{\"Sid\":\"Statement1\",\"Effect\":\"Allow\",\"Action\":[\"*\"],\"Resource\":[\"*\"]}]}", "policy_summary" : { "is_builtin" : false, "description" : "auto0923161647582JIeTPolicydesc", "id" : "p-scnsbv8byvfjp612ooojkdamzcgtp6l9", "urn" : "organizations::0a6d25d23900d45c0faac010e0fb4de0:policy:o-fhkmi6mek7wlqdp6nideqhb47qwtjdsv/service_control_policy/p-b4wpejd02o66g0pvfinvsatp4t9krfum", "name" : "auto0923161647583CXosPolicyName", "type" : "service_control_policy" } } }

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 policy PolicyDto object 包含有关策略的详细信息的结构。 表4 PolicyDto 参数 参数类型 描述 content String 策略的文本内容。 最小长度：0 最大长度：20000 policy_summary PolicySummaryDto object 包含有关策略的信息，但不包括内容。 表5 PolicySummaryDto 参数 参数类型 描述 is_builtin Boolean 一个布尔值，指示指定的策略是否为系统策略。如果为true，即为系统策略，则可以将策略附加到根、组织单元或账号，但不能编辑它。 description String 策略说明。 最大长度：512 id String 策略的唯一标识符（ID）。 最小长度：1 最大长度：130 urn String 策略的统一资源名称。 最小长度：1 最大长度：1500 name String 策略的名称。 最小长度：1 最大长度：64 type String 策略的类型,service_control_policy：服务控制策略；tag_policy：标签策略。 最小长度：1 最大长度：64

响应参数 状态码： 201 表4 响应Body参数 参数 参数类型 描述 policy PolicyDto object 包含有关策略的详细信息的结构。 表5 PolicyDto 参数 参数类型 描述 content String 策略的文本内容。 最小长度：0 最大长度：20000 policy_summary PolicySummaryDto object 包含有关策略的信息，但不包括内容。 表6 PolicySummaryDto 参数 参数类型 描述 is_builtin Boolean 一个布尔值，指示指定的策略是否为系统策略。如果为true，即为系统策略，则可以将策略附加到根、组织单元或账号，但不能编辑它。 description String 策略说明。 最大长度：512 id String 策略的唯一标识符（ID）。 最小长度：1 最大长度：130 urn String 策略的统一资源名称。 最小长度：1 最大长度：1500 name String 策略的名称。 最小长度：1 最大长度：64 type String 策略的类型,service_control_policy：服务控制策略；tag_policy：标签策略。 最小长度：1 最大长度：64