Renaming a Dedicated WAF Instance
Function
This API is used to rename a dedicated WAF engine. Dedicated WAF instances are supported only in some regions, including: CN North-Beijing4, CN East-Shanghai1, CN South-Guangzhou, CN South-Shenzhen, CN-Hong Kong, AP-Bangkok, AP-Singapore
Calling Method
For details, see Calling APIs.
URI
PUT /v1/{project_id}/premium-waf/instance/{instance_id}
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Project ID. To obtain it, go to Huawei Cloud management console and hover the cursor over your username. On the displayed window, choose My Credentials. Then, in the Projects area, view Project ID of the corresponding project. |
instance_id |
Yes |
String |
ID of the dedicated WAF instance. It can be obtained by calling the WAF ListInstance API |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
enterprise_project_id |
No |
String |
ID of the enterprise project. It can be obtained by calling the ListEnterpriseProject API of EPS. |
Request 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. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
instancename |
Yes |
String |
New name of the dedicated WAF engine. |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
id |
String |
ID of the dedicated WAF instance. |
instancename |
String |
Name of the dedicated WAF instance. |
region |
String |
ID of the region where the dedicated WAF instance is deployed. |
zone |
String |
AZ ID. |
arch |
String |
CPU architecture. |
cpu_flavor |
String |
ECS specifications. |
vpc_id |
String |
ID of the VPC where the dedicated WAF instance locates. |
subnet_id |
String |
ID of the VPC subnet where the dedicated WAF instance locates. |
service_ip |
String |
Service plane IP address of the dedicated WAF instance. |
security_group_ids |
Array of strings |
Security group where the dedicated WAF instance is added. |
status |
Integer |
Billing status of the dedicated WAF instance.
|
run_status |
Integer |
Running status of the dedicated instance. The value can be any of the following:
|
access_status |
Integer |
Access status of the dedicated engine. The value 0 indicates that the dedicated engine is not connected, and the value 1 indicates that the dedicated engine is connected. |
upgradable |
Integer |
Whether the dedicated engine can be upgraded (0: no; 1: yes) |
cloudServiceType |
String |
Cloud service code This parameter is used as an identifier only. You can ignore this parameter. |
resourceType |
String |
Cloud service resource type, which is used as an identifier only. You can ignore this parameter. |
resourceSpecCode |
String |
Cloud service resource code This parameter is used as an identifier only. You can ignore this parameter. |
specification |
String |
Dedicated engine ECS specifications, for example, 8 vCPUs | 16 GB |
serverId |
String |
ID of the ECS hosting the dedicated engine |
create_time |
Long |
Time the dedicated WAF instance is created. |
Status code: 400
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. |
error_msg |
String |
Error message. |
Status code: 401
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. |
error_msg |
String |
Error message. |
Status code: 500
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. |
error_msg |
String |
Error message. |
Example Requests
The following example shows how to update a dedicated WAF instance in a project. The project ID is specified by project_id, and the instance ID is specified by instance_id. The new instance name is 0412elb.
PUT https://{endpoint}/v1/{project_id}/premium-waf/instance/{instance_id} { "instancename" : "0412elb" }
Example Responses
Status code: 200
Request succeeded.
{ "id" : "0619871acb764d48a112695e8f7cbb10", "region" : "region-01-7", "zone" : "region-01-7a", "specification" : "8vCPUs | 16GB", "arch" : "x86", "upgradable" : 0, "status" : 0, "serverId" : "477353dc-8687-4bf4-b45b-1d7fee74fa63", "cloudServiceType" : "hws.service.type.waf", "resourceType" : "hws.resource.type.waf.instance", "resourceSpecCode" : "waf.instance.enterprise", "vpc_id" : "13718074-a3f9-408d-82aa-3c41ef55e589", "subnet_id" : "74d1b5a6-c7eb-4e9a-8372-181212552fcc", "service_ip" : "192.168.10.68", "security_group_ids" : [ "34287bdb-7aba-471a-b041-27427f1af76a" ], "cpu_flavor" : "Si2.2xlarge.2", "run_status" : 2, "access_status" : 1, "instancename" : "0412elb", "create_time" : 1649217360674 }
SDK Sample Code
The SDK sample code is as follows.
The following example shows how to update a dedicated WAF instance in a project. The project ID is specified by project_id, and the instance ID is specified by instance_id. The new instance name is 0412elb.
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 |
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.*; public class RenameInstanceSolution { 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(); RenameInstanceRequest request = new RenameInstanceRequest(); request.withInstanceId("{instance_id}"); RenameInstanceRequestBody body = new RenameInstanceRequestBody(); body.withInstancename("0412elb"); request.withBody(body); try { RenameInstanceResponse response = client.renameInstance(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 dedicated WAF instance in a project. The project ID is specified by project_id, and the instance ID is specified by instance_id. The new instance name is 0412elb.
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 |
# 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 = RenameInstanceRequest() request.instance_id = "{instance_id}" request.body = RenameInstanceRequestBody( instancename="0412elb" ) response = client.rename_instance(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 dedicated WAF instance in a project. The project ID is specified by project_id, and the instance ID is specified by instance_id. The new instance name is 0412elb.
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 |
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.RenameInstanceRequest{} request.InstanceId = "{instance_id}" request.Body = &model.RenameInstanceRequestBody{ Instancename: "0412elb", } response, err := client.RenameInstance(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.
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