# 修改自定义项 - ModifyCustomizedFields #### 功能介绍 修改自定义项（包括表自定义项、属性自定义项、主题自定义项、业务指标自定义项）。 #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-dataartsstudio/making_request.html)。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-dataartsstudio/abcd.html)。 - 如果使用身份策略授权，当前API调用无需身份策略权限。 #### URI PUT /v2/{project_id}/design/customized-fields 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | 项目ID，获取方法请参见[项目ID和账号ID](https://support.huaweicloud.com/api-dataartsstudio/projectid_accountid.html)。 | #### 请求参数 表2请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | IAM Token，通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值） 使用Token认证时必选。 | | workspace | 是 | String | 工作空间ID，获取方法请参见[实例ID和工作空间ID](https://support.huaweicloud.com/api-dataartsstudio/dataartsstudio_02_0350.html)。 | | X-Project-Id | 否 | String | 项目ID，获取方法请参见[项目ID和账号ID](https://support.huaweicloud.com/api-dataartsstudio/projectid_accountid.html)。 多project场景采用AK/SK认证的接口请求，则该字段必选。 | | Content-Type | 否 | String | 默认值：application/json;charset=UTF-8 可选，有Body体的情况下必选，没有Body体则无需填写和校验。 | 表3请求Body参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | type | 是 | String | 自定义项类型。 枚举值： - TABLE: 表自定义项 - ATTRIBUTE: 属性自定义项 - SUBJECT: 主题自定义项 - METRIC: 业务指标自定义项 | | fields | 否 | Array of [CustomizedFieldsVO] objects | 自定义项列表。 | 表4CustomizedFieldsVO | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | id | 否 | String | 编码，ID字符串。 | | name_ch | 是 | String | 自定义项中文名称。 | | name_en | 是 | String | 自定义项英文名称。 | | not_null | 是 | Boolean | 是否必填。 | | optional_values | 否 | String | 可选值。当可选值有多个时，用分号分隔。 | | type | 是 | String | 自定义项类型。 枚举值： - TABLE: 表自定义项 - ATTRIBUTE: 属性自定义项 - SUBJECT: 主题自定义项 - METRIC: 业务指标自定义项 | | ordinal | 否 | Integer | 系统排序字段，新建、修改时不需要填写。 | | description | 否 | String | 自定义项描述。 | #### 响应参数 **状态码：200** 表5响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | data | [data] object | data，统一的返回结果的最外层数据结构。 | 表6data | 参数 | 参数类型 | 描述 | |:---|:---|:---| | value | Array of [CustomizedFieldsVO] objects | 数据连接信息数组 | 表7CustomizedFieldsVO | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | 编码，ID字符串。 | | name_ch | String | 自定义项中文名称。 | | name_en | String | 自定义项英文名称。 | | not_null | Boolean | 是否必填。 | | optional_values | String | 可选值。当可选值有多个时，用分号分隔。 | | type | String | 自定义项类型。 枚举值： - TABLE: 表自定义项 - ATTRIBUTE: 属性自定义项 - SUBJECT: 主题自定义项 - METRIC: 业务指标自定义项 | | ordinal | Integer | 系统排序字段，新建、修改时不需要填写。 | | description | String | 自定义项描述。 | | 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。 | **状态码：400** 表8响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 错误码，如DS.6000，请求处理失败。 | | error_msg | String | 错误信息。 | | data | Object | 返回的数据信息。 | **状态码：401** 表9响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 错误码，如DS.6000，请求处理失败。 | | error_msg | String | 错误信息。 | | data | Object | 返回的数据信息。 | **状态码：403** 表10响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 错误码，如DS.6000，请求处理失败。 | | error_msg | String | 错误信息。 | | data | Object | 返回的数据信息。 | #### 请求示例 修改表的自定义项。 ``` PUT https://{endpoint}/v2/{project_id}/design/customized-fields { "type" : "TABLE", "fields" : [ { "id" : "1211611269321355264", "name_ch" : "自定义项1", "name_en" : "selfDefine1", "not_null" : false, "optional_values" : "", "description" : "测试1", "ordinal" : 0, "type" : "TABLE" }, { "id" : "1211611269321355265", "name_ch" : "自定义项2", "name_en" : "selfDefine2", "not_null" : true, "optional_values" : "", "description" : "修改2", "ordinal" : 1, "type" : "TABLE" } ] } ``` #### 响应示例 **状态码：200** Success ``` { "data" : { "value" : [ { "id" : "1211611269321355264", "name_ch" : "自定义项1", "name_en" : "selfDefine1", "not_null" : false, "optional_values" : "", "type" : "TABLE", "ordinal" : 0, "description" : "测试1", "create_by" : null, "update_by" : null, "create_time" : null, "update_time" : null }, { "id" : "1211611269321355265", "name_ch" : "自定义项2", "name_en" : "selfDefine2", "not_null" : true, "optional_values" : "", "type" : "TABLE", "ordinal" : 1, "description" : "修改2", "create_by" : null, "update_by" : null, "create_time" : null, "update_time" : null } ] } } ``` **状态码：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." } ``` #### SDK代码示例 SDK代码示例如下。 - [Java] 修改表的自定义项。 ``` 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 ModifyCustomizedFieldsSolution { 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("")) .build(); ModifyCustomizedFieldsRequest request = new ModifyCustomizedFieldsRequest(); CustomizedFieldsVOList body = new CustomizedFieldsVOList(); List listbodyFields = new ArrayList<>(); listbodyFields.add( new CustomizedFieldsVO() .withId("1211611269321355264") .withNameCh("自定义项1") .withNameEn("selfDefine1") .withNotNull(false) .withOptionalValues("") .withType(CustomizedFieldsVO.TypeEnum.fromValue("TABLE")) .withOrdinal(0) .withDescription("测试1") ); listbodyFields.add( new CustomizedFieldsVO() .withId("1211611269321355265") .withNameCh("自定义项2") .withNameEn("selfDefine2") .withNotNull(true) .withOptionalValues("") .withType(CustomizedFieldsVO.TypeEnum.fromValue("TABLE")) .withOrdinal(1) .withDescription("修改2") ); body.withFields(listbodyFields); body.withType(CustomizedFieldsVOList.CustomizedFieldsVOList.fromValue("TABLE")); request.withBody(body); try { ModifyCustomizedFieldsResponse response = client.modifyCustomizedFields(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()); } } } ``` - [Python] 修改表的自定义项。 ``` # 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("")) \ .build() try: request = ModifyCustomizedFieldsRequest() listFieldsbody = [ CustomizedFieldsVO( id="1211611269321355264", name_ch="自定义项1", name_en="selfDefine1", not_null=False, optional_values="", type="TABLE", ordinal=0, description="测试1" ), CustomizedFieldsVO( id="1211611269321355265", name_ch="自定义项2", name_en="selfDefine2", not_null=True, optional_values="", type="TABLE", ordinal=1, description="修改2" ) ] request.body = CustomizedFieldsVOList( fields=listFieldsbody, type="TABLE" ) response = client.modify_customized_fields(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) ``` - [Go] 修改表的自定义项。 ``` 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, err := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). SafeBuild() if err != nil { fmt.Println(err) return } hcClient, err := dataartsstudio.DataArtsStudioClientBuilder(). WithRegion(region.ValueOf("")). WithCredential(auth). SafeBuild() if err != nil { fmt.Println(err) return } client := dataartsstudio.NewDataArtsStudioClient(hcClient) request := &model.ModifyCustomizedFieldsRequest{} idFields:= "1211611269321355264" optionalValuesFields:= "" ordinalFields:= int32(0) descriptionFields:= "测试1" idFields1:= "1211611269321355265" optionalValuesFields1:= "" ordinalFields1:= int32(1) descriptionFields1:= "修改2" var listFieldsbody = []model.CustomizedFieldsVo{ { Id: &idFields, NameCh: "自定义项1", NameEn: "selfDefine1", NotNull: false, OptionalValues: &optionalValuesFields, Type: model.GetCustomizedFieldsVoTypeEnum().TABLE, Ordinal: &ordinalFields, Description: &descriptionFields, }, { Id: &idFields1, NameCh: "自定义项2", NameEn: "selfDefine2", NotNull: true, OptionalValues: &optionalValuesFields1, Type: model.GetCustomizedFieldsVoTypeEnum().TABLE, Ordinal: &ordinalFields1, Description: &descriptionFields1, }, } request.Body = &model.CustomizedFieldsVoList{ Fields: &listFieldsbody, Type: model.GetCustomizedFieldsVoListTypeEnum().TABLE, } response, err := client.ModifyCustomizedFields(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } ``` - [更多] 更多编程语言的SDK代码示例，请参见[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/DataArtsStudio/sdk?api=ModifyCustomizedFields)的代码示例页签，可生成自动对应的SDK代码示例。 #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | Success | | 400 | BadRequest | | 401 | Unauthorized | | 403 | Forbidden |