Modifying or Deleting a Topic Level
Function
Modify or delete a topic level.
Calling Method
For details, see Calling APIs.
URI
PUT /v2/{project_id}/design/subject-levels
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 |
---|---|---|---|
levels |
No |
Array of CatalogLevelVO objects |
Theme level information. |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
data |
data object |
data: unified outermost data structure of the returned result. |
Parameter |
Type |
Description |
---|---|---|
value |
CatalogLevelVOList object |
value: unified outer data structure of the returned result. |
Parameter |
Type |
Description |
---|---|---|
levels |
Array of CatalogLevelVO objects |
Theme level information. |
Parameter |
Type |
Description |
---|---|---|
id |
String |
ID. The value of this parameter is of the String type instead of the Long type. |
level |
Integer |
Indicates the level. The value ranges from 1 to 7. |
name_ch |
String |
Chinese name |
name_en |
String |
English name. |
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. |
Status code: 404
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
This API is used to obtain the level information of a topic in the current workspace.
PUT https://{endpoint}/v2/{project_id}/design/subject-levels { "levels" : [ { "id" : "1141755876357632000", "level" : 1, "name_ch" : "Subject Area Group", "name_en" : "Business Domain Group" }, { "id" : "1141755876366020608", "level" : 2, "name_ch" : "Subject Area", "name_en" : "Business Domain" }, { "id" : "1184953097022242816", "level" : 3, "name_ch" : "Subject Area L3", "name_en" : "Business Domain L3" }, { "id" : "1184953097022242817", "level" : 4, "name_ch" : "Subject Area L4", "name_en" : "Business Domain L4" }, { "id" : "1184953097022242818", "level" : 5, "name_ch" : "Subject Area L5", "name_en" : "Business Domain L5" }, { "id" : "1141755876370214912", "level" : 6, "name_ch" : "Business Object", "name_en" : "Business Object" } ] }
Example Responses
Status code: 200
This operation succeeds, and the returned data is CatalogLevelVOList.
{ "data" : { "value" : { "levels" : [ { "id" : "1141755876357632000", "level" : 1, "name_ch" : "Subject Area Group", "name_en" : "Business Domain Group" }, { "id" : "1141755876366020608", "level" : 2, "name_ch" : "Subject Area", "name_en" : "Business Domain" }, { "id" : "1184953097022242816", "level" : 3, "name_ch" : "Subject Area L3", "name_en" : "Business Domain L3" }, { "id" : "1184953097022242817", "level" : 4, "name_ch" : "Subject Area L4", "name_en" : "Business Domain L4" }, { "id" : "1184953097022242818", "level" : 5, "name_ch" : "Subject Area L5", "name_en" : "Business Domain L5" }, { "id" : "1141755876370214912", "level" : 6, "name_ch" : "Business Object", "name_en" : "Business Object" } ] } } }
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." }
Status code: 404
{ "error_code" : "DS.60xx", "error_msg" : "The User Request API does not exist." }
SDK Sample Code
The SDK sample code is as follows.
This API is used to obtain the level information of a topic in the current 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 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 84 85 86 87 88 89 90 91 92 93 94 95 |
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 ChangeSubjectsSolution { 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(); ChangeSubjectsRequest request = new ChangeSubjectsRequest(); CatalogLevelVOList body = new CatalogLevelVOList(); List<CatalogLevelVO> listbodyLevels = new ArrayList<>(); listbodyLevels.add( new CatalogLevelVO() .withId("1141755876357632000") .withLevel(1) .withNameCh("Subject Area Group") .withNameEn("Business Domain Group") ); listbodyLevels.add( new CatalogLevelVO() .withId("1141755876366020608") .withLevel(2) .withNameCh("Subject Area") .withNameEn("Business Domain") ); listbodyLevels.add( new CatalogLevelVO() .withId("1184953097022242816") .withLevel(3) .withNameCh("Subject Area L3") .withNameEn("Business Domain L3") ); listbodyLevels.add( new CatalogLevelVO() .withId("1184953097022242817") .withLevel(4) .withNameCh("Subject Area L4") .withNameEn("Business Domain L4") ); listbodyLevels.add( new CatalogLevelVO() .withId("1184953097022242818") .withLevel(5) .withNameCh("Subject Area L5") .withNameEn("Business Domain L5") ); listbodyLevels.add( new CatalogLevelVO() .withId("1141755876370214912") .withLevel(6) .withNameCh("Business Object") .withNameEn("Business Object") ); body.withLevels(listbodyLevels); request.withBody(body); try { ChangeSubjectsResponse response = client.changeSubjects(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()); } } } |
This API is used to obtain the level information of a topic in the current 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 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 |
# 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 = ChangeSubjectsRequest() listLevelsbody = [ CatalogLevelVO( id="1141755876357632000", level=1, name_ch="Subject Area Group", name_en="Business Domain Group" ), CatalogLevelVO( id="1141755876366020608", level=2, name_ch="Subject Area", name_en="Business Domain" ), CatalogLevelVO( id="1184953097022242816", level=3, name_ch="Subject Area L3", name_en="Business Domain L3" ), CatalogLevelVO( id="1184953097022242817", level=4, name_ch="Subject Area L4", name_en="Business Domain L4" ), CatalogLevelVO( id="1184953097022242818", level=5, name_ch="Subject Area L5", name_en="Business Domain L5" ), CatalogLevelVO( id="1141755876370214912", level=6, name_ch="Business Object", name_en="Business Object" ) ] request.body = CatalogLevelVOList( levels=listLevelsbody ) response = client.change_subjects(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
This API is used to obtain the level information of a topic in the current 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 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 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 |
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.ChangeSubjectsRequest{} idLevels:= "1141755876357632000" levelLevels:= int32(1) nameChLevels:= "Subject Area Group" nameEnLevels:= "Business Domain Group" idLevels1:= "1141755876366020608" levelLevels1:= int32(2) nameChLevels1:= "Subject Area" nameEnLevels1:= "Business Domain" idLevels2:= "1184953097022242816" levelLevels2:= int32(3) nameChLevels2:= "Subject Area L3" nameEnLevels2:= "Business Domain L3" idLevels3:= "1184953097022242817" levelLevels3:= int32(4) nameChLevels3:= "Subject Area L4" nameEnLevels3:= "Business Domain L4" idLevels4:= "1184953097022242818" levelLevels4:= int32(5) nameChLevels4:= "Subject Area L5" nameEnLevels4:= "Business Domain L5" idLevels5:= "1141755876370214912" levelLevels5:= int32(6) nameChLevels5:= "Business Object" nameEnLevels5:= "Business Object" var listLevelsbody = []model.CatalogLevelVo{ { Id: &idLevels, Level: &levelLevels, NameCh: &nameChLevels, NameEn: &nameEnLevels, }, { Id: &idLevels1, Level: &levelLevels1, NameCh: &nameChLevels1, NameEn: &nameEnLevels1, }, { Id: &idLevels2, Level: &levelLevels2, NameCh: &nameChLevels2, NameEn: &nameEnLevels2, }, { Id: &idLevels3, Level: &levelLevels3, NameCh: &nameChLevels3, NameEn: &nameEnLevels3, }, { Id: &idLevels4, Level: &levelLevels4, NameCh: &nameChLevels4, NameEn: &nameEnLevels4, }, { Id: &idLevels5, Level: &levelLevels5, NameCh: &nameChLevels5, NameEn: &nameEnLevels5, }, } request.Body = &model.CatalogLevelVoList{ Levels: &listLevelsbody, } response, err := client.ChangeSubjects(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 CatalogLevelVOList. |
400 |
BadRequest |
401 |
Unauthorized |
403 |
Forbidden |
404 |
Not Found |
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