Modified the process architecture.
Function
Modified the process architecture.
Calling Method
For details, see Calling APIs.
URI
PUT /v2/{project_id}/design/biz/catalogs
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 |
---|---|---|---|
name |
Yes |
String |
Workflow name |
description |
No |
String |
Description. |
guid |
No |
String |
ID in the corresponding asset. |
owner |
Yes |
String |
Owner of the instance. |
parent_id |
No |
String |
Parent directory ID. If no parent directory ID exists, the parent directory is the root directory. Set this parameter to a value of the String type instead of the Long type. |
prev_id |
No |
String |
ID of the previous node. If there is no previous node ID, the node is the first node. Set this parameter to a value of the String type instead of the Long type. |
next_id |
No |
String |
ID of the next node. If there is no next node ID, the node is the tail node. Set this parameter to a value of the String type instead of the Long type. |
id |
Yes |
String |
This parameter is left empty during creation and is mandatory during update. Set this parameter to a value of the String type instead of the Long type. |
qualified_id |
No |
String |
Authentication ID, which is automatically generated. |
create_by |
No |
String |
Creator. |
update_by |
No |
String |
Person who updates the information. |
bizmetric_num |
No |
Integer |
Number of service indicators, which is not transferred by the frontend. |
children_num |
No |
Integer |
Number of sub-processes, excluding sub-processes. |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
data |
data object |
data: unified outermost data structure of the returned result. |
Parameter |
Type |
Description |
---|---|---|
name |
String |
Workflow name |
description |
String |
Description. |
guid |
String |
ID in the corresponding asset. |
owner |
String |
Owner of the instance. |
parent_id |
String |
Parent directory ID. If no parent directory ID exists, the parent directory is the root directory. Set this parameter to a value of the String type instead of the Long type. |
prev_id |
String |
ID of the previous node. If there is no previous node ID, the node is the first node. Set this parameter to a value of the String type instead of the Long type. |
next_id |
String |
ID of the next node. If there is no next node ID, the node is the tail node. Set this parameter to a value of the String type instead of the Long type. |
id |
String |
This parameter is left empty during creation and is mandatory during update. Set this parameter to a value of the String type instead of the Long type. |
qualified_id |
String |
Authentication ID, which is automatically generated. |
create_by |
String |
Creator. |
update_by |
String |
Person who updates the information. |
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. |
bizmetric_num |
Integer |
Number of service indicators, which is not transferred by the frontend. |
children_num |
Integer |
Number of sub-processes, excluding sub-processes. |
children |
Array of BizCatalogVO objects |
Lower-level subdirectory, which is read-only. |
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
Modify the process architecture based on the input parameters.
PUT https://{endpoint}/v2/{project_id}/design/biz/catalogs { "name" : "test_czh_l2_01", "parent_id" : "1193123592125169667", "prev_id" : null, "id" : "1193132546607693824", "owner" : "{\"owners\":[\"ei_dayu_y00321344_01\"]}", "description" : "aaa" }
Example Responses
Status code: 200
Success. The returned data is BizCatalogVO.
{ "data" : { "value" : { "name" : "test_czh_l2_01", "description" : "aaa", "guid" : null, "owner" : "{\"owners\":[\"ei_dayu_y00321344_01\"]}", "parent_id" : "1193123592125169667", "prev_id" : null, "next_id" : null, "id" : "1193132546607693824", "qualified_id" : null, "create_by" : "ei_dayu_y00321344_01", "update_by" : "ei_dayu_y00321344_01", "create_time" : "2024-01-06T10:02:46+08:00", "update_time" : "2024-04-18T11:47:07.035+08:00", "bizmetric_num" : null, "children_num" : null, "children" : null } } }
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.
Modify the process architecture based on the input parameters.
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 |
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 ChangeCatalogSolution { 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(); ChangeCatalogRequest request = new ChangeCatalogRequest(); BizCatalogVO body = new BizCatalogVO(); body.withId("1193132546607693824"); body.withParentId("1193123592125169667"); body.withOwner("{"owners":["ei_dayu_y00321344_01"]}"); body.withDescription("aaa"); body.withName("test_czh_l2_01"); request.withBody(body); try { ChangeCatalogResponse response = client.changeCatalog(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()); } } } |
Modify the process architecture based on the input parameters.
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 |
# 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 = ChangeCatalogRequest() request.body = BizCatalogVO( id="1193132546607693824", parent_id="1193123592125169667", owner="{"owners":["ei_dayu_y00321344_01"]}", description="aaa", name="test_czh_l2_01" ) response = client.change_catalog(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
Modify the process architecture based on the input parameters.
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 |
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.ChangeCatalogRequest{} parentIdBizCatalogVo:= "1193123592125169667" descriptionBizCatalogVo:= "aaa" request.Body = &model.BizCatalogVo{ Id: "1193132546607693824", ParentId: &parentIdBizCatalogVo, Owner: "{"owners":["ei_dayu_y00321344_01"]}", Description: &descriptionBizCatalogVo, Name: "test_czh_l2_01", } response, err := client.ChangeCatalog(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 |
Success. The returned data is BizCatalogVO. |
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