Updated on 2024-07-02 GMT+08:00

Modifying a Reference Table

Function

This API is used to modify a reference table.

Calling Method

For details, see Calling APIs.

URI

PUT /v1/{project_id}/waf/valuelist/{valuelistid}

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID. To obtain it, go to Huawei Cloud management cons**. Then, in the Projects area, view Project ID of the corresponding project.

valuelistid

Yes

String

Reference table ID. It can be obtained by calling the ListValueList API.

Table 2 Query Parameters

Parameter

Mandatory

Type

Description

enterprise_project_id

No

String

You can obtain the ID by calling the ListEnterpriseProject API of EPS.

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token. It can be obtained by calling the IAM API (value of X-Subject-Token in the response header).

Content-Type

Yes

String

Content type.

Table 4 Request body parameters

Parameter

Mandatory

Type

Description

name

Yes

String

Reference table name, which is a string of 2 to 32 characters.

type

Yes

String

Reference table type. For details, see the enumeration list.

values

No

Array of strings

Value of the reference table

description

No

String

Reference table description. The value contains a maximum of 128 characters.

Response Parameters

Status code: 200

Table 5 Response body parameters

Parameter

Type

Description

id

String

ID of the reference table

name

String

Reference table name.

type

String

Reference table type

description

String

Reference table description

values

Array of strings

Value of the reference table

producer

Integer

Source of the reference table.

  • 1: The reference table was created by you.

  • 2: The reference table was created by the intelligent access control protection.

Status code: 400

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 401

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 500

Table 8 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Example Requests

The following example shows how to update a reference table. Its ID is valuelistid in the project. The project ID is specified by project_id. The reference table name is RPmvp0m4, the reference table type is response_coderl, the value is 500, and the description is demo.

PUT https://{Endpoint}/v1/{project_id}/waf/valuelist/{valuelistid}?enterprise_project_id=0

{
  "name" : "RPmvp0m4",
  "type" : "response_code",
  "values" : [ "500" ],
  "description" : "demo"
}

Example Responses

Status code: 200

Request succeeded.

{
  "id" : "63b1d9edf2594743bc7c6ee98527306c",
  "name" : "RPmvp0m4",
  "type" : "response_code",
  "values" : [ "500" ],
  "description" : "demo",
  "producer" : 1
}

SDK Sample Code

The SDK sample code is as follows.

The following example shows how to update a reference table. Its ID is valuelistid in the project. The project ID is specified by project_id. The reference table name is RPmvp0m4, the reference table type is response_coderl, the value is 500, and the description is demo.

 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
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.waf.v1.region.WafRegion;
import com.huaweicloud.sdk.waf.v1.*;
import com.huaweicloud.sdk.waf.v1.model.*;

import java.util.List;
import java.util.ArrayList;

public class UpdateValueListSolution {

    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);

        WafClient client = WafClient.newBuilder()
                .withCredential(auth)
                .withRegion(WafRegion.valueOf("<YOUR REGION>"))
                .build();
        UpdateValueListRequest request = new UpdateValueListRequest();
        request.withValuelistid("{valuelistid}");
        UpdateValueListRequestBody body = new UpdateValueListRequestBody();
        List<String> listbodyValues = new ArrayList<>();
        listbodyValues.add("500");
        body.withDescription("demo");
        body.withValues(listbodyValues);
        body.withType(UpdateValueListRequestBody.TypeEnum.fromValue("response_code"));
        body.withName("RPmvp0m4");
        request.withBody(body);
        try {
            UpdateValueListResponse response = client.updateValueList(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());
        }
    }
}

The following example shows how to update a reference table. Its ID is valuelistid in the project. The project ID is specified by project_id. The reference table name is RPmvp0m4, the reference table type is response_coderl, the value is 500, and the description is demo.

 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 huaweicloudsdkwaf.v1.region.waf_region import WafRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkwaf.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 = WafClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(WafRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = UpdateValueListRequest()
        request.valuelistid = "{valuelistid}"
        listValuesbody = [
            "500"
        ]
        request.body = UpdateValueListRequestBody(
            description="demo",
            values=listValuesbody,
            type="response_code",
            name="RPmvp0m4"
        )
        response = client.update_value_list(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

The following example shows how to update a reference table. Its ID is valuelistid in the project. The project ID is specified by project_id. The reference table name is RPmvp0m4, the reference table type is response_coderl, the value is 500, and the description is demo.

 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
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    waf "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/waf/v1"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/waf/v1/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/waf/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 := waf.NewWafClient(
        waf.WafClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.UpdateValueListRequest{}
	request.Valuelistid = "{valuelistid}"
	var listValuesbody = []string{
        "500",
    }
	descriptionUpdateValueListRequestBody:= "demo"
	request.Body = &model.UpdateValueListRequestBody{
		Description: &descriptionUpdateValueListRequestBody,
		Values: &listValuesbody,
		Type: model.GetUpdateValueListRequestBodyTypeEnum().RESPONSE_CODE,
		Name: "RPmvp0m4",
	}
	response, err := client.UpdateValueList(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

Request succeeded.

400

Request failed.

401

The token does not have required permissions.

500

Internal server error.

Error Codes

See Error Codes.