Updating the Model Workspace
Function
Update the model workspace.
Calling Method
For details, see Calling APIs.
URI
PUT /v2/{project_id}/design/workspaces
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Project ID. For details about how to obtain the project ID, see Project ID and Account ID. |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
Yes |
String |
IAM token, which is obtained by calling the IAM API for obtaining a user token (value of X-Subject-Token in the response header). This field is mandatory for authentication using tokens. |
workspace |
Yes |
String |
Workspace ID. For details about how to obtain the workspace ID, see Instance ID and Workspace ID. |
X-Project-Id |
No |
String |
Project ID. For details about how to obtain the project ID, see Project ID and Account ID. This parameter is mandatory for API requests that use AK/SK authentication in multi-project scenarios. |
Content-Type |
No |
String |
Default value: application/json;charset=UTF-8 This parameter is optional. If the body is available, this parameter is mandatory. If the body is unavailable, you do not need to set this parameter or verify it. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
id |
No |
String |
ID, which is a string |
name |
Yes |
String |
Name of the workspace. |
description |
No |
String |
Description. |
is_physical |
No |
Boolean |
Indicates whether a table is a physical table. |
frequent |
No |
Boolean |
Indicates whether it is commonly used. |
top |
No |
Boolean |
Hierarchical governance. |
level |
No |
String |
Data governance layers. Options:
|
dw_type |
No |
String |
Data connection type, which corresponds to the type of the data warehouse where the table is located. The value can be DWS, MRS_HIVE, POSTGRESQL, MRS_SPARK, CLICKHOUSE, MYSQL, ORACLE, or DORIS. |
create_by |
No |
String |
Creator. |
update_by |
No |
String |
Person who updates the information. |
type |
Yes |
String |
Defines the workspace type enumeration. Options:
|
biz_catalog_ids |
No |
String |
{"l1Ids":[],"l2Ids":[],"l3Ids":[]}: ID list of associated service catalogs. |
databases |
No |
Array of strings |
Array of database names. |
table_model_prefix |
No |
String |
Model verification prefix. The value contains a maximum of 100 characters, including digits, letters, and underscores (_), and starts with a letter. |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
data |
data object |
data: unified outermost data structure of the returned result. |
Parameter |
Type |
Description |
---|---|---|
value |
WorkspaceVO object |
value: unified outer data structure of the returned result. |
Parameter |
Type |
Description |
---|---|---|
id |
String |
ID, which is a string |
name |
String |
Name of the workspace. |
description |
String |
Description. |
is_physical |
Boolean |
Indicates whether a table is a physical table. |
frequent |
Boolean |
Indicates whether it is commonly used. |
top |
Boolean |
Hierarchical governance. |
level |
String |
Data governance layers. Options:
|
dw_type |
String |
Data connection type, which corresponds to the type of the data warehouse where the table is located. The value can be DWS, MRS_HIVE, POSTGRESQL, MRS_SPARK, CLICKHOUSE, MYSQL, ORACLE, or DORIS. |
create_time |
String |
Creation time, which is read-only. The format complies with RFC3339 and is accurate to seconds. The UTC time zone is yyyy-mm-ddTHH:MM:SSZ, for example, 1970-01-01T00:00:00Z. |
update_time |
String |
Update time, which is read-only. The format complies with RFC3339 and is accurate to seconds. The UTC time zone is yyyy-mm-ddTHH:MM:SSZ, for example, 1970-01-01T00:00:00Z. |
create_by |
String |
Creator. |
update_by |
String |
Person who updates the information. |
type |
String |
Defines the workspace type enumeration. Options:
|
biz_catalog_ids |
String |
{"l1Ids":[],"l2Ids":[],"l3Ids":[]}: ID list of associated service catalogs. |
databases |
Array of strings |
Array of database names. |
table_model_prefix |
String |
Model verification prefix. The value contains a maximum of 100 characters, including digits, letters, and underscores (_), and starts with a letter. |
Status code: 400
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code, for example, DS.6000, indicating that the request fails to be processed. |
error_msg |
String |
Error message |
data |
Object |
Returned data information. |
Status code: 401
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code, for example, DS.6000, indicating that the request fails to be processed. |
error_msg |
String |
Error message |
data |
Object |
Returned data information. |
Status code: 403
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code, for example, DS.6000, indicating that the request fails to be processed. |
error_msg |
String |
Error message |
data |
Object |
Returned data information. |
Example Requests
Update the model workspace.
PUT https://{endpoint}/v2/{project_id}/design/workspaces { "id" : "1231989920109842432", "name" : "test_update_model", "table_model_prefix" : "", "description" : "this is a demo.", "type" : "THIRD_NF", "frequent" : false, "is_physical" : "true", "dw_type" : "DWS" }
Example Responses
Status code: 200
This operation succeeds, and the returned data is WorkspaceVO.
{ "data" : { "value" : { "id" : "1231989920109842432", "name" : "test_update_model", "description" : "this is a demo.", "is_physical" : true, "frequent" : false, "top" : true, "level" : null, "dw_type" : "DWS", "create_time" : "2024-04-22T15:28:06+08:00", "update_time" : "2024-04-22T15:31:31.913+08:00", "create_by" : "test_uesr", "update_by" : "test_uesr", "type" : "THIRD_NF", "biz_catalog_ids" : null, "databases" : null, "table_model_prefix" : "" } } }
Status code: 400
{ "error_code" : "DS.60xx", "error_msg" : "The user request is illegal." }
Status code: 401
{ "error_code" : "DS.60xx", "error_msg" : "User authentication failed." }
Status code: 403
{ "error_code" : "DS.60xx", "error_msg" : "The user does not have permission to call this API." }
SDK Sample Code
The SDK sample code is as follows.
Update the model workspace.
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 |
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.*; public class UpdateWorkspaceSolution { 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(); UpdateWorkspaceRequest request = new UpdateWorkspaceRequest(); WorkspaceVO body = new WorkspaceVO(); body.withTableModelPrefix(""); body.withType(WorkspaceVO.TypeEnum.fromValue("THIRD_NF")); body.withDwType("DWS"); body.withFrequent(false); body.withIsPhysical(true); body.withDescription("this is a demo."); body.withName("test_update_model"); body.withId("1231989920109842432"); request.withBody(body); try { UpdateWorkspaceResponse response = client.updateWorkspace(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()); } } } |
Update the model workspace.
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 |
# 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 = UpdateWorkspaceRequest() request.body = WorkspaceVO( table_model_prefix="", type="THIRD_NF", dw_type="DWS", frequent=False, is_physical=True, description="this is a demo.", name="test_update_model", id="1231989920109842432" ) response = client.update_workspace(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
Update the model workspace.
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 |
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.UpdateWorkspaceRequest{} tableModelPrefixWorkspaceVo:= "" dwTypeWorkspaceVo:= "DWS" frequentWorkspaceVo:= false isPhysicalWorkspaceVo:= true descriptionWorkspaceVo:= "this is a demo." idWorkspaceVo:= "1231989920109842432" request.Body = &model.WorkspaceVo{ TableModelPrefix: &tableModelPrefixWorkspaceVo, Type: model.GetWorkspaceVoTypeEnum().THIRD_NF, DwType: &dwTypeWorkspaceVo, Frequent: &frequentWorkspaceVo, IsPhysical: &isPhysicalWorkspaceVo, Description: &descriptionWorkspaceVo, Name: "test_update_model", Id: &idWorkspaceVo, } response, err := client.UpdateWorkspace(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.
Status Codes
Status Code |
Description |
---|---|
200 |
This operation succeeds, and the returned data is WorkspaceVO. |
400 |
BadRequest |
401 |
Unauthorized |
403 |
Forbidden |
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot