创建主题
功能介绍
创建主题。
调用方法
请参见如何调用API。
URI
POST /v2/{project_id}/design/subjects
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
项目ID,获取方法请参见项目ID和账号ID。 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
IAM Token,通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值) 使用Token认证时必选。 |
workspace |
是 |
String |
工作空间ID,获取方法请参见实例ID和工作空间ID。 |
X-Project-Id |
否 |
String |
项目ID,获取方法请参见项目ID和账号ID。 多project场景采用AK/SK认证的接口请求,则该字段必选。 |
Content-Type |
否 |
String |
默认值:application/json;charset=UTF-8 可选,有Body体的情况下必选,没有Body体则无需填写和校验。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
entity |
是 |
CatalogEntityVO object |
catalog实体。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
typeName |
否 |
String |
类型名称,填写“BusinessCatalog”即可(业务分层)。 |
attributes |
是 |
CatalogAttributeVO object |
属性列表。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
path |
是 |
String |
路径。用“/”作为分隔,如:运营领域/云学院/云学院培训方案。 |
qualifiedName |
是 |
String |
资产名称。 |
level |
是 |
String |
主题所属层级。 |
name |
是 |
String |
名称。 |
nameEng |
是 |
String |
英文名称。 |
alias |
否 |
String |
别名。 |
description |
是 |
String |
描述。 |
dataOwner |
是 |
String |
数据主体。 |
owner |
否 |
String |
责任人。 |
dataOwnerList |
是 |
Array of strings |
数据主体列表。 |
createTime |
否 |
String |
创建时间,格式遵循RFC3339,精确到秒,UTC时区,即yyyy-mm-ddTHH:MM:SSZ,如1970-01-01T00:00:00Z。 |
createBy |
否 |
String |
创建人。 |
updateTime |
否 |
String |
更新时间,格式遵循RFC3339,精确到秒,UTC时区,即yyyy-mm-ddTHH:MM:SSZ,如1970-01-01T00:00:00Z。 |
updateBy |
否 |
String |
更新人。 |
parent |
否 |
parent object |
父节点。 |
parentId |
否 |
String |
父节点ID。 |
l1 |
否 |
Boolean |
是否为L1层。主题域分组。 |
l2 |
否 |
Boolean |
是否为L2层。主题域。 |
l3 |
否 |
Boolean |
是否为L3层。业务对象。 |
ordinal |
否 |
Integer |
顺序编号。主题返回时根据此编号由小到大排序。 |
tenantId |
否 |
String |
租户ID。获取方式参考此接口的路径参数“project_id”获取。 |
self_defined_fields |
否 |
Array of SelfDefinedFieldVO objects |
自定义项。主题的自定义属性项。 |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
data |
data object |
data,统一的返回结果的最外层数据结构。 |
参数 |
参数类型 |
描述 |
---|---|---|
name_ch |
String |
中文名称。 |
name_en |
String |
英文名称。 |
description |
String |
描述信息。 |
qualified_name |
String |
扩展名。 |
guid |
String |
guid,自动生成。 |
code |
String |
编码。 |
alias |
String |
别名。 |
status |
String |
实体的发布状态,只读,创建和更新时无需填写。 枚举值:
|
new_biz |
BizVersionManageVO object |
业务版本管理,只读。 |
data_owner |
String |
数据所有者。 |
data_owner_list |
String |
数据所有者集合。 |
data_department |
String |
数据域。 |
path |
String |
路径信息。 |
level |
Integer |
层级信息。 |
ordinal |
Integer |
序号。 |
owner |
String |
责任人。 |
parent_id |
String |
父目录ID,没有则为根目录,ID字符串。 |
swap_order_id |
String |
同层排序,目标节点的ID,ID字符串。 |
id |
String |
主题ID,ID字符串。 |
qualified_id |
String |
认证ID,自动生成。 |
from_public |
Boolean |
是否来自公共层。 |
create_by |
String |
创建人。 |
update_by |
String |
更新人。 |
create_time |
String |
创建时间,只读,格式遵循RFC3339,精确到秒,UTC时区,即yyyy-mm-ddTHH:MM:SSZ,如1970-01-01T00:00:00Z。 |
update_time |
String |
更新时间,只读,格式遵循RFC3339,精确到秒,UTC时区,即yyyy-mm-ddTHH:MM:SSZ,如1970-01-01T00:00:00Z。 |
children_num |
Integer |
拥有子流程的数量,不包括子流程的子流程,前端不传。 |
children |
Array of CatalogVO objects |
下层子目录,只读。 |
self_defined_fields |
Array of SelfDefinedFieldVO objects |
属性自定义项。 |
参数 |
参数类型 |
描述 |
---|---|---|
id |
String |
ID信息,ID字符串。 |
biz_type |
String |
业务实体类型。 枚举值:
|
biz_id |
String |
业务ID,ID字符串。 |
biz_info |
String |
业务对象信息。 |
status |
String |
实体的发布状态,只读,创建和更新时无需填写。 枚举值:
|
biz_version |
Integer |
业务版本,只读。 |
create_time |
String |
创建时间,只读,格式遵循RFC3339,精确到秒,UTC时区,即yyyy-mm-ddTHH:MM:SSZ,如1970-01-01T00:00:00Z。 |
update_time |
String |
更新时间,只读,格式遵循RFC3339,精确到秒,UTC时区,即yyyy-mm-ddTHH:MM:SSZ,如1970-01-01T00:00:00Z。 |
参数 |
参数类型 |
描述 |
---|---|---|
fd_name_ch |
String |
自定义项中文名。 |
fd_name_en |
String |
自定义项英文名。 |
not_null |
Boolean |
是否必填。 |
fd_value |
String |
属性值。 |
状态码: 400
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码,如DS.6000,请求处理失败。 |
error_msg |
String |
错误信息。 |
data |
Object |
返回的数据信息。 |
状态码: 401
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码,如DS.6000,请求处理失败。 |
error_msg |
String |
错误信息。 |
data |
Object |
返回的数据信息。 |
状态码: 403
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码,如DS.6000,请求处理失败。 |
error_msg |
String |
错误信息。 |
data |
Object |
返回的数据信息。 |
状态码: 404
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码,如DS.6000,请求处理失败。 |
error_msg |
String |
错误信息。 |
data |
Object |
返回的数据信息。 |
请求示例
根据请求参数创建主题。
POST https://{endpoint}/v2/{project_id}/design/subjects { "entity" : { "attributes" : { "path" : "test_create_catalog", "qualifiedName" : "test_create_catalog@Business", "level" : "L1", "name" : "test_create_catalog", "nameEng" : "test_create_catalog", "alias" : "", "description" : "this is a demo.", "createTime" : 1713576437311, "updateTime" : 1713576437311, "dataOwner" : "dataOwner", "dataOwnerList" : [ "test_uesr" ], "self_defined_fields" : [ ] }, "typeName" : "BusinessCatalog" } }
响应示例
状态码: 200
Success,返回data数据是entity详情。
{ "data" : { "value" : { "name_ch" : "test_create_catalog", "name_en" : "test_create_catalog", "description" : "this is a demo.", "qualified_name" : "test_create_catalog@Business.0833a5737480d53b2f25c010dc1a7b88-workspace-9ce2cfd08fda4f3b95faa5ba65fa5ec3", "guid" : null, "code" : null, "status" : "DRAFT", "new_biz" : null, "alias" : "", "data_owner" : "dataOwner", "data_owner_list" : "[\"test_uesr\"]", "data_department" : null, "path" : "test_create_catalog", "level" : 1, "ordinal" : 10, "owner" : "test_uesr", "parent_id" : null, "swap_order_id" : null, "id" : "1231174343611035648", "qualified_id" : null, "from_public" : null, "create_by" : "test_uesr", "update_by" : "test_uesr", "create_time" : "2024-04-20T09:27:17.63+08:00", "update_time" : "2024-04-20T09:27:17.63+08:00", "self_defined_fields" : [ ], "children_num" : null, "children" : null } } }
状态码: 400
{ "error_code" : "DS.60xx", "error_msg" : "The user request is illegal." }
状态码: 401
{ "error_code" : "DS.60xx", "error_msg" : "User authentication failed." }
状态码: 403
{ "error_code" : "DS.60xx", "error_msg" : "The user does not have permission to call this API." }
状态码: 404
{ "error_code" : "DS.60xx", "error_msg" : "The User Request API does not exist." }
SDK代码示例
SDK代码示例如下。
根据请求参数创建主题。
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 |
package com.huaweicloud.sdk.test; import com.huaweicloud.sdk.core.auth.ICredential; import com.huaweicloud.sdk.core.auth.BasicCredentials; import com.huaweicloud.sdk.core.exception.ConnectionException; import com.huaweicloud.sdk.core.exception.RequestTimeoutException; import com.huaweicloud.sdk.core.exception.ServiceResponseException; import com.huaweicloud.sdk.dataartsstudio.v1.region.DataArtsStudioRegion; import com.huaweicloud.sdk.dataartsstudio.v1.*; import com.huaweicloud.sdk.dataartsstudio.v1.model.*; import java.util.List; import java.util.ArrayList; public class CreateSubjectSolution { public static void main(String[] args) { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment String ak = System.getenv("CLOUD_SDK_AK"); String sk = System.getenv("CLOUD_SDK_SK"); String projectId = "{project_id}"; ICredential auth = new BasicCredentials() .withProjectId(projectId) .withAk(ak) .withSk(sk); DataArtsStudioClient client = DataArtsStudioClient.newBuilder() .withCredential(auth) .withRegion(DataArtsStudioRegion.valueOf("<YOUR REGION>")) .build(); CreateSubjectRequest request = new CreateSubjectRequest(); CatalogParamsVO body = new CatalogParamsVO(); List<String> listAttributesDataOwnerList = new ArrayList<>(); listAttributesDataOwnerList.add("test_uesr"); CatalogAttributeVO attributesEntity = new CatalogAttributeVO(); attributesEntity.withPath("test_create_catalog") .withQualifiedName("test_create_catalog@Business") .withLevel("L1") .withName("test_create_catalog") .withNameEng("test_create_catalog") .withAlias("") .withDescription("this is a demo.") .withDataOwner("dataOwner") .withDataOwnerList(listAttributesDataOwnerList) .withCreateTime("1713576437311") .withUpdateTime("1713576437311"); CatalogEntityVO entitybody = new CatalogEntityVO(); entitybody.withTypeName("BusinessCatalog") .withAttributes(attributesEntity); body.withEntity(entitybody); request.withBody(body); try { CreateSubjectResponse response = client.createSubject(request); System.out.println(response.toString()); } catch (ConnectionException e) { e.printStackTrace(); } catch (RequestTimeoutException e) { e.printStackTrace(); } catch (ServiceResponseException e) { e.printStackTrace(); System.out.println(e.getHttpStatusCode()); System.out.println(e.getRequestId()); System.out.println(e.getErrorCode()); System.out.println(e.getErrorMsg()); } } } |
根据请求参数创建主题。
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 |
# coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkdataartsstudio.v1.region.dataartsstudio_region import DataArtsStudioRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkdataartsstudio.v1 import * if __name__ == "__main__": # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak = os.environ["CLOUD_SDK_AK"] sk = os.environ["CLOUD_SDK_SK"] projectId = "{project_id}" credentials = BasicCredentials(ak, sk, projectId) client = DataArtsStudioClient.new_builder() \ .with_credentials(credentials) \ .with_region(DataArtsStudioRegion.value_of("<YOUR REGION>")) \ .build() try: request = CreateSubjectRequest() listDataOwnerListAttributes = [ "test_uesr" ] attributesEntity = CatalogAttributeVO( path="test_create_catalog", qualified_name="test_create_catalog@Business", level="L1", name="test_create_catalog", name_eng="test_create_catalog", alias="", description="this is a demo.", data_owner="dataOwner", data_owner_list=listDataOwnerListAttributes, create_time="1713576437311", update_time="1713576437311" ) entitybody = CatalogEntityVO( type_name="BusinessCatalog", attributes=attributesEntity ) request.body = CatalogParamsVO( entity=entitybody ) response = client.create_subject(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
根据请求参数创建主题。
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 |
package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" dataartsstudio "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dataartsstudio/v1" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dataartsstudio/v1/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dataartsstudio/v1/region" ) func main() { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak := os.Getenv("CLOUD_SDK_AK") sk := os.Getenv("CLOUD_SDK_SK") projectId := "{project_id}" auth := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). Build() client := dataartsstudio.NewDataArtsStudioClient( dataartsstudio.DataArtsStudioClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.CreateSubjectRequest{} var listDataOwnerListAttributes = []string{ "test_uesr", } aliasAttributes:= "" createTimeAttributes:= "1713576437311" updateTimeAttributes:= "1713576437311" attributesEntity := &model.CatalogAttributeVo{ Path: "test_create_catalog", QualifiedName: "test_create_catalog@Business", Level: "L1", Name: "test_create_catalog", NameEng: "test_create_catalog", Alias: &aliasAttributes, Description: "this is a demo.", DataOwner: "dataOwner", DataOwnerList: listDataOwnerListAttributes, CreateTime: &createTimeAttributes, UpdateTime: &updateTimeAttributes, } typeNameEntity:= "BusinessCatalog" entitybody := &model.CatalogEntityVo{ TypeName: &typeNameEntity, Attributes: attributesEntity, } request.Body = &model.CatalogParamsVo{ Entity: entitybody, } response, err := client.CreateSubject(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
状态码 |
描述 |
---|---|
200 |
Success,返回data数据是entity详情。 |
400 |
BadRequest |
401 |
Unauthorized |
403 |
Forbidden |
404 |
Not Found |