本文导读
修改或删除数仓分层
功能介绍
修改或删除数仓分层
调用方法
请参见如何调用API。
URI
PUT /v1/{project_id}/design/data-layers
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
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体则无需填写和校验。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
levels |
否 |
Array of DataLayerVO objects |
数仓规划请求参数。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
id |
否 |
String |
数仓分层的ID，ID字符串。 |
|
level |
是 |
Integer |
层级，从1开始。 |
|
name |
是 |
String |
中文名称。 |
|
type |
是 |
String |
数仓分层的类型，可以是关系建模（ER）、维度建模（DIMENSION）和数据集市（DM） |
|
description |
否 |
String |
数仓分层描述。 |
|
is_default |
否 |
Boolean |
是否是不可删除的默认分层，包含SDI\DWR\DM。 |
|
disabled_customized_field_ids |
否 |
Array of strings |
该分层禁用的自定义项的ID列表，包括表级自定义项和字段级自定义项。 |
响应参数
状态码：200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
data |
data object |
接口返回的数据。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
id |
String |
数仓分层的ID，ID字符串。 |
|
level |
Integer |
层级，从1开始。 |
|
name |
String |
中文名称。 |
|
type |
String |
数仓分层的类型，可以是关系建模（ER）、维度建模（DIMENSION）和数据集市（DM） |
|
description |
String |
数仓分层描述。 |
|
is_default |
Boolean |
是否是不可删除的默认分层，包含SDI\DWR\DM。 |
|
disabled_customized_field_ids |
Array of strings |
该分层禁用的自定义项的ID列表，包括表级自定义项和字段级自定义项。 |
状态码：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 |
返回的数据信息。 |
请求示例
根据参数修改数仓分层
PUT https://{endpoint}/v1/{project_id}/design/data-layers
{
"levels" : [ {
"id" : 123456,
"level" : 1,
"name" : "SDI",
"type" : "THIRD_NF",
"description" : "贴源层",
"is_default" : true,
"disabled_customized_field_ids" : [ ]
}, {
"id" : 123457,
"level" : 3,
"name" : "DWR",
"type" : "DIMENSION",
"is_default" : true,
"description" : "公共层",
"disabled_customized_field_ids" : [ ]
}, {
"id" : 123458,
"level" : 3,
"name" : "DM",
"type" : "DM",
"is_default" : true,
"description" : "集市层",
"disabled_customized_field_ids" : [ ]
} ]
}响应示例
状态码：200
Success，返回数据是DataLayerVO数组
{
"data" : {
"value" : [ {
"id" : 123456,
"level" : 1,
"name" : "SDI",
"type" : "THIRD_NF",
"description" : "贴源层",
"is_default" : true,
"disabled_customized_field_ids" : [ ]
}, {
"id" : 123457,
"level" : 3,
"name" : "DWR",
"type" : "DIMENSION",
"is_default" : true,
"description" : "公共层",
"disabled_customized_field_ids" : [ ]
}, {
"id" : 123458,
"level" : 3,
"name" : "DM",
"type" : "DM",
"is_default" : true,
"description" : "集市层",
"disabled_customized_field_ids" : [ ]
} ]
}
}状态码：400
BadRequest
{
"error_code" : "DS.60xx",
"error_msg" : "The user request is illegal."
}状态码：401
Unauthorized
{
"error_code" : "DS.60xx",
"error_msg" : "User authentication failed."
}状态码：403
Forbidden
{
"error_code" : "DS.60xx",
"error_msg" : "The user does not have permission to call this API."
}状态码：404
Not Found
{
"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 70 71 72 73 74 75 76 77 78 79 80 81 82 83 |
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 UpdateDesignDataLayersSolution {
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();
UpdateDesignDataLayersRequest request = new UpdateDesignDataLayersRequest();
DataLayerVOList body = new DataLayerVOList();
List<DataLayerVO> listbodyLevels = new ArrayList<>();
listbodyLevels.add(
new DataLayerVO()
.withId("123456")
.withLevel(1)
.withName("SDI")
.withType(DataLayerVO.TypeEnum.fromValue("THIRD_NF"))
.withDescription("贴源层")
.withIsDefault(true)
.withDisabledCustomizedFieldIds()
);
listbodyLevels.add(
new DataLayerVO()
.withId("123457")
.withLevel(3)
.withName("DWR")
.withType(DataLayerVO.TypeEnum.fromValue("DIMENSION"))
.withDescription("公共层")
.withIsDefault(true)
.withDisabledCustomizedFieldIds()
);
listbodyLevels.add(
new DataLayerVO()
.withId("123458")
.withLevel(3)
.withName("DM")
.withType(DataLayerVO.TypeEnum.fromValue("DM"))
.withDescription("集市层")
.withIsDefault(true)
.withDisabledCustomizedFieldIds()
);
body.withLevels(listbodyLevels);
request.withBody(body);
try {
UpdateDesignDataLayersResponse response = client.updateDesignDataLayers(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 55 56 57 58 59 60 |
# 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 = UpdateDesignDataLayersRequest()
listLevelsbody = [
DataLayerVO(
id="123456",
level=1,
name="SDI",
type="THIRD_NF",
description="贴源层",
is_default=True,
),
DataLayerVO(
id="123457",
level=3,
name="DWR",
type="DIMENSION",
description="公共层",
is_default=True,
),
DataLayerVO(
id="123458",
level=3,
name="DM",
type="DM",
description="集市层",
is_default=True,
)
]
request.body = DataLayerVOList(
levels=listLevelsbody
)
response = client.update_design_data_layers(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 65 66 67 68 69 70 71 72 73 74 75 76 77 78 |
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.UpdateDesignDataLayersRequest{}
idLevels:= "123456"
typeLevels:= model.GetDataLayerVoTypeEnum().THIRD_NF
descriptionLevels:= "贴源层"
isDefaultLevels:= true
idLevels1:= "123457"
typeLevels1:= model.GetDataLayerVoTypeEnum().DIMENSION
descriptionLevels1:= "公共层"
isDefaultLevels1:= true
idLevels2:= "123458"
typeLevels2:= model.GetDataLayerVoTypeEnum().DM
descriptionLevels2:= "集市层"
isDefaultLevels2:= true
var listLevelsbody = []model.DataLayerVo{
{
Id: &idLevels,
Level: int32(1),
Name: "SDI",
Type: &typeLevels,
Description: &descriptionLevels,
IsDefault: &isDefaultLevels,
},
{
Id: &idLevels1,
Level: int32(3),
Name: "DWR",
Type: &typeLevels1,
Description: &descriptionLevels1,
IsDefault: &isDefaultLevels1,
},
{
Id: &idLevels2,
Level: int32(3),
Name: "DM",
Type: &typeLevels2,
Description: &descriptionLevels2,
IsDefault: &isDefaultLevels2,
},
}
request.Body = &model.DataLayerVoList{
Levels: &listLevelsbody,
}
response, err := client.UpdateDesignDataLayers(request)
if err == nil {
fmt.Printf("%+v\n", response)
} else {
fmt.Println(err)
}
}
|
更多编程语言的SDK代码示例，请参见API Explorer的代码示例页签，可生成自动对应的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 70 71 72 73 74 75 76 77 78 79 80 81 82 83 |
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 UpdateDesignDataLayersSolution {
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();
UpdateDesignDataLayersRequest request = new UpdateDesignDataLayersRequest();
DataLayerVOList body = new DataLayerVOList();
List<DataLayerVO> listbodyLevels = new ArrayList<>();
listbodyLevels.add(
new DataLayerVO()
.withId("123456")
.withLevel(1)
.withName("SDI")
.withType(DataLayerVO.TypeEnum.fromValue("THIRD_NF"))
.withDescription("贴源层")
.withIsDefault(true)
.withDisabledCustomizedFieldIds()
);
listbodyLevels.add(
new DataLayerVO()
.withId("123457")
.withLevel(3)
.withName("DWR")
.withType(DataLayerVO.TypeEnum.fromValue("DIMENSION"))
.withDescription("公共层")
.withIsDefault(true)
.withDisabledCustomizedFieldIds()
);
listbodyLevels.add(
new DataLayerVO()
.withId("123458")
.withLevel(3)
.withName("DM")
.withType(DataLayerVO.TypeEnum.fromValue("DM"))
.withDescription("集市层")
.withIsDefault(true)
.withDisabledCustomizedFieldIds()
);
body.withLevels(listbodyLevels);
request.withBody(body);
try {
UpdateDesignDataLayersResponse response = client.updateDesignDataLayers(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 55 56 57 58 59 60 |
# 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 = UpdateDesignDataLayersRequest()
listLevelsbody = [
DataLayerVO(
id="123456",
level=1,
name="SDI",
type="THIRD_NF",
description="贴源层",
is_default=True,
),
DataLayerVO(
id="123457",
level=3,
name="DWR",
type="DIMENSION",
description="公共层",
is_default=True,
),
DataLayerVO(
id="123458",
level=3,
name="DM",
type="DM",
description="集市层",
is_default=True,
)
]
request.body = DataLayerVOList(
levels=listLevelsbody
)
response = client.update_design_data_layers(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 65 66 67 68 69 70 71 72 73 74 75 76 77 78 |
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.UpdateDesignDataLayersRequest{}
idLevels:= "123456"
typeLevels:= model.GetDataLayerVoTypeEnum().THIRD_NF
descriptionLevels:= "贴源层"
isDefaultLevels:= true
idLevels1:= "123457"
typeLevels1:= model.GetDataLayerVoTypeEnum().DIMENSION
descriptionLevels1:= "公共层"
isDefaultLevels1:= true
idLevels2:= "123458"
typeLevels2:= model.GetDataLayerVoTypeEnum().DM
descriptionLevels2:= "集市层"
isDefaultLevels2:= true
var listLevelsbody = []model.DataLayerVo{
{
Id: &idLevels,
Level: int32(1),
Name: "SDI",
Type: &typeLevels,
Description: &descriptionLevels,
IsDefault: &isDefaultLevels,
},
{
Id: &idLevels1,
Level: int32(3),
Name: "DWR",
Type: &typeLevels1,
Description: &descriptionLevels1,
IsDefault: &isDefaultLevels1,
},
{
Id: &idLevels2,
Level: int32(3),
Name: "DM",
Type: &typeLevels2,
Description: &descriptionLevels2,
IsDefault: &isDefaultLevels2,
},
}
request.Body = &model.DataLayerVoList{
Levels: &listLevelsbody,
}
response, err := client.UpdateDesignDataLayers(request)
if err == nil {
fmt.Printf("%+v\n", response)
} else {
fmt.Println(err)
}
}
|
更多编程语言的SDK代码示例，请参见API Explorer的代码示例页签，可生成自动对应的SDK代码示例。
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
Success，返回数据是DataLayerVO数组 |
|
400 |
BadRequest |
|
401 |
Unauthorized |
|
403 |
Forbidden |
|
404 |
Not Found |
