华为云用户手册

响应参数 表1 响应参数 参数 参数类型 描述 resCode String 返回码，如果返回“0”代表请求成功，其他错误码说明请参考错误码。 resMsg String 返回消息，如果成功状态，通常会返回“Success”，其他情况会返回具体的错误信息。 Result result object 在成功请求时会有内容返回。 表2 result参数说明 参数 参数类型 描述 bingo.d.ts String 可以调用的脚本库。 lib.es5.d.ts String ES5语法的标准库。

请求参数 表2 请求body参数 参数 是否必选 参数类型 描述 name 是 String 字段名称。 label 是 String 字段标签。 inlineHelpText 否 String 字段的帮助说明。 dataLength 是 Int 字段的长度，取值为1~255。 dataType 是 String 字段的类型。 description 否 String 字段的描述。 defaultValue 否 String 默认值。 caseSensitive 否 Boolean 是否大小写敏感。 isRequired 否 Boolean 字段是否必填。 isUnique 否 Boolean 字段中数据是否不重复。 profiles 否 Object 权限分配。 layouts 否 String 对象字段布局页面名。 view 否 Object 每项为一个string数组，名为包含该字段的Layout，内容为该layout包含的字段。 isSearchable 否 Boolean 字段是否可搜索。

请求示例 根据object_id为Object添加字段。 POST https://AstroZero域名/u-route/baas/metadata/v1.0/Object/cust000000aKoa6I4E6K/Field { "label":"test", "name":"CNAME1__test__CST", "inlineHelpText":"dsf", "description":"fsdf", "dataType":"text", "dataLength":255, "defaultValue":"vfdsg", "caseSensitive":true, "isRequired":true, "isUnique":true, "isSearchable":true, "profiles":[ { "profile":"000T0000000000000002", "readable":true, "editable":true }, { "profile":"000T0000000000000003", "readable":true, "editable":true }, { "profile":"000T0000000000000004", "readable":true, "editable":true }, { "profile":"000T0000000000000006", "readable":true, "editable":true }, { "profile":"000T000000Tiq6fUQhjK", "readable":true, "editable":true }, { "profile":"000T000000Tiq6lJCs2y", "readable":true, "editable":true }, { "profile":"000T000000W1a8iTFglU", "readable":true, "editable":true } ], "layouts":[ "000D000000aKoa6OJOxk" ], "view":{ "000D000000aKoa6OJOxk":{ "fields":[ "name", "test__df__CST", "test__sdadsd__CST", "test__sdd__CST" ] } } }

请求示例 调试脚本，假设脚本“命名空间__editEquipment”有输入参数equipment、name、命名空间__equipmentSN__CST。 POST https://AstroZero域名/u-route/baas/script/v1.0/debug/命名空间__editEquipment?version=1.0.1 { "equipment": { "name": "某某园区A栋1单元14号", "命名空间__equipmentSN__CST": "32178900014" } }

响应参数 表2 响应参数 参数 参数类型 描述 resCode String 返回码，如果返回“0”代表请求成功，其他错误码说明请参考错误码。 resMsg String 返回消息，如果成功状态，通常会返回“Success”，其他情况会返回具体的错误信息。 result result object 在成功请求时，会有内容返回。 表3 响应参数result 参数 参数类型 描述 value1 任意类型 执行脚本的返回值。 log String debug日志。

响应参数 表2 响应参数说明 参数 参数类型 描述 resCode String 返回码，如果返回“0”代表请求成功，其他错误码说明请参考错误码。 resMsg String 返回消息，如果成功状态，通常会返回“Success”，其他情况会返回具体的错误信息。 result Object 如果请求成功，返回“endpoint”，即文件存储地址的前缀。“endpoint”和上传文件返回的上传文件，在桶上的路径组装起来才是文件完整的访问地址。

URI GET AstroZero域名/u-route/baas/sys/v1.1/connectors/{connector_type}/{connector_name}/getendpoint 表1 路径参数 参数 是否必选 参数类型 描述 connector_type 是 String 连接器的类型。 obs：与OBS对接的连接器。 minio：与MINIO对接的连接器。 objectstorageproxy：对象存储代理类型。 connector_name 是 String 连接器实例的名称，即创建连接器时，设置的连接器实例名称。

响应示例 { "resCode": "0", "resMsg": "成功", "result": [ { "id": "cglE000000aMFjB9ipAu" }, { "id": "cglE000000aMFjB9ipAv" }, { "id": "cglE000000aMFjB9ipAw" } ] }

请求示例 向对象“TestProject__testForObject1__CST”中插入三条数据，body体中含有要插入的records参数。 POST https://AstroZero域名/u-route/baas/data/v1.0/upsert/TestProject__testForObject1__CST { "records":[ { "name":"zhang", "TestProject__length__CST":"17" }, { "name":"li", "TestProject__length__CST":"30" }, { "name":"wang", "TestProject__length__CST":"20" } ] }

修订记录 发布日期 修订记录 2024-03-29 下线Astro Bot接口。 2023-04-17 新增API 一键更新动态实体：该接口用来更新技能下的动态实体和应用配置，并完成后续的训练和发布。 查询动态实体更新进度：该接口用于查询动态实体更新进度。 2023-03-21 新增Astro Bot接口，华为云Astro智能助手（Astro Bot）为白名单特性，请联系后台管理人员开通后方可使用。 创建会话：该接口用于获取session_Id。 发送消息：该接口用于发送消息进行会话。 重启会话：该接口用于刷新对话流程。 关闭会话：该接口用于关闭指定的会话。 2023-01-16 脚本中预置的API：修改脚本标准库链接。 标准页面中预置的API：消息及弹框中，增加修改默认显示时间的描述。 2022-11-01 启动BPM实例：功能介绍中，增加“启动BMP实例前，需要先通过界面编排定义好BPM的元数据信息”的说明。 高级页面和Astro大屏应用中预置的API：修改表1中，参数HttpUtils.getCsrfToken的描述。 2022-04-20 新增API 列出所有应用：新增查询所有应用的接口。 根据ID查询应用：新增根据ID，查询应用的接口。 2022-02-08 编排Flow：增加请求实例。 新增对象数据：增加“新增对象数据前，需要先创建对象”的说明。 2021-05-17 脚本中预置的API：增加脚本中，预置API的介绍。 标准页面中预置的API：新增标准页面中，预置API的介绍。 高级页面和Astro大屏应用中预置的API：新增高级页面和Astro大屏应用中，预置API的介绍。 2020-04-30 第一次正式发布

响应示例 { "resCode": "0", "resMsg": "成功", "result": [ { "id": "testListId", "name": "testName", "isSorted": false, "isRestricted": false, "controlField": "", "masterLabel": "testLabel", "description": "", "isGlobal": true, "isBaseline": false, "picklistValues": [ { "id": "testValueId", "value": "A", "isDefault": false, "isActive": true, "label": "A", "sequenceNo": 0, "color": "", "controlFieldValue": "", "description": "", "isBaseline": false, "createdBy": "testUserId", "createdBy.name": "test0xx", "createdDate": "2019-08-05 20:38:24", "lastModifiedBy": "testUserId", "lastModifiedBy.name": "test0xx", "lastModifiedDate": "2019-08-05 20:38:24", "owner": "testUserId", "owner.name": "test0xx", "custom": true } ], "createdBy": "testUserId", "createdBy.name": "test0xx", "createdDate": "2019-08-05 20:38:24", "lastModifiedBy": "testUserId", "lastModifiedBy.name": "test0xx", "lastModifiedDate": "2019-08-05 20:38:24", "owner": "testUserId", "owner.name": "test0xx", "custom": true } ] }

响应参数 表1 响应参数 参数 参数类型 描述 resCode String 返回码，如果返回“0”代表请求成功，其他错误码说明请参考错误码。 resMsg String 返回消息，如果成功状态，通常会返回“Success”，其他情况会返回具体的错误信息。 result Array 成功返回会返回该账号下所有应用，以一个列表展示，每个值是一个应用。 表2 其中result内每个对象的主要属性 参数 参数类型 描述 id String 应用ID。 label String 应用的展示名称。 name String 应用在系统内的唯一标识。 description String 应用的描述信息。 type String 应用类型。 logo String 应用图标，可填图片地址（其前缀是受限的）。 properties String 应用属性。

响应示例 { "resCode": "0", "resMsg": "成功", "result": [{ "active": true, "belongTo": null, "category": null, "coreVersion": null, "createdBy": "10gd000000bZHUAq7Pea", "createdBy.__objectType": "User", "createdBy.name": "test", "createdDate": "2019-02-10 22:14:41", "custom": true, "defaultTabId": "001g0000000000000000", "defaultTabId.__objectType": "Tab", "defaultTabId.name": "Home", "description": "应用1", "id": "000f000000NhIiwso4p6", "installedPackage": "003L000000mR6pf2uFqi", "installedPackage.__objectType": "PackageInstall", "installedPackage.name": "FacilityManagement", "introductionPageID": null, "isIncremental": false, "label": "Facility Management", "lastModifiedBy": "10gd000000bZHUAq7Pea", "lastModifiedBy.__objectType": "User", "lastModifiedBy.name": "test", "lastModifiedDate": "2020-01-10 15:21:18", "logo": null, "name": "SmartCampus__FacilityManagement", "owner": "10gd000000bZHUAq7Pea", "owner.__objectType": "User", "owner.name": "test", "properties": "{\"version\":\"0.0.0\",\"packageId\":\"testPackageId\"}", "protectMode": 1, "runtimeProperties": null, "supportBO20": false, "theme": null, "type": "Custom Application", "type.name": "Custom Application", "visibility": null, "visibleScope": null }, { "active": true, "belongTo": null, "category": "", "coreVersion": "1.3.3", "createdBy": "10gd000000bZHUAq7Pea", "createdBy.__objectType": "User", "createdBy.name": "test", "createdDate": "2020-09-28 20:30:35", "custom": true, "defaultTabId": "001g0000000000000000", "defaultTabId.__objectType": "Tab", "defaultTabId.name": "Home", "description": "演示流程场景可配置案例。", "id": "000f000000ddHP8z87N2", "installedPackage": "003L000000llRwGwwuDg", "installedPackage.__objectType": "PackageInstall", "installedPackage.name": "$caseDemo_a", "introductionPageID": null, "isIncremental": false, "label": "故障单流程", "lastModifiedBy": "10gd000000bZHUAq7Pea", "lastModifiedBy.__objectType": "User", "lastModifiedBy.name": "test", "lastModifiedDate": "2021-08-02 10:20:56", "logo": "/img/03.cd9e2a5.jpg", "name": "caseDemo", "owner": "10gd000000bZHUAq7Pea", "owner.__objectType": "User", "owner.name": "test", "properties": "{\"version\":\"0.0.0\",\"packageId\":\"003G000000ddHP8QV3VA\"}", "protectMode": 0, "runtimeProperties": "{\"version\":\"180828\",\"packageId\":\"003G000000ddHP8QV3VA\"}", "supportBO20": false, "theme": null, "type": "Custom Application", "type.name": "Custom Application", "visibility": null, "visibleScope": null } ] }

请求示例 根据object_id新增trigger。 POST https://AstroZero域名/u-route/baas/metadata/v1.0/Object/cust000000aKtFZpERvc/Trigger { "name": "Trigger_01", "label": "Trigger 01", "description": null, "script": "string", "jscode": "Hello, world;rn", "active": true, "event": "BeforeInsert" }

请求参数 表2 请求Body参数 参数 是否必选 参数类型 描述 name 是 String Trigger名称。 label 否 String Trigger标签。 description 否 String trigger的描述信息。 script 是 String 实现Trigger的脚本名。 jscode 否 string Trigger下的javascript代码。 active 否 String Trigger是否激活。 event 否 String 触发时机，可选择BeforeInsert，AfterInsert，BeforeUpdate，AfterUpdate，BeforeDelete或AfterDelete。

请求示例 删除两个记录，例如删除“TestProject__testForObject__CST”对象，记录ID为“cfw0000000aKmGskAsDo”和“cfw0000000aKmGskAsDp”的数据。 DELETE https://AstroZero域名/u-route/baas/data/v1.0/bobject/TestProject__testForObject__CST?records=cfw0000000aKmGskAsDo,cfw0000000aKmGskAsDp

URL POST、GET、PUT、DELETE AstroZero域名/u-route/baas/metadata/v1.0/{object_name}/{object_id} 表1 路径参数 参数 是否必选 参数类型 描述 object_name 是 String 对象的名称。 object_id 是 String 所填对象对应的实例ID，可通过调用查询所有Object对象接口查看（响应消息中的“id”）。

响应参数 表1 响应参数 参数 参数类型 描述 resCode String 返回码，如果返回“0”代表请求成功，其他错误码说明请参考错误码。 resMsg String 返回消息，如果成功状态，通常会返回“Success”，其他情况会返回具体的错误信息。 result result object 在成功请求时会有内容返回。 表2 result参数说明 参数 参数类型 描述 name String 服务编排的公式名称。 category String 服务编排公式的类别。 format String 服务编排公式的调用格式。 description String 服务编排公式的描述信息。

请求示例 删除“TestProject__testForObject1__CST”对象中，name为“test”的记录数。 POST https://AstroZero域名/u-route/baas/data/v1.0/delete/TestProject__testForObject1__CST { "condition": { "conjunction": "AND", "conditions": [ { "field": "NAME", "operator": "eq", "value": "test" } ] } }

请求参数 表2 请求参数 参数 是否必选 参数类型 描述 condition 是 Object 表示删除的条件，其中包含以下三个元素，为空则表示删除所有对象数据。 conjunction：表示需要满足的条件个数。 AND：表示条件都要满足。 OR：表示至少要满足一个条件。 conditions：筛选条件的数组。如果参数为空，代表查询所有对象数据，若不为空，其中的每一个元素对象都包含如下三个字段。 field：类型string，字段名称。 operator：类型string，操作符。 value:类型string，对比值。 relation：数组中包含parents（向上查询）和children（向下查询）两个元素，两者分别对应相应的数组。 其中，parents包含condition数组和relatedField（关联字段名称）。children包含condition数组和relationName（关联字段名称）。 condition数组包含： conjunction：取值为AND或OR。 conditions：同上conditions参数。 relation：同上relation参数。

请求示例 运行脚本，假设脚本“命名空间__editEquipment”有输入参数equipment、name、命名空间__equipmentSN__CST。 POST https://AstroZero域名/u-route/baas/script/v1.0/run/命名空间__editEquipment?version=1.0.1 { "equipment": { "name": "某某园区A栋1单元16号", "命名空间__equipmentSN__CST": "3217890020" } }

如何使用服务编排查询数据 使用服务编排中“记录查询”图元，查询自定义对象Class（CNAME__Class__CST），实现“select name, CNAME__number__CST from CNAME__Class__CST”。 服务编排开发的相关内容，请参见如何使用服务编排开发数据的增删改查。 参考如何开发服务编排中操作，新建服务编排“flowSearchData”。 在全局上下文中，创建变量“name”、“number”，类型分别为“文本”、“数字”。 在服务编排的“基本”图元中，拖拽一个记录查询到画布，参考图4，配置对象和输出。 图4 正确配置“记录查询” 连接开始图元和记录查询图元，参考下图，配置服务编排出参。 图5 正确配置“输出” 配置完成后，单击，保存服务编排，单击，进入运行页面。 图6 保存服务编排并运行 本服务编排不需要输出参数，请直接单击“运行”，即可查看输出的json格式结果。 图7 服务编排实现查询自定义对象的字段

通过REST接口调用连接器 可以通过调用REST接口，完成表1中功能。如何调用接口，请参见连接器API。 表1 调用连接器 接口 说明 上传文件 将本地文件上传到存储中。使用该API上传文件，默认只会上传到连接器下配置的第一个桶中。待上传的文件可以是任何类型，如文本文件、图片、视频等。 下载文件 从存储中下载文件。 删除文件 从存储中删除无用的文件。 删除目录 从存储中删除某目录。如果目录下不为空，删除目录的同时也会删除该目录下文件。 列举目录下文件 列举存储中某目录下文件。 分段上传 对于较大文件上传，可以切分成段上传。用户可以在如下的应用场景内（但不仅限于此），使用分段上传的模式： 上传超过100MB大小的文件。 网络条件较差，和OBS等存储服务端之间的链接经常断开。 上传前无法确定将要上传文件的大小。 获取endpoint，即文件存储地址的前缀 endpoint为文件存储地址的前缀，该前缀加上传对象的路径，是实际访问对象的全路径。 分享Token 获取临时Token，用户只要使用该临时Token即可访问文件，不用再使用access-token进行鉴权。

前提条件 使用OBS前，需要拥有一个华为账号或一个可用于访问OBS的IAM用户，即先注册华为云并实名认证、创建IAM用户、充值以及购买资源包，具体操作请参见使用OBS前需要做的准备工作。 获取AK（Access Key ID）、SK（Secret Access Key），即访问密钥对，具体操作请参见获取AK/SK。 已在华为OBS上，创建存储桶（例如“bing.testonly.1”），用于后续存储对象使用，具体操作请参见如何创建桶，请记录创建桶时选择的区域。

响应示例 状态码： 200 OK { "totalRecord" : 2, "readWriteRatioList" : [ { "schema" : "xxxx", "table" : "xxxx", "readCount" : "215", "writeCount" : "46", "relationTables" : "xxxx", "lastUpdated" : "1619404869724" } ] } 状态码： 400 bad request { "externalMessage" : "Parameter error.", "errCode" : "DBS.280001" } 状态码： 500 server error { "externalMessage" : "Server failure.", "errCode" : "DBS.200412" }

URI GET /v2/{project_id}/instances/{instance_id}/read-write-ratio?curPage={curPage}&perPage={perPage}&startDate={startDate}&endDate={endDate} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。 获取方法请参见获取项目ID。 instance_id 是 String DDM实例ID。 表2 Query参数 参数 是否必选 参数类型 描述 curPage 是 String 分页参数：起始值 [大于等于0] 。 perPage 是 String 分页参数：每页多少条。 startDate 是 String 开始时间，UTC time，精确到毫秒。 endDate 是 String 结束时间，UTC time，精确到毫秒。结束时间与开始时间，间隔不能超过1个月。

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 totalRecord Integer DDM读写比例监控信息条数。 readWriteRatioList Array of ReadWriteRatioList objects DDM实例读写次数信息列表的集合。 表5 ReadWriteRatioList 参数 参数类型 描述 schema String 逻辑库名称。 table String 逻辑表名称。 readCount String 读次数。 writeCount String 写次数。 relationTables String 关联表。 lastUpdated String 最后执行时间。 状态码： 400 表6 响应Body参数 参数 参数类型 描述 errCode String 业务错误码 externalMessage String 错误信息 状态码： 500 表7 响应Body参数 参数 参数类型 描述 errCode String 业务错误码 externalMessage String 错误信息

URI URI格式 POST https://{Endpoint}/v3/{project_id}/nodes/{node_id}/session URI样例 https://dds.cn-north-1.myhuaweicloud.com/v3/619d3e78f61b4be68bc5aa0b59edcf7b/nodes/520c58ba00a3497e97ce0b9604874dd6no02/session

URI URI格式 POST https://{Endpoint}/v3/{project_id}/instances/{instance_id}/enlarge-volume URI样例 https://dds.cn-north-1.myhuaweicloud.com/v3/0549b4a43100d4f32f51c01c2fe4acdb/instances/9136fd2a9fcd405ea4674276ce36dae8in02/enlarge-volume

请求消息 参数说明 表2 参数说明 名称 参数类型 是否必选 描述 volume Object 是 volume请求详细信息。 详情请参见表3。 is_auto_pay Boolean 否 扩容包年包月实例的存储容量时可指定，表示是否自动从账户中支付，此字段不影响自动续订的支付方式。 true，表示自动从账户中支付。 false，表示手动从账户中支付，默认为该方式。 表3 volume字段数据结构说明 名称 参数类型 是否必选 描述 group_id String 否 角色组ID。 对于集群实例，该参数为shard组ID。 对于副本集和单节点实例，不传该参数。 size String 是 待扩容到的磁盘容量。取值为10的整数倍，并且大于当前磁盘容量。 对于集群实例，表示扩容到的单个shard组的磁盘容量。取值范围：10GB~2000GB。 对于副本集实例，表示扩容到的实例的磁盘容量，取值范围：10GB~3000GB。 对于单节点实例，表示扩容到的实例的磁盘容量，取值范围：10GB~1000GB。 node_ids Array of strings 否 副本集只读节点磁盘扩容时，需要传入该参数，当前list只支持传入一个元素。