华为云用户手册

请求方法 HTTP请求方法（也称为操作或动词），它告诉服务您正在请求什么类型的操作。 表2 HTTP方法 方法 说明 GET 请求服务器返回指定资源，如获取对象列表。 PUT 请求服务器更新指定资源，如按记录ID更新数据。 POST 请求服务器新增资源或执行特殊操作，如新增对象数据。 DELETE 请求服务器删除指定资源，如按记录ID列表删除对象数据。 HEAD 请求服务器资源头部。 PATCH 请求服务器更新资源的部分内容。当资源不存在时，PATCH可能会去创建一个新的资源。 在使用OAuth 2.0的客户端鉴权模式，获取用户access_token的URI部分，您可以看到其请求方法为“POST”，则其请求为： POST https://appcube.cn-north-4.huaweicloud.com/baas/auth/v1.0/oauth2/token

发起请求 到这里为止这个请求需要的内容就具备齐全了，您可以使用curl、Postman或直接编写代码等方式发送请求调用API。 对于使用OAuth 2.0的客户端鉴权模式，获取的用户access_token接口。返回的响应消息中，“access_token”就是需要获取的用户access_token。有了access_token之后，就可以使用access_token调用华为云Astro轻应用的其他API。

请求URI 请求URI由如下部分组成： {URI-scheme} :// {Endpoint} / {resource-path} ? {query-string} 尽管请求URI包含在请求消息头中，但大多数语言或框架都要求您从请求消息中单独传递它，所以在此单独强调。 表1 URI中的参数说明 参数 说明 URI-scheme 表示用于传输请求的协议，当前所有API均采用HTTPS协议。 Endpoint 指定承载REST服务端点的华为云Astro轻应用服务器 域名 或IP。 resource-path 资源路径，即API访问路径。从具体API的URI模块获取，例如“获取用户Token”API的resource-path为“/baas/auth/v1.0/oauth2/token”。 query-string 查询参数，是可选部分，并不是每个API都有查询参数。查询参数前面需要带一个“？”，形式为“参数名=参数取值”，例如“limit=10”，表示查询不超过10条数据。多个查询参数之间使用“&”隔开。 例如，使用OAuth 2.0协议的客户端鉴权模式，获取用户access_token，“/baas/auth/v1.0/oauth2/token”为资源路径，假设华为云Astro轻应用服务开发态域名为“appcube.cn-north-4.huaweicloud.com”，URI拼接起来如下所示。 https://appcube.cn-north-4.huaweicloud.com/baas/auth/v1.0/oauth2/token

请求消息头 附加请求头字段，如指定的URI和HTTP方法所要求的字段。例如定义消息体类型的请求头“Content-Type”，请求鉴权信息等。 详细的公共请求消息头字段请参见表3。 表3 公共请求消息头 消息头名称 描述 是否必选 Content-Type HTTP协议中设定的一个参数，用于标识返回的内容用什么格式去解析。 配置为“application/json”，表示浏览器将返回内容解析为json对象。 配置为“application/x-www-form-urlencoded”，表示urlencode格式。 是 tenant-id 账号的标识，不能重复，用于定义哪个账号接收请求。 否 access-token access-token是调用华为云Astro轻应用接口API要用到的访问令牌，在调用API的时候将access-token加到请求消息头，从而通过身份认证，获得操作API的权限。 当华为云Astro轻应用的用户和业务用户通过账号密码登录华为云Astro轻应用后，后台会生成一个访问令牌，在响应消息中携带，并存在浏览器中。下次再调用请求后，会带上这个访问令牌，表示这个用户已经被鉴权过。当第三方系统要访问华为云Astro轻应用的业务接口时，需要提前使用OAuth协议进行接入认证，获取客户端鉴权ID（Client ID）和客户端鉴权密钥（Client Secret），再使用客户端鉴权ID和客户端鉴权密钥调用接口“/baas/auth/v1.0/oauth2/token”获取access_token，从而获取华为云Astro轻应用业务接口的访问令牌。 否 使用access-token认证时该字段必选。 对于使用OAuth 2.0的客户端鉴权模式，获取用户access_token接口，由于不需要access-token认证，所以只添加“Content-Type”为“application/x-www-form-urlencoded”即可，添加消息头后的请求如下所示。 POST https://appcube.cn-north-4.huaweicloud.com/baas/auth/v1.0/oauth2/token Content-Type: application/x-www-form-urlencoded

请求示例 POST https://{endpoint}/v3/{project_id}/abm/instances/{instance_id}/metadata3/signatures { "package_id": "Metamodel3", "entity_urn": "urn:abm:Metamodel3-Dataset:(urn:abm:Metamodel3-DataPlatformInstance:(MYSQL,3ca1d906860167e88b9bfbe0577a69),def.sys.x$wait_classes_global_by_avg_latency)", "entity_type": "Metamodel3-Dataset", "signatures": [ { "change_type": "UPSERT", "signature_type": "Metamodel3-securityPrivacy", "signature_name": "密级隐私", "signature_attributes": [ { "attribute_id": "Metamodel3-securityPrivacy-NAME", "attribute_name": "名称", "attribute_value": "tesk0" }, { "attribute_id": "Metamodel3-securityPrivacy-securityLevel", "attribute_name": "密级", "attribute_value": "" }, { "attribute_id": "Metamodel3-securityPrivacy-privacyLevel", "attribute_name": "隐私分级", "attribute_value": "" } ] } ] }

响应参数 状态码： 200 表5 响应Body参数 参数 参数类型 描述 success Array of 表6 objects 操作成功列表。 failure Array of 表8 objects 操作失败列表。 msg String 提示信息。 表6 MetadaSignatureResp 参数 参数类型 描述 signature_name String 特征名称。 signature_type String 特征类型。 signature_attributes Array of 表7 objects 特征属性。 表7 MetadataAttributeResp 参数 参数类型 描述 attribute_id String 属性ID。 attribute_value String 属性值。 attribute_code String 属性编码。 attribute_name String 属性名称。 表8 MetadataSignatureFailureResp 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误信息。 signature_name String 特征名称。 signature_type String 特征类型。 状态码： 400 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 状态码： 500 表10 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。

响应示例 状态码： 200 successful operation { "msg": null, "success": [ { "signature_attributes": [ { "attribute_id": "Metamodel3-securityPrivacy-NAME", "attribute_name_en": "NAME", "attribute_name": "名称", "attribute_value": "tesk0", "attribute_code": "NAME" }, { "attribute_id": "Metamodel3-securityPrivacy-securityLevel", "attribute_name_en": "SecurityLevel", "attribute_name": "密级", "attribute_value": "", "attribute_code": "securityLevel" }, { "attribute_id": "Metamodel3-securityPrivacy-privacyLevel", "attribute_name_en": "PrivacyLevel", "attribute_name": "隐私分级", "attribute_value": "", "attribute_code": "privacyLevel" } ], "signature_name": "密级隐私", "signature_type": "Metamodel3-securityPrivacy" } ], "failure": [] }

请求参数 表2 请求Body参数 参数 是否必选 参数类型 描述 package_id 是 String 模型包ID。 最小长度：1 最大长度：50 entity_urn 是 String 实体urn。 最小长度：1 最大长度：2000 signatures 否 Array of 表3 objects 特征。 表3 MetadataSignatureChangeReq 参数 是否必选 参数类型 描述 change_type 否 String 操作类型。 枚举值： UPSERT DELETE CREATE UPDATE RESTATE signature_type 是 String 特征类型。 最小长度：1 最大长度：150 signature_name 否 String 特征名称。 signature_attributes 否 Array of 表4 objects 特征属性。 表4 MetadataAttributeRequest 参数 是否必选 参数类型 描述 attribute_id 是 String 属性ID。 最大长度：200 attribute_value 否 String 属性值。

响应示例 状态码： 200 successful operation { "msg": null, "success": [ { "target_urn": "urn:abm:Metamodel3-ReportGroup:a40d2f1e8c0143dda08cc8aeb401e4", "relationship_extend": null, "from_urn": "urn:abm:Metamodel3-Report:3b0d3d1e8c0143dda08cc8ae9d058e", "relationship_code": "Metamodel3-Report-Metamodel3-ReportGroup_CO" } ], "failure": [] }

请求示例 POST https://{endpoint}/v3/{project_id}/abm/instances/{instance_id}/metadata3/relationships { "relationships": [ { "from_urn": "urn:abm:Metamodel3-Report:3b0d3d1e8c0143dda08cc8ae9d058e", "target_urn": "urn:abm:Metamodel3-ReportGroup:a40d2f1e8c0143dda08cc8aeb401e4", "relationship_code": "Metamodel3-Report-Metamodel3-ReportGroup_CO", "change_type": "UPSERT" } ] }

请求参数 表2 请求Body参数 参数 是否必选 参数类型 描述 relationships 是 Array of 表3 objects 关系，最大个数不超过200个。 表3 MetadataRelationshipRequest 参数 是否必选 参数类型 描述 from_urn 是 String 起点urn。 最小长度：1 最大长度：2000 target_urn 是 String 终点urn。 最小长度：1 最大长度：2000 relationship_code 是 String 关系编码。 最小长度：1 最大长度：255 relationship_extend 否 String 关系扩展。 change_type 是 String 操作类型。 枚举值： UPSERT DELETE

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 success Array of 表5 objects 操作成功列表。 failure Array of 表6 objects 操作失败列表。 msg String 提示信息。 表5 MetadataRelationshipResponse 参数 参数类型 描述 from_urn String 起点urn。 target_urn String 终点urn。 relationship_code String 关系编码。 relationship_extend String 关系扩展。 表6 MetadataRelationshipFailureResponse 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误信息。 from_urn String 起点urn。 target_urn String 终点urn。 relationship_code String 关系编码。 状态码： 400 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 状态码： 500 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 acknowledged Boolean true 执行成功/false 执行失败。 msg String 操作结果信息。 result 表4 object 返回结果体。 表4 ResultResp 参数 参数类型 描述 msg String 提示信息。 success Array of strings 删除成功的urn列表。 failure Array of strings 删除失败的urn列表。 状态码： 400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 状态码： 500 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。

请求示例 POST https://{endpoint}/v3/{project_id}/abm/instances/{instance_id}/metadata3/entities/delete { "entity_urns": [ "urn:abm:Metamodel3-SubjectArea:1c13a4a68c01c6d82e4ef95e5fac8c", "urn:abm:Metamodel3-SubjectArea:b2570da68c011fbf7bf8e784e9cd2c" ] }

响应示例 状态码： 200 successful operation { "msg": "", "result": { "msg": "", "success": [ "urn:abm:Metamodel3-SubjectArea:1c13a4a68c01c6d82e4ef95e5fac8c", "urn:abm:Metamodel3-SubjectArea:b2570da68c011fbf7bf8e784e9cd2c" ], "failure": [] }, "acknowledged": true }

响应参数 状态码： 200 表2 响应Body参数 参数 参数类型 描述 acknowledged Boolean true 执行成功/false 执行失败。 msg String 操作结果信息。 result 表3 object 返回结果体。 表3 ResultResp 参数 参数类型 描述 msg String 提示信息。 success Array of strings 删除成功的urn列表。 failure Array of strings 删除失败的urn列表。 状态码： 400 表4 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 状态码： 500 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。

响应示例 状态码： 200 successful operation { "msg": "", "result": { "msg": "", "success": [ "urn:abm:Metamodel3-SubjectArea:f841abee8d019f1a94c772d029db92" ], "failure": [] }, "acknowledged": true }

URI DELETE /v3/{project_id}/abm/instances/{instance_id}/metadata3/entities/{entity_urn} 表1 路径参数 参数 是否必选 参数类型 描述 entity_urn 是 String 实例urn。 project_id 是 String 项目ID，获取方法请参考获取项目ID。 instance_id 是 String 实例的ID。 最小长度：1 最大长度：64

请求示例 PUT https://{endpoint}/v3/{project_id}/abm/instances/{instance_id}/metadata3/entities/{entity_urn} { "package_id": "Metamodel3", "entity_name": "主题域02", "entity_type": "Metamodel3-SubjectArea", "entity_attributes": [ { "attribute_id": "Metamodel3-SubjectArea-NAME", "attribute_value": "" }, { "attribute_id": "Metamodel3-SubjectArea-PermissionCode", "attribute_value": "" }, { "attribute_id": "Metamodel3-SubjectArea-OrderNumber", "attribute_value": "" }, { "attribute_id": "entity_name", "attribute_value": "主题域02" } ], "signatures": [ { "signature_name": "测试", "signature_type": "Metamodel3-descriptionInfo", "signature_attributes": [ { "attribute_id": "Metamodel3-descriptionInfo-NAME", "attribute_value": "测试" }, { "attribute_id": "Metamodel3-descriptionInfo-description", "attribute_value": "" }, { "attribute_id": "Metamodel3-descriptionInfo-nameEn", "attribute_value": "" }, { "attribute_id": "Metamodel3-descriptionInfo-nameCn", "attribute_value": "" }, { "attribute_id": "Metamodel3-descriptionInfo-dataAssetNumber", "attribute_value": "" } ] }, { "signature_name": "", "signature_type": "Metamodel3-maintenanceInfo", "signature_attributes": [ { "attribute_id": "Metamodel3-maintenanceInfo-NAME", "attribute_value": "" }, { "attribute_id": "Metamodel3-maintenanceInfo-createdBy", "attribute_value": "" }, { "attribute_id": "Metamodel3-maintenanceInfo-createTime", "attribute_value": "" }, { "attribute_id": "Metamodel3-maintenanceInfo-updatedBy", "attribute_value": "" }, { "attribute_id": "Metamodel3-maintenanceInfo-updateTime", "attribute_value": "" }, { "attribute_id": "Metamodel3-maintenanceInfo-creatorAccount", "attribute_value": "" }, { "attribute_id": "Metamodel3-maintenanceInfo-updaterAccount", "attribute_value": "" } ] } ] }

响应示例 状态码： 200 successful operation { "entity_type": "Metamodel3-SubjectArea", "entity_attributes": [ { "attribute_id": "Metamodel3-SubjectArea-NAME", "attribute_name_en": "NAME", "attribute_name": "名称", "attribute_value": "", "attribute_code": "NAME" }, { "attribute_id": "Metamodel3-SubjectArea-PermissionCode", "attribute_name_en": "PermissionCode", "attribute_name": "权限编码", "attribute_value": "", "attribute_code": "PermissionCode" }, { "attribute_id": "Metamodel3-SubjectArea-OrderNumber", "attribute_name_en": "OrderNumber", "attribute_name": "顺序值", "attribute_value": "", "attribute_code": "OrderNumber" }, { "attribute_id": "entity_name", "attribute_name_en": null, "attribute_name": null, "attribute_value": "主题域02", "attribute_code": null } ], "entity_urn": "urn:abm:Metamodel3-SubjectArea:e0ee33d38c01167db2c63695f20929", "entity_name": "主题域02", "package_id": "Metamodel3", "signatures": [ { "signature_attributes": [ { "attribute_id": "Metamodel3-descriptionInfo-NAME", "attribute_name_en": "NAME", "attribute_name": "名称", "attribute_value": "测试", "attribute_code": "NAME" }, { "attribute_id": "Metamodel3-descriptionInfo-description", "attribute_name_en": "Description", "attribute_name": "描述内容", "attribute_value": "", "attribute_code": "description" }, { "attribute_id": "Metamodel3-descriptionInfo-nameEn", "attribute_name_en": "NameEn", "attribute_name": "英文名", "attribute_value": "", "attribute_code": "nameEn" }, { "attribute_id": "Metamodel3-descriptionInfo-nameCn", "attribute_name_en": "NameCn", "attribute_name": "中文名", "attribute_value": "", "attribute_code": "nameCn" }, { "attribute_id": "Metamodel3-descriptionInfo-dataAssetNumber", "attribute_name_en": "DataAssetNumber", "attribute_name": "资产编码", "attribute_value": "", "attribute_code": "dataAssetNumber" } ], "signature_name": "测试", "version": "0", "signature_type": "Metamodel3-descriptionInfo" }, { "signature_attributes": [ { "attribute_id": "Metamodel3-maintenanceInfo-NAME", "attribute_name_en": "NAME", "attribute_name": "名称", "attribute_value": "", "attribute_code": "NAME" }, { "attribute_id": "Metamodel3-maintenanceInfo-createdBy", "attribute_name_en": "CreatedBy", "attribute_name": "创建人", "attribute_value": "", "attribute_code": "createdBy" }, { "attribute_id": "Metamodel3-maintenanceInfo-createTime", "attribute_name_en": "CreateTime", "attribute_name": "创建时间", "attribute_value": "", "attribute_code": "createTime" }, { "attribute_id": "Metamodel3-maintenanceInfo-updatedBy", "attribute_name_en": "UpdatedBy", "attribute_name": "修改人", "attribute_value": "", "attribute_code": "updatedBy" }, { "attribute_id": "Metamodel3-maintenanceInfo-updateTime", "attribute_name_en": "UpdateTime", "attribute_name": "修改时间", "attribute_value": "", "attribute_code": "updateTime" }, { "attribute_id": "Metamodel3-maintenanceInfo-creatorAccount", "attribute_name_en": "CreatorAccount", "attribute_name": "创建账号", "attribute_value": "", "attribute_code": "creatorAccount" }, { "attribute_id": "Metamodel3-maintenanceInfo-updaterAccount", "attribute_name_en": "UpdaterAccount", "attribute_name": "修改账号", "attribute_value": "", "attribute_code": "updaterAccount" } ], "signature_name": "", "version": "0", "signature_type": "Metamodel3-maintenanceInfo" } ] }

响应参数 状态码： 200 表5 响应Body参数 参数 参数类型 描述 package_id String 模型包ID。 entity_urn String 实体urn。 entity_name String 实体名称。 entity_type String 实体类别。 entity_attributes Array of 表7 objects 实体属性。 signatures Array of 表6 objects 特征。 表6 MetadataEntitySignatureResp 参数 参数类型 描述 signature_name String 特征名称。 signature_type String 特征类型。 signature_attributes Array of 表7 objects 特征属性。 表7 MetadataAttributeResp 参数 参数类型 描述 attribute_id String 属性ID。 attribute_value String 属性值。 attribute_code String 属性编码。 attribute_name String 属性名称。 attribute_name_en String 属性英文名称。 状态码： 400 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 状态码： 500 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。

请求参数 表2 请求Body参数 参数 是否必选 参数类型 描述 package_id 是 String 模型包ID。 最小长度：1 最大长度：50 entity_name 是 String 实体名称。 最小长度：1 最大长度：200 entity_type 是 String 实体类型。 最小长度：1 最大长度：150 subtype 否 String 实体子类型。 最大长度：50 entity_attributes 否 Array of 表4 objects 实体属性。 signatures 否 Array of 表3 objects 特征。 表3 MetadataSignature 参数 是否必选 参数类型 描述 signature_type 是 String 特征类型。 最大长度：150 signature_name 否 String 特征名称。 最大长度：200 signature_attributes 否 Array of 表4 objects 特征属性。 表4 MetadataAttributeRequest 参数 是否必选 参数类型 描述 attribute_id 否 String 属性ID。 最大长度：200 attribute_value 否 String 属性值。

URI PUT /v3/{project_id}/abm/instances/{instance_id}/metadata3/entities/{entity_urn} 表1 路径参数 参数 是否必选 参数类型 描述 entity_urn 是 String 实例urn。 project_id 是 String 项目ID，获取方法请参考获取项目ID。 instance_id 是 String 实例的ID。 最小长度：1 最大长度：64

响应参数 状态码： 200 表6 响应Body参数 参数 参数类型 描述 success Array of 表7 objects 操作成功列表。 failure Array of 表8 objects 操作失败列表。 表7 MetadataEntitySimpleRespone 参数 参数类型 描述 entity_urn String 实体urn。 entity_name String 实体名称。 entity_type String 实体类别。 表8 MetadataEntityFailureResp 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误信息。 entity_name String 实体名称。 entity_type String 实体类别。 状态码： 400 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 状态码： 500 表10 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。

请求示例 POST https://{endpoint}/v3/{project_id}/abm/instances/{instance_id}/metadata3/entities { "entities": [ { "package_id": "Metamodel3", "entity_name": "q8", "entity_type": "Metamodel3-SubjectArea", "entity_attributes": [ { "attribute_id": "Metamodel3-SubjectArea-NAME", "attribute_value": "" }, { "attribute_id": "Metamodel3-SubjectArea-PermissionCode", "attribute_value": "" }, { "attribute_id": "Metamodel3-SubjectArea-OrderNumber", "attribute_value": "" }, { "attribute_id": "entity_name", "attribute_value": "q8" } ], "signatures": [ { "signature_name": "", "signature_type": "Metamodel3-descriptionInfo", "signature_attributes": [ { "attribute_id": "Metamodel3-descriptionInfo-NAME", "attribute_value": "" }, { "attribute_id": "Metamodel3-descriptionInfo-description", "attribute_value": "" }, { "attribute_id": "Metamodel3-descriptionInfo-nameEn", "attribute_value": "" }, { "attribute_id": "Metamodel3-descriptionInfo-nameCn", "attribute_value": "" }, { "attribute_id": "Metamodel3-descriptionInfo-dataAssetNumber", "attribute_value": "" } ] }, { "signature_name": "", "signature_type": "Metamodel3-maintenanceInfo", "signature_attributes": [ { "attribute_id": "Metamodel3-maintenanceInfo-NAME", "attribute_value": "" }, { "attribute_id": "Metamodel3-maintenanceInfo-createdBy", "attribute_value": "" }, { "attribute_id": "Metamodel3-maintenanceInfo-createTime", "attribute_value": "" }, { "attribute_id": "Metamodel3-maintenanceInfo-updatedBy", "attribute_value": "" }, { "attribute_id": "Metamodel3-maintenanceInfo-updateTime", "attribute_value": "" }, { "attribute_id": "Metamodel3-maintenanceInfo-creatorAccount", "attribute_value": "" }, { "attribute_id": "Metamodel3-maintenanceInfo-updaterAccount", "attribute_value": "" } ] } ] } ] }

响应示例 状态码： 200 successful operation { "msg": null, "success": [ { "entity_type": "Metamodel3-SubjectArea", "entity_urn": "urn:abm:Metamodel3-SubjectArea:b2570da68c011fbf7bf8e784e9cd2c", "entity_name": "q8" } ], "failure": [] }

请求参数 表2 请求Body参数 参数 是否必选 参数类型 描述 entities 是 Array of 表3 objects 实体请求列表，最大个数不超过200个。 表3 MetadataEntityRequest 参数 是否必选 参数类型 描述 package_id 是 String 模型包ID。 最小长度：1 最大长度：50 entity_name 是 String 实体名称。 最小长度：1 最大长度：200 entity_type 是 String 实体类型。 最小长度：1 最大长度：150 subtype 否 String 实体子类型。 最大长度：50 entity_attributes 否 Array of 表5 objects 实体属性。 signatures 否 Array of 表4 objects 特征。 表4 MetadataSignature 参数 是否必选 参数类型 描述 signature_type 是 String 特征类型。 signature_name 否 String 特征名称。 signature_attributes 否 Array of 表5 objects 特征属性。 表5 MetadataAttributeRequest 参数 是否必选 参数类型 描述 attribute_id 否 String 属性ID。 最大长度：200 attribute_value 否 String 属性值。

修订记录 表1 修订记录 发布日期 修订记录 2024-04-24 第六次正式发布。 优化如下章节： 概述 终端节点 API概览 构造请求 认证鉴权 返回结果 运行流并查看运行记录 查询流历史活动记录 查询单个流历史活动记录 获取流运行详细信息 2024-03-11 第五次正式发布。 新增如下章节： 应用模型 修改如下章节： API概览，增加应用模型概览。 错误码，增加应用模型错误码。 2022-11-28 第四次正式发布。 优化如下章节： API概览 权限及授权项说明 错误码 2022-11-01 第三次正式发布。 优化如下章节： 查询流历史活动记录 查询单个流历史活动记录 获取流运行详细信息 2022-09-29 第二次正式发布。 新增如下章节： 终端节点 约束与限制 基本概念 应用示例 历史API 修改如下章节： 废除webhook触发流程调用（废弃）API。 提交运行流，修改请求和响应参数。 错误码，修改部分错误码说明。 2022-04-15 第一次正式发布。

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 total Long 历史记录总数。 histories Array of histories objects 所有历史记录的信息。 表4 histories 参数 参数类型 描述 id String 流运行记录ID。 flow_id String 流ID。 flow_name String 流名称。 flow_version_id String 流运行版本ID。 run_model String 流运行模式，通常有手动、自动、测试三种。 手动：需要用户在页面单击运行流。 自动：会按照触发器的类型自动运行流。 测试：用户在创建流的时候可以测试流的功能。 status String 最后一次运行，流程运行状态。 success：流运行成功 fail：流运行失败 icon String 流图标。 start_time String 开始时间。 end_time String 结束时间。 exec_time Long 执行时间，单位：毫秒。 running_times Long 运行次数。 last_time String 最后一次运行时间。 message String 最后一次运行，输出的错误信息。 状态码： 403 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码。 最小长度：8 最大长度：36 error_msg String 错误描述。 最小长度：2 最大长度：512 状态码： 500 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码。 最小长度：8 最大长度：36 error_msg String 错误描述。 最小长度：2 最大长度：512

URI GET /v1/{project_id}/flows/{flow_id}/running-history 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID，用于资源隔离。获取方式请参考获取项目ID。 flow_id 是 String 流程ID。 表2 Query参数 参数 是否必选 参数类型 描述 time_range 否 String 时间筛选范围，UTC时间。格式：yyyy-MM-dd'T'HH:mm:ss.SSS'Z'toyyyy-MM-dd'T'HH:mm:ss.SSS'Z' 例如：2020-11-10T00:00:00Zto2020-11-12T00:00:00 status 否 String 流的状态。 枚举值： success fail offset 否 Integer 当前页，起始页数应大于等于0。 limit 否 Integer 每页记录数，每页记录数应大于等于1。