Updating a Dictionary
Function
This API is used to update dictionary data.
Calling Method
For details, see Calling APIs.
URI
PUT /v1/{project_id}/configurations/dictionaries
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
project_id |
Yes |
String |
Definition Project ID, which is used to specify the project that a resource belongs to. You can query the resources of a project by project ID. You can obtain the project ID from the API or console. Obtaining the Project ID Constraints N/A Range N/A Default Value N/A |
Request Parameters
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
X-Auth-Token |
Yes |
String |
User token. You can obtain it by calling the IAM API for obtaining a user token. The value of X-Subject-Token in the response header is the user token. |
|
X-Language |
Yes |
String |
Current language. |
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
dict_list |
No |
Array of DictionaryCreate objects |
Dictionary list. |
|
is_built_in |
No |
Boolean |
Whether to create a built-in dictionary. |
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
version |
No |
String |
Version number. |
|
dict_id |
Yes |
String |
Dictionary ID. |
|
dict_key |
Yes |
String |
Dictionary key. |
|
dict_code |
Yes |
String |
Dictionary code. |
|
dict_val |
Yes |
String |
Dictionary value. |
|
dict_pkey |
No |
String |
Dictionary key. |
|
dict_pcode |
No |
String |
Parent code associated with the dictionary. |
|
scope |
No |
String |
Domain the dictionary belongs to. |
|
description |
No |
String |
Dictionary description. |
|
extend_field |
No |
Object |
Additional field. |
|
language |
Yes |
String |
Current language. |
Response Parameters
Status code: 200
|
Parameter |
Type |
Description |
|---|---|---|
|
success_list |
Array of Dictionary objects |
Normal dictionary list. |
|
failed_list |
Array of Dictionary objects |
Abnormal dictionary list |
|
Parameter |
Type |
Description |
|---|---|---|
|
id |
String |
uuid |
|
version |
String |
Version number. |
|
dict_id |
String |
Dictionary ID. |
|
dict_key |
String |
Dictionary key. |
|
dict_code |
String |
Dictionary code. |
|
dict_val |
String |
Dictionary value. |
|
dict_pkey |
String |
Parent key associated with the dictionary. |
|
dict_pcode |
String |
Parent code associated with the dictionary. |
|
create_time |
String |
Creation time. |
|
update_time |
String |
Update time. |
|
publish_time |
String |
Release time. |
|
scope |
String |
Domain the dictionary belongs to. |
|
description |
String |
Dictionary description. |
|
extension_field |
Object |
Additional field. |
|
project_id |
String |
Definition Project ID, which is used to specify the project that a resource belongs to. You can query the resources of a project by project ID. You can obtain the project ID from the API or console. Obtaining the Project ID Constraints N/A Range N/A Default Value N/A |
|
language |
String |
Current language. |
Example Requests
This API is used to modify a alarm dictionary.
PUT https://{endpoint}/v1/{project_id}/configurations/dictionaries
{
"dict_list" : [ {
"version" : "1.0.0",
"dict_id" : 1,
"dict_key" : "alert_comments",
"dict_code" : "Open",
"dict_val" : "Open",
"dict_pkey" : "alert_comments",
"scope" : "ALERT",
"description" : "Alert comments action",
"extend_field" : null,
"language" : "zh"
} ],
"is_built_in" : false
}
Example Responses
Status code: 200
Dictionary list.
{
"success_list" : [ {
"id" : "02421dc8-6c80-48ed-a705-0f149f8abb77",
"version" : "1.0.0",
"dict_id" : 1,
"dict_key" : "alert_comments",
"dict_code" : "Open",
"dict_val" : "Open",
"dict_pkey" : "alert_comments",
"dict_pcode" : "Open",
"create_time" : "2024-04-26T16:08:09Z+0800",
"update_time" : "2024-04-26T16:08:09Z+0800",
"publish_time" : "2024-04-26T16:08:09Z+0800",
"scope" : "ALERT",
"description" : "Alert",
"extension_field" : null,
"project_id" : "15645*****************341da6",
"language" : "zh"
} ],
"failed_list" : [ {
"id" : "02421dc8-6c80-48ed-a705-0f149f8abb77",
"version" : "1.0.0",
"dict_id" : 1,
"dict_key" : "alert_comments",
"dict_code" : "Open",
"dict_val" : "Open",
"dict_pkey" : "alert_comments",
"dict_pcode" : "Open",
"create_time" : "2024-04-26T16:08:09Z+0800",
"update_time" : "2024-04-26T16:08:09Z+0800",
"publish_time" : "2024-04-26T16:08:09Z+0800",
"scope" : "ALERT",
"description" : "Alert",
"extension_field" : null,
"project_id" : "15645*****************341da6",
"language" : "zh"
} ]
}
SDK Sample Code
The SDK sample code is as follows.
This API is used to modify a alarm dictionary.
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 |
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.secmaster.v1.region.SecMasterRegion; import com.huaweicloud.sdk.secmaster.v1.*; import com.huaweicloud.sdk.secmaster.v1.model.*; import java.util.List; import java.util.ArrayList; public class UpdateConfigurationDictionariesSolution { 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); SecMasterClient client = SecMasterClient.newBuilder() .withCredential(auth) .withRegion(SecMasterRegion.valueOf("<YOUR REGION>")) .build(); UpdateConfigurationDictionariesRequest request = new UpdateConfigurationDictionariesRequest(); CreateDictionaryRequest body = new CreateDictionaryRequest(); List<DictionaryCreate> listbodyDictList = new ArrayList<>(); listbodyDictList.add( new DictionaryCreate() .withVersion("1.0.0") .withDictId("1") .withDictKey("alert_comments") .withDictCode("Open") .withDictVal("Open") .withDictPkey("alert_comments") .withScope("ALERT") .withDescription("Alert comments action") .withLanguage("zh") ); body.withIsBuiltIn(false); body.withDictList(listbodyDictList); request.withBody(body); try { UpdateConfigurationDictionariesResponse response = client.updateConfigurationDictionaries(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 modify a alarm dictionary.
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 |
# coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdksecmaster.v1.region.secmaster_region import SecMasterRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdksecmaster.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 = SecMasterClient.new_builder() \ .with_credentials(credentials) \ .with_region(SecMasterRegion.value_of("<YOUR REGION>")) \ .build() try: request = UpdateConfigurationDictionariesRequest() listDictListbody = [ DictionaryCreate( version="1.0.0", dict_id="1", dict_key="alert_comments", dict_code="Open", dict_val="Open", dict_pkey="alert_comments", scope="ALERT", description="Alert comments action", language="zh" ) ] request.body = CreateDictionaryRequest( is_built_in=False, dict_list=listDictListbody ) response = client.update_configuration_dictionaries(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 modify a alarm dictionary.
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 |
package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" secmaster "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/secmaster/v1" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/secmaster/v1/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/secmaster/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 := secmaster.NewSecMasterClient( secmaster.SecMasterClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.UpdateConfigurationDictionariesRequest{} versionDictList:= "1.0.0" dictPkeyDictList:= "alert_comments" scopeDictList:= "ALERT" descriptionDictList:= "Alert comments action" var listDictListbody = []model.DictionaryCreate{ { Version: &versionDictList, DictId: "1", DictKey: "alert_comments", DictCode: "Open", DictVal: "Open", DictPkey: &dictPkeyDictList, Scope: &scopeDictList, Description: &descriptionDictList, Language: "zh", }, } isBuiltInCreateDictionaryRequest:= false request.Body = &model.CreateDictionaryRequest{ IsBuiltIn: &isBuiltInCreateDictionaryRequest, DictList: &listDictListbody, } response, err := client.UpdateConfigurationDictionaries(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 |
Dictionary list. |
Error Codes
See Error Codes.
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