华为云用户手册

  • URI GET 华为云Astro轻应用 域名 /u-route/baas/v1.0/flow/{action}{?owner&creater&fields&orderField&orderType&limit&offset} 表1 参数说明 参数 是否必选 参数类型 描述 action 是 String 参数解释: 需要查询的服务编排状态或者根据id查询服务编排信息。 约束限制: 不涉及。 取值范围: 各个状态取值及其含义如下: activeFlow:正在执行的服务编排。 suspendedFlow:延时的服务编排。 terminatedFlow:被终止的服务编排。 completedFlow:正常完成的服务编排。 instanceId:根据id查询服务编排信息,请求时该参数需替换为具体的服务编排运行实例ID。 默认取值: 不涉及。 owner 否 String 参数解释: 所属账号ID。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 creater 否 String 参数解释: 创建者ID。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 fields 否 Array 参数解释: 字符串数组,为需要查询的字段,不传则默认。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 orderField 否 String 参数解释: 用于排序的字段,需要在fields中。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 orderType 否 String 参数解释: 排序方式。 约束限制: 不涉及。 取值范围: 0:代表Asc升序。 1:代表Desc降序。 默认取值: 不涉及。 limit 否 Integer 参数解释: 数据条数限制。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 offset 否 Integer 参数解释: 数据起始位置。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。
  • 响应参数 表2 响应参数 参数 参数类型 描述 resCode String 参数解释: 返回码。 取值范围: 如果返回“0”代表请求成功,其他错误码说明请参考错误码。 resMsg String 参数解释: 返回消息。 取值范围: 成功返回“成功”,其他情况会返回具体的错误信息。 result Object 参数解释: 成功请求时会有内容返回,内容包含请求中传入的fields中的字段或默认字段。
  • 请求参数 表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参数。 约束限制: 不涉及。
  • 请求示例 删除“TestProject__testForObject1__ CS T”对象中,name为“test”的记录数。 POST https://华为云Astro轻应用域名/u-route/baas/data/v1.0/delete/TestProject__testForObject1__CST { "condition": { "conjunction": "AND", "conditions": [ { "field": "NAME", "operator": "eq", "value": "test" } ] } }
  • URI PUT 华为云Astro轻应用域名/u-route/baas/metadata/v1.0/Picklist/{Picklist _id} 表1 路径参数 参数 是否必选 参数类型 描述 Picklist _id 是 String 参数解释: Picklist实例的ID,可通过调用查询选项列表值集接口查看(响应消息中的“id”)。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。
  • 请求参数 表2 请求参数 参数 是否必选 参数类型 描述 flag 否 String 参数解释: 服务编排的查询模式。 约束限制: 不涉及。 取值范围: 分为如下四种情况: 不带flag,按Flow_id查询服务编排。 带flag= check,按Flow_id检查服务编排信息。 带flag=Describe,按flow_id查询单个服务编排的入参出参信息。 带flag= dep,按flow_id查询单个服务编排所依赖的对象。 默认取值: 不涉及。
  • 响应示例 { "resCode": "0", "resMsg": "成功", "result": { "active": false, "catalogue": "", "compilerVersion": 0, "createdBy": "testUserId", "createdBy.__objectType": "User", "createdBy.name": "test0xx", "createdDate": "2019-08-03 18:19:13", "custom": true, "description": "", "event": "", "eventCriteria": "", "id": "testId", "installedPackage": null, "interviewLabel": "", "label": "A Brand New Label", "lastModifiedBy": "testUserId", "lastModifiedBy.__objectType": "User", "lastModifiedBy.name": "test0xx", "lastModifiedDate": "2019-08-04 17:57:29", "localUrl": "", "lockUser": "", "name": "testName", "owner": "testUserId", "owner.__objectType": "User", "owner.name": "test0xx", "private": false, "processType": "", "protectMode": 0, "reserved": 0, "startElement": "", "status": "Error", "usingSLA": null, "version": "1.0.1" } }
  • 终止(即取消)分段上传任务 功能描述 分段上传任务可以被取消,当一个分段上传任务被取消后,就不能再使用其“uploadId”做任何操作,已经上传段也会被删除。 采用分段上传方式上传文件过程中或上传文件失败后会在桶内产生段,这些段会占用存储空间,可以通过取消该分段上传任务来清理掉不需要的段,节约存储空间。 URI POST 华为云Astro轻应用域名/u-route/baas/sys/v1.1/connectors/{connector_type}/{connector_name}/abortupload?object=X&uploadId=Y 表9 路径参数 参数 是否必选 参数类型 描述 connector_type 是 String 参数解释: 连接器的类型。 约束限制: 不涉及。 取值范围: obs:与OBS对接的连接器。 minio:与MINIO对接的连接器。 objectstorageproxy:对象存储代理类型。 默认取值: 不涉及。 connector_name 是 String 参数解释: 连接器实例的名称,即创建连接器时命名的连接器实例名称。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 object 是 String 参数解释: 上传文件到桶里的全路径,包含文件名、文件类型、上传到桶里的路径。不携带路径时,表示上传到桶的根目录下。 示例:取值为“a/b/c/test.mp4”,表示将文件“test.mp4”上传到桶的“a/b/c”路径下。如果桶中不存在该路径,会创建该路径。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 uploadId 是 String 参数解释: 整个分段上传任务的标识,请从初始化分段上传任务的返回结果中获取该值。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 请求参数 无 响应参数 表10 响应参数说明 参数 参数类型 描述 resCode String 参数解释: 返回码。 取值范围: 如果返回“0”代表请求成功,其他错误码说明请参考错误码。 resMsg String 参数解释: 返回消息。 取值范围: 成功返回“成功”,其他情况会返回具体的错误信息。 请求示例 已创建好OBS类型连接器,连接器实例名称为“命名空间__TestOBS”,需要向该OBS桶的“a/b/c”路径下上传大文件。已有初始化分段上传任务和分段上传任务,标识“uploadId”为“0000017B76500F0662CABA7128913936”,调用如下请求,取消该分段上传任务。 POST https://华为云Astro轻应用域名/u-route/baas/sys/v1.1/connectors/obs/命名空间__TestOBS/abortupload?object=a/b/c/test3.mp4&uploadId=0000017B76500F0662CABA7128913936 响应示例 { "resCode": "0", "resMsg": "成功" }
  • 完成上传合并段 功能介绍 所有分段上传完成后,需要调用完成上传接口,在存储服务端(如OBS)合并段生成最终对象文件。在执行完成上传操作时,需要提供所有有效的分段列表(包括分段号和分段ETag值)。华为云Astro轻应用收到提交的分段列表后,会逐一验证每个段的有效性。当所有段验证通过后,将把这些分段组合成最终的对象。合并的分段任务可以是不连续的分段号。 完成上传任务后,“uploadId”就失效了,不能再用于终止(即取消)分段上传任务。 URI POST 华为云Astro轻应用域名/u-route/baas/sys/v1.1/connectors/{connector_type}/{connector_name}/completeupload?object=X&uploadId=Y 表6 路径参数 参数 是否必选 参数类型 描述 connector_type 是 String 参数解释: 连接器的类型。 约束限制: 不涉及。 取值范围: obs:与OBS对接的连接器。 minio:与MINIO对接的连接器。 objectstorageproxy:对象存储代理类型。 默认取值: 不涉及。 connector_name 是 String 参数解释: 连接器实例的名称,即创建连接器时命名的连接器实例名称。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 object 是 String 参数解释: 上传文件到桶里的全路径,包含文件名、文件类型、上传到桶里的路径。不携带路径时,表示上传到桶的根目录下 示例:取值为“a/b/c/test.mp4”,表示将文件“test.mp4”上传到桶的“a/b/c”路径下。如果桶中不存在该路径,会创建该路径。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 uploadId 是 String 参数解释: 整个分段上传任务的标识,从初始化分段上传任务的返回结果中获取该值。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 请求参数 数组类型,每个元素中包含如表7所示字段。 表7 请求参数说明 参数 是否必选 参数类型 描述 ETag 是 String 参数解释: 文件分段的标识,请从上传分段的返回结果中获取该值。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 partNumber 是 String 参数解释: 分段号。 对于同一个分段上传任务(即uploadId相同),分段号“partNumber”不但唯一标识这一段数据,也标识了这段数据在整个对象文件内的相对位置,从上传分段的返回结果中获取该值。 约束限制: 不涉及。 取值范围: 1~10000。 默认取值: 不涉及。 响应参数 表8 响应参数说明 参数 参数类型 描述 resCode String 参数解释: 返回码。 取值范围: 如果返回“0”代表请求成功,其他错误码说明请参考错误码。 resMsg String 参数解释: 返回消息。 取值范围: 成功返回“成功”,其他情况会返回具体的错误信息。 请求示例 已创建好OBS类型连接器,连接器实例名称为“命名空间__TestOBS”,需要向该OBS桶的“a/b/c”路径下上传大文件。已有初始化分段上传任务和两个分段上传任务,标识“uploadId”为“0000017B761F112966C45D8FF0F75F13”,调用如下请求,完成分段上传任务,合并所有分段生成最终对象文件。 POST https://华为云Astro轻应用域名/u-route/baas/sys/v1.1/connectors/obs/命名空间__TestOBS/completeupload?object=a/b/c/test.mp4&uploadId=0000017B761F112966C45D8FF0F75F13 [{ "ETag": "\"d41d8cd98f00b204e9800998ecf8427e\"", "partNumber": 1 }, { "ETag": "\"7dcad0c8a7398333ff25418bad511581\"", "partNumber": 2 }] 响应示例 { "resCode": "0", "resMsg": "成功" }
  • 上传分段 功能介绍 初始化分段上传任务之后,可以根据指定的对象文件名和“uploadId”来分段上传数据。每一个上传的段都有一个标识它的号码,即分段号(partNumber,范围是1~10000)。对于同一个分段上传任务(即uploadId相同),分段号“partNumber”不但唯一标识这一段数据,也标识了这段数据在整个对象文件内的相对位置。如果使用同一个分段号上传了新的数据,那么存储服务端上已有的这个段号的数据将被覆盖。除了最后一个分段以外,其他分段大小必须大于5MB,最大值对于OBS、MINIO本身来说没有限制,通过华为云Astro轻应用平台该接口调用时,所有分段最大值不超过100MB。每个分段不需要按顺序上传,可以在不同进程、不同机器上传,存储服务端会按照分段号排序组成最终对象。 URI POST 华为云Astro轻应用域名/u-route/baas/sys/v1.1/connectors/{connector_type}/{connector_name}/uploadpart?object=X&uploadId=Y&partNumber=Z 表4 路径参数 参数 是否必选 参数类型 描述 connector_type 是 String 参数解释: 连接器的类型。 约束限制: 不涉及。 取值范围: obs:与OBS对接的连接器。 minio:与MINIO对接的连接器。 objectstorageproxy:对象存储代理类型。 默认取值: 不涉及。 connector_name 是 String 参数解释: 连接器实例的名称,即创建连接器时命名的连接器实例名称。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 object 是 String 参数解释: 上传文件到桶里的全路径,包含文件名、文件类型、上传到桶里的路径。不携带路径时,表示上传到桶的根目录下 示例:取值为“a/b/c/test.mp4”,表示将文件“test.mp4”上传到桶的“a/b/c”路径下。如果桶中不存在该路径,会创建该路径。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 uploadId 是 String 参数解释: 整个分段上传任务的标识,从初始化分段上传任务的返回结果中获取该值。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 partNumber 是 Number 参数解释: 分段号。 对于同一个分段上传任务(即uploadId相同),分段号“partNumber”不但唯一标识这一段数据,也标识了这段数据在整个对象文件内的相对位置。 约束限制: 不涉及。 取值范围: 1~10000。 默认取值: 不涉及。 请求参数 请求中的body类型,按照“application/octet-stream”格式上传文件分段内容。 响应参数 表5 响应参数说明 参数 参数类型 描述 resCode String 参数解释: 返回码。 取值范围: 如果返回“0”代表请求成功,其他错误码说明请参考错误码。 resMsg String 参数解释: 返回消息。 取值范围: 成功返回“成功”,其他情况会返回具体的错误信息。 result Object 参数解释: 返回分段任务对象,包含如下字段: ETag:文件分段的标识, 用于后续完成上传时使用。 partNumber:分段号,用于后续完成上传时使用。 请求示例 已创建好OBS类型连接器,连接器实例名称为“命名空间__TestOBS”,需要向该OBS桶的“a/b/c”路径下上传大文件。已有初始化分段上传任务,标识“uploadId”为“0000017B761F112966C45D8FF0F75F13”,调用如下请求,创建分段上传任务,上传test.mp4,分段号为“1”。 POST https://华为云Astro轻应用域名/u-route/baas/sys/v1.1/connectors/obs/命名空间__TestOBS/uploadpart?object=a/b/c/test.mp4&uploadId=0000017B761F112966C45D8FF0F75F13&partNumber=1 在请求Body中设置“application/octet-stream”格式的object,即要上传的文件数据。 响应示例 { "resCode": "0", "resMsg": "成功", "result": { "ETag": "\"d41d8cd98f00b204e9800998ecf8427e\"", "partNumber": 1 } } 请记录下“ETag”和“partNumber”的值,后续完成上传时需要使用。
  • 请求示例 查询“TestProject__testForObject1__CST”对象中,name为“lisi”的记录数。 POST https://华为云Astro轻应用域名/u-route/baas/data/v1.0/count/TestProject__testForObject1__CST { "condition": { "conjunction": "AND", "conditions": [ { "field": "NAME", "operator": "eq", "value": "lisi" } ] } }
  • 请求参数 表2 请求参数 参数 是否必选 参数类型 描述 condition 是 Object 参数解释: 表示查询的条件。包含以下三个元素,若为空则表示查询所有对象数据。 conjunction:表示需要满足的条件个数。 AND:表示条件都要满足。 OR:表示至少要满足一个条件。 conditions:筛选条件的数组。如果参数为空,代表查询所有对象数据,若不为空,其中的每一个元素对象都包含三个字段: field:字段名称。 operator:操作符。例如,操作符“eq”表示等于,“ne”表示不等于,“gt”表示大于,“lt”表示小于,“ge”表示大于等于,“le”表示小于等于。 value:对比值。 relation:数组中包含parents(向上查询)和children(向下查询)两个元素,两者分别对应相应的数组。 其中,parents包含condition数组和relatedField(关联字段名称)。children包含condition数组和relationName(关联字段名称)。 约束限制: 不涉及。
  • URI DELETE 华为云Astro轻应用域名/u-route/baas/sys/v1.1/connectors/{connector_type}/{connector_name}/delobject?object=X 表1 路径参数 参数 是否必选 参数类型 描述 connector_type 是 String 参数解释: 连接器的类型。 约束限制: 不涉及。 取值范围: obs:与OBS对接的连接器。 minio:与MINIO对接的连接器。 objectstorageproxy:对象存储代理类型。 默认取值: 不涉及。 connector_name 是 String 参数解释: 连接器实例的名称,即创建连接器时设置的连接器实例名。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 object 是 String 参数解释: 文件所在桶里的全路径,包含文件名。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。
  • 请求方法 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 }
共100000条