华为云用户手册

技术优势 实现应用统一账号、统一登录、统一鉴权、统一组织信息，提供统一接入规范。涉及领域包括ERP、CRM、PLM、OA、IoT、BI、MES、CAD、SRM、生产培训、 知识管理 等。 行业资产库，丰富的行业API、连接器、流模板、卡片、数据集等，使能业务创新，缩短应用上线时间。 预置行政人事轻应用，后台数据打通：预装即时消息、待办、公告、日历、行政服务、人事管理等基础应用，打通应用间数据关联，实现开箱即用，企业业务一站启航。 数据模型驱动开发和集成：具备数据模型定义能力，具备基于数据模型驱动的应用开发和集成能力，包含研、产、供、销、服各大领域通用数据资产模型，基于数据模型可以快速构建轻应用和快速集成轻应用。 门户自定义编排，打造企业专属阵地：提供丰富的模板组件，自定义工作台门户；更换登录页的图片及Logo，匹配企业个性化需求。灵活配置企业门户，支持企业门户自定义，同时支持产业集群运营门户，满足企业运营需求。 数据集成零码/低码平台： 连接器实现了 集成工作台 流编排能力扩展，预置丰富的连接器，还为用户提供自定义连接器能力。 业务流编排：通过可视化的方式对连接器进行组合、编排，支持流程编排，事件编排等。 IoT边缘集成：支持对接IoT边缘通道，支持IoT数据对接。 集成资产积累：支持预集成资产积累，支持ERP、CRM、PLM、OA、IoT、BI、MES、CAD、SRM间数据快速集成，相比传统集成开发速度提升5倍以上。 组织、用户、应用多维度管理： 精细化管理，应用使用权限可细化到组、人和部门。 用户分组分角色管理。 企业内组织的统一管理配置，多处复用。 无需跳转，应用一站使用：工作台预装的办公应用、企业自建应用、用户在云市场购买的应用，均可在工作台快速打开使用，无需二次登录，提高办公效率。 父主题： 产品优势

关键特性 工业云商城：打造工业企业的数字化商店，精准的解决方案匹配，打造行业数字化标杆。 工业工作台：企业一站式信息服务及数字化管理平台。 一个账号访问所有服务：简化IT服务使用门槛，统一权限管理和应用管理。 随时随地处理业务：跨终端账号和数据协同，移动办公不受地域限制。 一站式使用数字服务：一个入口访问所有IT服务，用户自动获取数字服务。 打造行业专属桌面：企业Logo、桌面菜单自定义，积木式搭建企业办公桌面。 数据采集：轻量化大数据分析服务。 数据集成：沉淀行业应用集成资产。 应用集成只对接一次，可提升集成效率30%+。 提供行业API开放服务，提供人工智能、行业标识等基础能力。标准 API服务 已达到1000+。 聚合应用集成资产，连接器封装工业应用南向和北向接口，连接流串联连接器。 数据运营：可视化报表展示，监控企业核心业务指标。 协同办公：IM、日历、通讯录、审批、待办、新闻、公告。

clinetid一致，接口返回的(success=false, mssg={error=invalid_client, error_description=Bad client credentials}, t=null) 检查入参的DomainName和clientSecret与ISV数据库保存的数据是否一致，若clientSecret与ISV数据库保存的数据不一致，原因可能是传递的参数没做解密。 父主题： 开发相关

单点登录获取code失败，接口返回：success=false, mssg={error=invalid_client, error_description=Client ID mismatch} 通过F12查看触发的code请求接口拿到clientId，跟ISV数据库应用信息表的clientid对比发现不一致。 解决方法：需要重新触发绑定租户，触发租户同步，应用同步和组织机构同步（全量）。 父主题： 开发相关

处理步骤 检查返回结果： 检查resultCode是不是六个0。 检查body签名的key的获取是否正确，计算签名值的时候不要key+timeStamp，只要key。 检查body是不是json字符串格式{" resultCode": "000000"," resultMsg": "Success"}。 检查返回方式，body需放到response里：response.getWriter().print(body)。 检查返回内容，是不是定义的返回结果字段。

租户同步是什么时候触发? 买家侧是购买完商品后，将商品和组织绑定的时候同步，同时会调用租户信息同步接口、租户应用信息同步接口、组织部门同步（全量）接口。 卖家侧是申请应用凭证的时候会同步租户信息同步接口、租户应用信息同步接口、组织部门同步（全量）接口。 买家给账号授权访问应用和卖家申请测试账号的时候会调用租户应用授权信息同步接口。 买家商品绑定组织后，在组织下变更部门的时候会调用组织部门信息同步（增量）接口。 父主题： 开发相关

如何获取企业邀请码？ 企业管理员在管理后台开启邀请设置，用户可以通过邀请码直接在前台登录页面进行注册，便于普通成员通过自注册的方式加入目标单位或部门，具体获取方式如下。 在“通讯录”页面，在左侧通讯录选择需要邀请成员的部门。 在界面右上角选择“邀请成员加入本组织”。 如果出现“当前部门的邀请功能已停用”界面，单击“启用”。 进入邀请成员界面后，即可获得企业邀请码、企业链接及企业二维码，如图1所示。 图1 企业邀请码、企业链接、企业二维码 在“ 邀请设置”区域，可以进一步对邀请有效期进行设置。 图2 邀请设置 进入“注册完成按钮配置”，您可以单击操作列的“编辑”，选择是否开启“注册完成按钮配置”。 开启：可自行配置当前租户邀请链接完成注册后页面的独立按钮。设置按钮文字、跳转链接后单击“保存”。以web端为例，页面效果如图3所示。 按钮文字至多显示5个汉字或字母。 图3 设置独立按钮 关闭：不配置完成注册后页面的独立按钮，即页面只显示一个按钮，以web端为例，页面效果如图4所示。 图4 未设置独立按钮 设置完成后，将企业邀请码、企业链接或企业二维码分享给需要邀请的用户。 用户在用户门户登录页面选择“注册账号”，输入企业邀请码，或直接进入企业邀请链接，输入用户信息后即可加入企业。 邀请成员后，您可以单击“查看申请人列表”查看申请情况，也可以单击“停用邀请”使邀请信息失效，如图5所示。 图5 查看申请人列表 父主题： 账号与登录

计费概述 通过阅读本文，您可以快速了解开天工业工作台（MIW）的计费模式、计费项、续费、欠费等主要计费信息。 计费模式 工业工作台提供包年这一种计费模式。包年是一种预付费模式，即先付费再使用，按照订单的购买周期进行结算，因此在购买之前，您必须确保帐户余额充足。关于包年计费模式的详细介绍请参见计费模式概述。 计费项 工业工作台的计费项由实例版本套餐费用、扩容包费用组成。关于计费项的详细介绍，请参考计费项。 变更套餐版本 在购买开天工业工作台服务后，如果发现当前规格套餐无法满足业务需求，您可以变更套餐规格。详情请参见变更计费模式。 续费 包年服务在到期后会影响工作台的正常使用。如果您想继续使用工业工作台，需要在规定的时间内为工业工作台进行续费，否则资源将会自动释放，数据也可能会丢失。续费包括手动续费和自动续费两种方式，您可以根据需求选择。了解更多关于续费的信息，请参见续费概述。 欠费 对于包年的当工业工作台服务，用户已预先支付了版本费用，因此在账号出现欠费的情况下，已购买的应用平台版本仍可用。详细介绍请参见欠费说明。 停止计费 当工业工作台不再使用时，可以将他们退订或删除，从而避免继续收费。详细介绍请参见停止计费。

下载归档资源 登录 交换数据空间 官网。 单击“管理控制台”，进入交换数据空间控制台界面。 单击“我的空间”，在交换数据空间实例中，选择实例，单击实例卡片上的“连接器”。 选择连接器，单击连接器卡片上的“前往”，进入连接器控制台界面。 选择界面左侧导航栏中的“数据目录”，选择“团队数据”，进入“我的团队”页面。 在“我的团队”页面找到需要下载外部接收资源的团队卡片，单击团队卡片上的“外部接收”，进入团队外部接收数据页面。 下载归档资源。 下载单个资源：单击资源列表操作列的“下载”，下载资源，如下载的为文件夹级别，则包含文件夹中的资源。 下载多个资源：勾选多个资源，单击资源列表上方“下载”，下载资源，如下载的为文件夹级别，则包含文件夹中的资源。 如数据提供方有对下载配置数据使用策略，且对下载次数、下载时间、下载应用、下载IP有要求，系统会限定归档资源的下载。 如数据提供方未对下载配置数据使用策略，则在此处可直接下载。

查看归档资源详情 登录交换数据空间官网。 单击“管理控制台”，进入交换数据空间控制台界面。 单击“我的空间”，在交换数据空间实例中，选择实例，单击实例卡片上的“连接器”。 选择连接器，单击连接器卡片上的“前往”，进入连接器控制台界面。 选择界面左侧导航栏中的“数据目录”，选择“团队数据”，进入“我的团队”页面。 在“我的团队”页面找到需要查看外部接收资源的团队卡片，单击团队卡片上的“外部接收”，进入团队外部接收数据页面。 单击资源名称，在“全部数据”页签，可查看资源文件下包含的所有数据名称、数据编码、关联批次数、大小、格式、数据状态和操作。选择“资源信息”页签查看资源编码、资源名称、来源连接器、资源责任人、更新时间等。 单击数据列表的数据名称，在弹框中选择应用APP，使用应用进行数据详情查看，参数如表1所示。 表1 参数说明 参数 说明 处理类型 系统默认为“查看”，无需修改。 应用APP类型 选择应用APP类型，如无对应应用实例，参考应用管理注册应用实例。 设置成默认实例 如勾选，后续进行查看时，默认使用该应用类型。 单击“确定”，查看资源数据详情。

查看归档资源详情 登录交换数据空间官网。 单击“管理控制台”，进入交换数据空间控制台界面。 单击“我的空间”，在交换数据空间实例中，选择实例，单击实例卡片上的“连接器”。 选择连接器，单击连接器卡片上的“前往”，进入连接器控制台界面。 选择界面左侧导航栏中的“我的数据”，选择“外部接收”页签，进入“外部接收”页面。 单击资源名称，在“全部数据”页签，可查看资源文件下包含的所有数据名称、数据编码、关联批次数、大小、格式、数据状态和操作。选择“资源信息”页签查看资源编码、资源名称、来源连接器、资源责任人、更新时间等。 单击数据列表的数据名称，在弹框中选择应用APP，使用应用进行数据详情查看，参数如表1所示。 表1 参数说明 参数 说明 处理类型 系统默认为“查看”，无需修改。 应用APP类型 选择应用APP类型，如无对应应用实例，参考应用管理注册应用实例。 设置成默认实例 如勾选，后续进行查看时，默认使用该应用类型。 单击“确定”，查看资源数据详情。

下载归档资源 登录交换数据空间官网。 单击“管理控制台”，进入交换数据空间控制台界面。 单击“我的空间”，在交换数据空间实例中，选择实例，单击实例卡片上的“连接器”。 选择连接器，单击连接器卡片上的“前往”，进入连接器控制台界面。 选择界面左侧导航栏中的“我的数据”，选择“外部接收”页签，进入“外部接收”页面。 下载归档资源。 下载单个资源：单击资源列表操作列的“下载”，下载资源，如下载的为文件夹类型，则包含文件夹中的资源。 下载多个资源：勾选多个资源，单击资源列表上方“下载”，下载资源，如下载的为文件夹类型，则包含文件夹中的资源。 如数据提供方对下载配置数据使用策略，且对下载次数、下载时间、下载应用、下载IP有要求，系统会限定归档资源的下载。 如数据提供方未对下载配置数据使用策略，则在此处可直接下载。

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 quota Integer 云堡垒机 实例最大创建数量。 quota_used Integer 当前云 堡垒机 实例创建个数。 状态码： 400 表4 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_description String 请求参数错误。 状态码： 401 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_description String 校验TOKEN失败。 状态码： 403 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_description String 租户无权限操作。 状态码： 404 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_description String 没有找到CBH资源。

响应示例 状态码： 200 List CBH ByTags Success { "resources" : [ { "resource_id" : "cdfs_cefs_wesas_12_dsad", "resource_name" : "resouece1", "tags" : [ { "key" : "key1", "value" : "value1" }, { "key" : "key2", "value" : "value1" } ], "sys_tags" : [ { "key" : "_sys_enterprise_project_id", "value" : "5aa119a8-xxxx-45a7-xxxx-88e12788xxxx" } ] } ], "total_count" : 1000 }

请求示例 { "matches" : [ { "key" : "resource_name", "value" : "resource1" } ], "not_tags" : [ { "key" : "key1", "values" : [ "*value1", "value2" ] } ], "tags" : [ { "key" : "key1", "values" : [ "*value1", "value2" ] } ], "tags_any" : [ { "key" : "key1", "values" : [ "value1", "value2" ] } ], "not_tags_any" : [ { "key" : "key1", "values" : [ "value1", "value2" ] } ], "sys_tags" : [ { "key" : "_sys_enterprise_project_id", "values" : [ "5aa119a8-d25b-45a7-8d1b-88e127885635" ] } ] }

响应参数 状态码： 200 表6 响应Body参数 参数 参数类型 描述 resources Array of Resources objects 根据查询模式获取到的资源实例详情。 total_count Integer 总记录数。 表7 Resources 参数 参数类型 描述 resource_id String 实例ID。 resource_detail InstanceDetail object CBH实例详情 tags Array of ResourceTag objects tags。 sys_tags Array of ResourceTag objects sys_tags。 resource_name String 资源名称。 表8 InstanceDetail 参数 参数类型 描述 name String 云堡垒机实例名称。 server_id String 云堡垒机服务器id。 instance_id String 云堡垒机实例id。 alter_permit Boolean 云堡垒机实例是否可以扩容。 true：是 false：否 enterprise_project_id String 项目ID。 period_num String 云堡垒机实例订购周期数。 start_time String 云堡垒机实例开始时间，使用时间戳格式表示。 end_time String 云堡垒机实例结束时间，使用时间戳格式表示。 created_time String 云堡垒机实例创建时间，使用UTC时间表示。 upgrade_time Long 云堡垒机实例升级定时时间，使用时间戳格式表示。 update String 云堡垒机实例是否可以升级。 OLD：当前已是最新版本 NEW：可以升级小版本 CROSS_OS：可以跨版本升级 ROLLBACK：可以回滚 枚举值： OLD NEW CROSS_OS ROLLBACK bastion_version String 云堡垒机实例当前版本。 az_info az_info object 可用区信息。 status_info status_info object 状态信息。 resource_info resource_info object 资源信息。 network network object 网络信息。 ha_info ha_info object 主备信息。 表9 az_info 参数 参数类型 描述 region String 云堡垒机实例所在可用区ID。 zone String 云堡垒机实例所在可用分区ID。(实例为主备模式时作为主机实例所在可用分区) availability_zone_display String 云堡垒机实例所在可用分区中文名称。(实例为主备模式时作为主机实例所在可用分区中文名称) slave_zone String 云堡垒机备机实例所在可用区。 slave_zone_display String 云堡垒机备机实例所在可用区中文名称。 表10 status_info 参数 参数类型 描述 status String 云堡垒机实例状态。 SHUTOFF：已关闭 ACTIVE：运行中 DELETING：删除中 BUILD：创建中 DELETED：已删除 ERROR：故障 HAWAIT：等待备机创建成功 FROZEN：已冻结 UPGRADING：升级中 UNPAID：待支付 RESIZE：规格变更中 DILATATION：扩容中 HA：配置HA中 task_status String 云堡垒机实例当前的任务状态。 powering-on：开启 powering-off：关闭 rebooting：重启 delete_wait：删除 frozen：冻结 NO_TASK：运行 unfrozen：解冻 alter：变更 updating：升级中 configuring-ha：配置HA data-migrating：数据迁移中 rollback：版本回滚中 traffic-switchover：流量切换中 create_instance_status String 云堡垒机实例在创建实例过程中的状态信息。 Waiting for payment：等待支付 creating-network：创建网络 creating-server：创建服务 tranfering-horizontal-network：网络打通 adding-policy-route：添加路由策略 configing-dns：配置DNS starting-cbs-service：服务运行中 setting-init-conf：初始化 buying-EIP：购买弹性公网IP instance_status String 云堡垒机实例状态。 building：创建中 deleting：删除中 deleted：删除了 unpaid：未支付 upgrading：升级中 resizing：扩容中 abnormal：异常 error：故障 ok：正常 instance_description String 云堡垒机实例信息描述。 fail_reason String 云堡垒机实例创建实例失败原因。 表11 resource_info 参数 参数类型 描述 specification String 云堡垒机实例规格。 order_id String 订单id。 resource_id String 云堡垒机实例的资源id，UUID格式显示。 data_disk_size Number 云堡垒机实例数据盘大小，单位TB。 disk_resource_id Array of strings 云堡垒机实例数据盘资源ID。 表12 network 参数 参数类型 描述 vip String 云堡垒机实例浮动ip。(实例为主备模式时返回对应的值) web_port String 云堡垒机实例WEB界面访问的端口号。 public_ip String 云堡垒机实例弹性公网IP。 public_id String 云堡垒机实例绑定公网的弹性IP的ID，UUID格式表示。 private_ip String 云堡垒机实例私有ip。 vpc_id String 云堡垒机实例所在虚拟私有云ID。 subnet_id String 云堡垒机实例所在子网ID。 security_group_id String 云堡垒机实例所属的安全组ID。 表13 ha_info 参数 参数类型 描述 ha_id String 主备ID。 instance_type String 实例类型。 master：主 slave：备 表14 ResourceTag 参数 参数类型 描述 key String 键。最大长度128个字符。 value String 值。每个值最大长度255个字符。 状态码： 400 表15 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_description String 请求参数错误。 状态码： 401 表16 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_description String 校验TOKEN失败。 状态码： 403 表17 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_description String 租户无权限操作。 状态码： 404 表18 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_description String 没有找到CBH资源。

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用 IAM 服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 可参考"IAM获取IAM用户Token"获取 limit 否 String 查询记录数（action为count时无此参数）如果action为filter默认为1000，limit最多为1000,不能为负数，最小值为1。 offset 否 String 索引位置，偏移量（action为count时无此参数）从第一条数据偏移offset条数据后开始查询，如果action为filter默认为0（偏移0条数据，表示从第一条数据开始查询）,必须为数字，不能为负数。 表3 请求Body参数 参数 是否必选 参数类型 描述 without_any_tag 否 Boolean 不包含任意一个标签，该字段为true时查询所有不带标签的资源。 此时忽略 “tags”、“tags_any”、“not_tags”、“not_tags_any”字段。 tags 否 Array of Tags objects 包含标签，最多包含50个key，每个key下面的value最多10个，每个key对应的value可以为空数组但结构体不能缺失。 Key不能重复，同一个key中values不能重复。结果返回包含所有标签的资源列表，key之间是与的关系， key-value结构中value是或的关系。 无tag过滤条件时返回全量数据。 tags_any 否 Array of Tags objects 包含任意标签，最多包含50个key，每个key下面的value最多10个,每个key对应的value可以为空数组但结构体不能缺失。Key不能重复，同一个key中values不能重复。 结果返回包含标签的资源列表，key之间是或的关系，key-value结构中value是或的关系。 无过滤条件时返回全量数据。 not_tags 否 Array of Tags objects 不包含标签，最多包含50个key，每个key下面的value最多10个, 每个key对应的value可以为空数组但结构体不能缺失。Key不能重复，同一个key中values不能重复。 结果返回不包含标签的资源列表，key之间是与的关系，key-value结构中value是或的关系。 无过滤条件时返回全量数据。 not_tags_any 否 Array of Tags objects 不包含任意标签，最多包含50个key，每个key下面的value最多10个, 每个key对应的value可以为空数组但结构体不能缺失。Key不能重复，同一个key中values不能重复。 结果返回不包含标签的资源列表，key之间是或的关系，key-value结构中value是或的关系。 无过滤条件时返回全量数据。 sys_tags 否 Array of Tags objects 仅op_service权限可以使用此字段做资源实例过滤条件。 目前TMS调用时只包含一个tag结构体。 key：_sys_enterprise_project_id value：企业项目id列表 目前TMS调用时，key下面只包含一个value。0表示默认企业项目 sys_tags和租户标签过滤条件（without_any_tag 、tags、tags_any、not_tags、not_tags_any）不能同时使用 无sys_tags时按照tag接口处理，无tag过滤条件时返回全量数据。。 matches 否 Array of Match objects 搜索字段,key为要匹配的字段，如resource_name等。 value为匹配的值。key为固定字典值，不能包含重复的key或不支持的key。 根据key的值确认是否需要模糊匹配，如resource_name默认为模糊搜索（不区分大小写），如果value为空字符串精确匹配（多数服务不存在资源名称为空的情况，因此此类情况返回空列表）。 resource_id为精确匹配。第一期只做resource_name，后续再扩展。 表4 Tags 参数 是否必选 参数类型 描述 key 是 String 键。 说明： 说明： key不能为空，长度1~128个字符（中文也可以输入128个字符） 可用 UTF-8 格式表示的字母(包含中文)、数字和空格，以及以下字符： _ . : = + - @ _sys_开头属于系统标签，租户不能输入 建议正则：^((?!sys)[\p{L}\p{Z}\p{N}_.:=+\-@]*)$ values 是 Array of strings 值列表。 说明： 说明： 长度0~255个字符（中文也可以输入255个字符） 可用 UTF-8 格式表示的字母(包含中文)、数字和空格，以及以下字符： _ . : / = + - @ 建议正则：^([\p{L}\p{Z}\p{N}_.:/=+-@]*)$ 资源标签值可以为空（empty or null） 预定义标签值不可以为空 表5 Match 参数 是否必选 参数类型 描述 key 是 String 键。第一期限定为resource_name,后续扩展。 value 是 String 值。每个值最大长度255个unicode字符 。不校验字符集范。。

响应示例 状态码： 200 Cbh List Instance Success { "total" : 1, "instance" : [ { "name" : "CBH-e2b4", "server_id" : "760aeee4-9916-436a-8854-837a9ae94b2b", "instance_id" : "5473", "alter_permit" : false, "enterprise_project_id" : "0", "period_num" : "1,2", "start_time" : 1692245215000, "end_time" : 1694966399000, "created_time" : "2023-08-17 12:05:02.0", "update" : false, "bastion_version" : "3.3.49.0", "az_info" : { "region" : "cn-north-7", "zone" : "cn-north-7a", "availability_zone_display" : "可用区1", "slave_zone" : "cn-north-7b", "slave_zone_display" : "可用区2" }, "status_info" : { "status" : "ACTIVE", "task_status" : "NO_TASK", "create_instance_status" : "NO_TASK", "fail_reason" : "No FailReason Now", "instance_status" : "ok", "instance_description" : ",2023-08-21 15:19:07,{\"d_usage\":\"0.30\",\"m_usage\":\"43.66\",\"c_usage\":\"1.00\",\"session_count\":\"0\"" }, "resource_info" : { "specification" : "cbh.basic.5", "order_id" : " CS 2308171141G8C14", "resource_id" : "c7a07a7f-e5ee-49cf-8355-aee46c5a4fcf", "data_disk_size" : 200, "disk_resource_id" : [ ] }, "network" : { "vip" : "192.168.0.228", "web_port" : "443", "public_ip" : "100.xx.xx.1", "public_id" : "56220ed7-0f75-4d42-85c4-013d5414c81c", "private_ip" : "192.168.0.190", "vpc_id" : "03211ecf-697e-4306-a7a0-6e939bf948de", "subnet_id" : "dd08a6a9-ced7-484b-ace6-1b821854a772", "security_group_id" : "02dcf62d-b84d-4a14-aad3-c310f2ceea55" }, "ha_info" : { "ha_id" : "332", "instance_type" : "master" } } ] }

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 total Integer 云堡垒机实例总数。 instance Array of InstanceDetail objects 云堡垒机实例列表信息。 表5 InstanceDetail 参数 参数类型 描述 name String 云堡垒机实例名称。 server_id String 云堡垒机服务器id。 instance_id String 云堡垒机实例id。 alter_permit Boolean 云堡垒机实例是否可以扩容。 true：是 false：否 enterprise_project_id String 项目ID。 period_num String 云堡垒机实例订购周期数。 start_time String 云堡垒机实例开始时间，使用时间戳格式表示。 end_time String 云堡垒机实例结束时间，使用时间戳格式表示。 created_time String 云堡垒机实例创建时间，使用UTC时间表示。 upgrade_time Long 云堡垒机实例升级定时时间，使用时间戳格式表示。 update String 云堡垒机实例是否可以升级。 OLD：当前已是最新版本 NEW：可以升级小版本 CROSS_OS：可以跨版本升级 ROLLBACK：可以回滚 枚举值： OLD NEW CROSS_OS ROLLBACK bastion_version String 云堡垒机实例当前版本。 az_info az_info object 可用区信息。 status_info status_info object 状态信息。 resource_info resource_info object 资源信息。 network network object 网络信息。 ha_info ha_info object 主备信息。 表6 az_info 参数 参数类型 描述 region String 云堡垒机实例所在可用区ID。 zone String 云堡垒机实例所在可用分区ID。(实例为主备模式时作为主机实例所在可用分区) availability_zone_display String 云堡垒机实例所在可用分区中文名称。(实例为主备模式时作为主机实例所在可用分区中文名称) slave_zone String 云堡垒机备机实例所在可用区。 slave_zone_display String 云堡垒机备机实例所在可用区中文名称。 表7 status_info 参数 参数类型 描述 status String 云堡垒机实例状态。 SHUTOFF：已关闭 ACTIVE：运行中 DELETING：删除中 BUILD：创建中 DELETED：已删除 ERROR：故障 HAWAIT：等待备机创建成功 FROZEN：已冻结 UPGRADING：升级中 UNPAID：待支付 RESIZE：规格变更中 DILATATION：扩容中 HA：配置HA中 task_status String 云堡垒机实例当前的任务状态。 powering-on：开启 powering-off：关闭 rebooting：重启 delete_wait：删除 frozen：冻结 NO_TASK：运行 unfrozen：解冻 alter：变更 updating：升级中 configuring-ha：配置HA data-migrating：数据迁移中 rollback：版本回滚中 traffic-switchover：流量切换中 create_instance_status String 云堡垒机实例在创建实例过程中的状态信息。 Waiting for payment：等待支付 creating-network：创建网络 creating-server：创建服务 tranfering-horizontal-network：网络打通 adding-policy-route：添加路由策略 configing-dns：配置DNS starting-cbs-service：服务运行中 setting-init-conf：初始化 buying-EIP：购买弹性公网IP instance_status String 云堡垒机实例状态。 building：创建中 deleting：删除中 deleted：删除了 unpaid：未支付 upgrading：升级中 resizing：扩容中 abnormal：异常 error：故障 ok：正常 instance_description String 云堡垒机实例信息描述。 fail_reason String 云堡垒机实例创建实例失败原因。 表8 resource_info 参数 参数类型 描述 specification String 云堡垒机实例规格。 order_id String 订单id。 resource_id String 云堡垒机实例的资源id，UUID格式显示。 data_disk_size Number 云堡垒机实例数据盘大小，单位TB。 disk_resource_id Array of strings 云堡垒机实例数据盘资源ID。 表9 network 参数 参数类型 描述 vip String 云堡垒机实例浮动ip。(实例为主备模式时返回对应的值) web_port String 云堡垒机实例WEB界面访问的端口号。 public_ip String 云堡垒机实例弹性公网IP。 public_id String 云堡垒机实例绑定公网的弹性IP的ID，UUID格式表示。 private_ip String 云堡垒机实例私有ip。 vpc_id String 云堡垒机实例所在虚拟私有云ID。 subnet_id String 云堡垒机实例所在子网ID。 security_group_id String 云堡垒机实例所属的安全组ID。 表10 ha_info 参数 参数类型 描述 ha_id String 主备ID。 instance_type String 实例类型。 master：主 slave：备 状态码： 400 表11 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_description String 请求参数错误。 状态码： 401 表12 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_description String 校验TOKEN失败。 状态码： 403 表13 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_description String 租户无权限操作。 状态码： 404 表14 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_description String 没有找到CBH资源。

响应示例 状态码： 200 List AvailableZone Info Success { "availability_zone" : [ { "region_id" : "cn-north-4", "id" : "cn-north-4a", "type" : "Core", "display_name" : "可用区1", "status" : "Running" }, { "region_id" : "cn-north-4", "id" : "cn-north-4b", "type" : "Core", "display_name" : "可用区2", "status" : "Running" }, { "region_id" : "cn-north-4", "id" : "cn-north-4c", "type" : "Core", "display_name" : "可用区3", "status" : "Running" } ] }

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 availability_zone Array of AvailabilityZones objects 可用区信息 表4 AvailabilityZones 参数 参数类型 描述 region_id String 可用区ID。 id String 可用分区ID。 display_name String 可用分区显示名称。 status String 可用分区状态。 Running：运行中 type String 可用分区类型。 Core：核心可用区 Dedicated：专属可用区，只对内部客户开放 状态码： 400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_description String 请求参数错误。 状态码： 401 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_description String 校验TOKEN失败。 状态码： 403 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_description String 租户无权限操作。 状态码： 404 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_description String 没有找到CBH资源。

请求示例 { "matches" : [ { "key" : "resource_name", "value" : "resource1" } ], "not_tags" : [ { "key" : "key1", "values" : [ "*value1", "value2" ] } ], "tags" : [ { "key" : "key1", "values" : [ "*value1", "value2" ] } ], "tags_any" : [ { "key" : "key1", "values" : [ "value1", "value2" ] } ], "not_tags_any" : [ { "key" : "key1", "values" : [ "value1", "value2" ] } ], "sys_tags" : [ { "key" : "_sys_enterprise_project_id", "values" : [ "5aa119a8-d25b-45a7-8d1b-88e127885635" ] } ] }

响应参数 状态码： 200 表6 响应Body参数 参数 参数类型 描述 total_count Integer 总记录数。 状态码： 400 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_description String 请求参数错误。 状态码： 401 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_description String 校验TOKEN失败。 状态码： 403 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_description String 租户无权限操作。 状态码： 404 表10 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_description String 没有找到CBH资源。

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 可参考"IAM获取IAM用户Token"获取 表3 请求Body参数 参数 是否必选 参数类型 描述 without_any_tag 否 Boolean 不包含任意一个标签，该字段为true时查询所有不带标签的资源。 此时忽略 “tags”、“tags_any”、“not_tags”、“not_tags_any”字段。 tags 否 Array of Tags objects 包含标签，最多包含50个key，每个key下面的value最多10个，每个key对应的value可以为空数组但结构体不能缺失。 Key不能重复，同一个key中values不能重复。结果返回包含所有标签的资源列表，key之间是与的关系， key-value结构中value是或的关系。 无tag过滤条件时返回全量数据。 tags_any 否 Array of Tags objects 包含任意标签，最多包含50个key，每个key下面的value最多10个,每个key对应的value可以为空数组但结构体不能缺失。Key不能重复，同一个key中values不能重复。 结果返回包含标签的资源列表，key之间是或的关系，key-value结构中value是或的关系。 无过滤条件时返回全量数据。 not_tags 否 Array of Tags objects 不包含标签，最多包含50个key，每个key下面的value最多10个, 每个key对应的value可以为空数组但结构体不能缺失。Key不能重复，同一个key中values不能重复。 结果返回不包含标签的资源列表，key之间是与的关系，key-value结构中value是或的关系。 无过滤条件时返回全量数据。 not_tags_any 否 Array of Tags objects 不包含任意标签，最多包含50个key，每个key下面的value最多10个, 每个key对应的value可以为空数组但结构体不能缺失。Key不能重复，同一个key中values不能重复。 结果返回不包含标签的资源列表，key之间是或的关系，key-value结构中value是或的关系。 无过滤条件时返回全量数据。 sys_tags 否 Array of Tags objects 仅op_service权限可以使用此字段做资源实例过滤条件。 目前TMS调用时只包含一个tag结构体。 key：_sys_enterprise_project_id value：企业项目id列表 目前TMS调用时，key下面只包含一个value。0表示默认企业项目 sys_tags和租户标签过滤条件（without_any_tag 、tags、tags_any、not_tags、not_tags_any）不能同时使用 无sys_tags时按照tag接口处理，无tag过滤条件时返回全量数据。。 matches 否 Array of Match objects 搜索字段,key为要匹配的字段，如resource_name等。 value为匹配的值。key为固定字典值，不能包含重复的key或不支持的key。 根据key的值确认是否需要模糊匹配，如resource_name默认为模糊搜索（不区分大小写），如果value为空字符串精确匹配（多数服务不存在资源名称为空的情况，因此此类情况返回空列表）。 resource_id为精确匹配。第一期只做resource_name，后续再扩展。 表4 Tags 参数 是否必选 参数类型 描述 key 是 String 键。 说明： 说明： key不能为空，长度1~128个字符（中文也可以输入128个字符） 可用 UTF-8 格式表示的字母(包含中文)、数字和空格，以及以下字符： _ . : = + - @ _sys_开头属于系统标签，租户不能输入 建议正则：^((?!sys)[\p{L}\p{Z}\p{N}_.:=+\-@]*)$ values 是 Array of strings 值列表。 说明： 说明： 长度0~255个字符（中文也可以输入255个字符） 可用 UTF-8 格式表示的字母(包含中文)、数字和空格，以及以下字符： _ . : / = + - @ 建议正则：^([\p{L}\p{Z}\p{N}_.:/=+-@]*)$ 资源标签值可以为空（empty or null） 预定义标签值不可以为空 表5 Match 参数 是否必选 参数类型 描述 key 是 String 键。第一期限定为resource_name,后续扩展。 value 是 String 值。每个值最大长度255个unicode字符 。不校验字符集范。。

URI GET /v2/{project_id}/cbs/instance/ecs-quota 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。 获取方法详见API参考，附录"获取项目ID" 表2 Query参数 参数 是否必选 参数类型 描述 availability_zone 是 String 可用分区名称。 可参考接口"获取服务可用区"获取 resource_spec_code 是 String 待创建云堡垒机规格ID，例如： cbh.basic.10 10资产标准版 cbh.enhance.10 10资产专业版 可参考接口"查询云堡垒机规格信息"获取

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 status_v6 String 支持IPv6云堡垒机实例规格资源状态。 sellout：售罄 normal：正常商用 status String 云堡垒机实例规格资源状态。 sellout：售罄 normal：正常商用 状态码： 400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_description String 请求参数错误。 状态码： 401 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_description String 校验TOKEN失败。 状态码： 403 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_description String 租户无权限操作。 状态码： 404 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_description String 没有找到CBH资源。

示例流程 图1 给用户授权服务权限流程 创建用户组并授权 在IAM控制台创建用户组，并授予边缘安全权限“EdgeSec FullAccess”。 创建用户并加入用户组 在IAM控制台创建用户，并将其加入1中创建的用户组。 用户登录并验证权限 新创建的用户登录控制台，切换至授权区域，验证权限： 在“服务列表”中选择除边缘拿权外（假设当前策略仅包含“EdgeSec FullAccess”）的任一服务，若提示权限不足，表示“EdgeSec FullAccess”已生效。

接口示例 接口示例仅供参考，请以实际消息为准。 请求示例 POST /rest/caas/extendnumber/v1.0 HTTP1.1 content-type: application/json;charset=UTF-8 authorization: AKSK realm="SDP",profile="UsernameToken",type="Appkey" x-aksk: UsernameToken Username="************",PasswordDigest="*************",Nonce="ac1c911c4792492687f8f6b2264a491e",Created="2018-05-26T00:35:30Z" content-length:xx { "virtualNum":"+86138****8888", "bindNum":"+86139****8888", "callbackTone":"callbackTone.wav", "bindExpiredTime":0, "callbackExpiredTime":0 } 响应示例 HTTP/1.1 200 OK Content-Type: application/json;charset=utf-8 Content-Length: xx { "resultcode":"0", "resultdesc":"Success", "subscriptionId":"******", "virtualNum":"+86138****8888", "extendNum":"1234", "bindExpiredTime":0, "callbackExpiredTime":0 }

结果码说明 表6 响应结果码 响应码 结果码 英文描述 中文描述 处理方法 200 0 Success. 成功。 - 400 1023006 Authorization not contained in the HTTP header. HTTP消息头未找到Authorization字段。 请检查HTTP消息头中是否携带了Authorization字段。 1023007 realm not contained in Authorization. Authorization字段中未找到realm属性。 请检查Authorization字段中的是否携带了realm属性。 1023008 profile not contained in Authorization. Authorization字段中未找到profile属性。 请检查Authorization字段中的是否携带了profile属性。 1023009 The value of realm in Authorization must be SDP. Authorization中realm属性值应该为“SDP”。 请检查Authorization字段中的realm属性值是否为“SDP”。 1023010 The value of profile in Authorization must be UsernameToken. Authorization中profile属性值应该为“UsernameToken”。 请检查Authorization字段中的profile属性值是否为“UsernameToken”。 1023011 The value of type in Authorization must be app_key. Authorization中type属性值应该为“Appkey”。 请检查Authorization字段中的type属性值是否为“Appkey”。 1023012 type not contained in Authorization. Authorization字段中未找到type属性。 请检查Authorization字段中是否携带了type属性。 1023033 HTTP header not found X-AKSK field. HTTP头未找到X-AKSK字段。 请检查HTTP消息头中是否携带了X-AKSK字段。 1023034 UserName not contained in X-AKSK. X-AKSK字段中未找到UserName属性。 请检查X-AKSK字段中的是否携带了Username属性。 1023035 Nonce not contained in X-AKSK. X-AKSK字段中未找到Nonce属性。 请检查X-AKSK字段中的是否携带了Nonce属性。 1023036 Created not contained in X-AKSK. X-AKSK字段中未找到Created属性。 请检查X-AKSK字段中的是否携带了Created属性。 1023037 PasswordDigest not contained in X-AKSK. X-AKSK字段中未找到PasswordDigest属性。 请检查X-AKSK字段中的是否携带了PasswordDigest属性。 1023038 UsernameToken not contained in X-AKSK. X-AKSK中没有携带UsernameToken。 请检查X-AKSK字段中的是否携带了UsernameToken属性。 401 1010010 Invalid digest. PasswordDigest校验失败。 请检查PasswordDigest字段填写是否正确。 1010013 Time out limit. 时间超出限制。 请确认X-AKSK鉴权时，生成随机数的时间与发送请求时的本地时间不能相差太大（具体差值请与管理员确认）。 403 1010002 Invalid request. 无效请求。 请参考接口参数说明，检查请求携带的参数格式是否正确。 例如： 检查是否同时携带callbackTone和callbackNum，若是，请保留一个。 检查分机号E是否长度或格式错误，若是，请填写正确长度及格式。 检查timeUnit是否格式错误，若是，请填写正确格式。 检查userData是否包含中文字符，若包含，请剔除中文后重试，或将内容Base64编码后重试。 1010003 Invalid app_key. 无效的app_key。 请检查请求携带的app_key填写是否正确。 1010008 The status of the app_key is unavailable. app_key状态异常。 请检查请求携带的app_key所属应用状态是否正常。 1010010 The flow control upper limit is reached on the platform. 平台达到系统流控上限。 请稍等一分钟后再试。 1010029 The subscriber status is frozen. 用户账号已冻结。 查看账户是否欠费。如欠费需充值后才能继续使用。 若未欠费，请联系华为云客服处理。 1010040 The app_key is not allowed to invoke the API. app_key没有调用本API的权限。 调用的接口和app_key所属的应用模式不一致。如添加应用时选择的AXB模式的应用，调用接口时只能调用AXB模式的接口，不能调用其他模式的接口。 1012001 Resource of number is not to be applied. 资源未申请 携带的app_key和X号码没有绑定关系，请检查携带的X号码是否属于该应用。 1012008 Insufficient number of resources 号码资源不足。 没有可分配的X号码，请申请新的号码资源或修改areaCode的值。点击查看处理方法。 1012010 The number $ has been bound. 绑定关系已存在。 出现该错误码表示调用AXE模式绑定接口时指定的X号码（virtualNum）和A号码（bindNum）已有绑定关系，无需再次绑定。 1012012 Application does not open recording function. 应用未开启录音功能。 请确认app_key所属的应用是否开启了录音功能，点击查看如何开启录音功能。 1012102 The number status is abnormal. 号码状态异常。 出现该错误码表示调用接口时指定的X号码因投诉或号码状态异常被 隐私保护通话 平台加入了黑名单，请查看订购号码时填写的邮箱是否有业务下线通知邮件，如果没有，请拨打400电话联系华为云客服处理。 1020166 The app client ip is not in ip white list. 对端app IP不在白名单列表中。 联系管理员检查IP白名单是否配置正确。 1020167 No idle extend Number. 没有空闲的分机号。 出现该错误码表示调用AXE模式绑定接口时指定的分机号（extendNum）已被占用，请重新指定分机号。 1020176 Authentication failed, try again later 鉴权失败，稍后重试 IP因鉴权失败次数过多导致被拉黑，请30分钟后重试，或联系管理员放通该IP。 1020178 The transparent mode is not allowed. 不允许显示真实主叫号码。 您的应用不支持显示真实主叫号码，请修改displayNumMode参数的取值为“0”（显示X号码）后再次绑定。 500 1010001 Internal system error. 系统错误。 请联系客服处理。 1023001 Internal error. 内部错误。 1023002 Response timeout. 响应超时。 重新发送一次请求，若依然返回响应超时，请联系管理员处理。

响应参数 表5 响应结果参数 参数名称 是否必选 参数类型 说明 resultcode 是 String(1-32) 请求返回的结果码。 resultdesc 是 String(1-256) 操作结果描述。 subscriptionId 否 String(1-64) 绑定ID，唯一标识一组绑定关系。成功响应时必定返回。请记录该ID用于后续接口调用。 virtualNum 否 String(1-32) X号码，为全局号码格式（包含国家码），如：+86170****0021。 成功响应时必定返回。 extendNum 否 String(1-4) 分机号，即AXE中的E。由隐私保护通话平台自动分配或由用户指定，最大4位，例如：1234 。 成功响应时必定返回。 bindExpiredTime 否 Integer 绑定关系有效时间，单位：小时。 callbackExpiredTime 否 Integer 回呼记录有效时间，单位：小时。 userData 否 String(1-256) 用户自定义数据。