Updating Extended Parameters for Reliability Detection on a Virtual Interface
Function
This API is used to update extended parameters for reliability detection on a virtual interface, such as min_rx_interval, min_tx_interval, and detect_multiplier. A virtual interface supports two reliability detection modes: BFD and NQA.
Calling Method
For details, see Calling APIs.
Authorization Information
Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.
- If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
- If you are using identity policy-based authorization, no identity policy-based permissions are required for calling this API.
URI
PUT /v3/{project_id}/dcaas/virtual-interfaces/{virtual_interface_id}/extend-attributes
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| project_id | Yes | String | Definition Specifies the project ID. Constraints N/A Range N/A Default Value N/A |
| virtual_interface_id | Yes | String | Definition Specifies the virtual interface ID. Constraints N/A Range The value can contain up to 36 characters in UUID format and is connected by hyphens (-). Default Value N/A |
Request Parameters
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| X-Auth-Token | Yes | String | Definition Specifies the user token. To obtain the token, see section "Obtaining the User Token" in the Identity and Access Management API Reference. After the request is processed, the value of X-Subject-Token in the header is the token value. Constraints N/A Range N/A Default Value N/A |
Response Parameters
Status code: 200
| Parameter | Type | Description |
|---|---|---|
| request_id | String | Definition Specifies the request ID. Range N/A |
| extend_attribute | VifExtendAttribute object | Definition Specifies extended parameters when BFD or NQA is used for reliability detection. |
Example Requests
Updating ha_type to bfd, ha_mode to auto_single, min_rx_interval to 500, min_tx_interval to 500, and detect_multiplier to 3.
PUT https://{dc_endpoinent}/v3/4bd6efdb0fb747b39aa2c0162c112226/dcaas/virtual-interfaces/96201035-6a29-49f2-bd2c-a6bb641dd500/extend-attributes
{
"extend_attribute" : {
"ha_type" : "bfd",
"ha_mode" : "auto_single",
"min_rx_interval" : 500,
"min_tx_interval" : 500,
"detect_multiplier" : 3
}
} Example Responses
Status code: 200
Specifies the response body for updating the extended parameters of the virtual interface reliability detection.
{
"request_id" : "c31651e323414fa89c5cfba267a3035b",
"extend_attribute" : {
"ha_type" : "bfd",
"ha_mode" : "auto_single",
"min_rx_interval" : 500,
"min_tx_interval" : 500,
"detect_multiplier" : 3
}
} SDK Sample Code
The SDK sample code is as follows.
Updating ha_type to bfd, ha_mode to auto_single, min_rx_interval to 500, min_tx_interval to 500, and detect_multiplier to 3.
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 | 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.dc.v3.region.DcRegion; import com.huaweicloud.sdk.dc.v3.*; import com.huaweicloud.sdk.dc.v3.model.*; public class UpdateExtendAttributeSolution { 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); DcClient client = DcClient.newBuilder() .withCredential(auth) .withRegion(DcRegion.valueOf("<YOUR REGION>")) .build(); UpdateExtendAttributeRequest request = new UpdateExtendAttributeRequest(); request.withVirtualInterfaceId("{virtual_interface_id}"); UpdateExtendAttributeRequestBody body = new UpdateExtendAttributeRequestBody(); VifExtendAttribute extendAttributebody = new VifExtendAttribute(); extendAttributebody.withHaType(VifExtendAttribute.HaTypeEnum.fromValue("bfd")) .withHaMode(VifExtendAttribute.HaModeEnum.fromValue("auto_single")) .withDetectMultiplier(3) .withMinRxInterval(500) .withMinTxInterval(500); body.withExtendAttribute(extendAttributebody); request.withBody(body); try { UpdateExtendAttributeResponse response = client.updateExtendAttribute(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()); } } } |
Updating ha_type to bfd, ha_mode to auto_single, min_rx_interval to 500, min_tx_interval to 500, and detect_multiplier to 3.
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 | # coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkdc.v3.region.dc_region import DcRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkdc.v3 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 = DcClient.new_builder() \ .with_credentials(credentials) \ .with_region(DcRegion.value_of("<YOUR REGION>")) \ .build() try: request = UpdateExtendAttributeRequest() request.virtual_interface_id = "{virtual_interface_id}" extendAttributebody = VifExtendAttribute( ha_type="bfd", ha_mode="auto_single", detect_multiplier=3, min_rx_interval=500, min_tx_interval=500 ) request.body = UpdateExtendAttributeRequestBody( extend_attribute=extendAttributebody ) response = client.update_extend_attribute(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
Updating ha_type to bfd, ha_mode to auto_single, min_rx_interval to 500, min_tx_interval to 500, and detect_multiplier to 3.
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 | package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" dc "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dc/v3" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dc/v3/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dc/v3/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 := dc.DcClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). SafeBuild() if err != nil { fmt.Println(err) return } client := dc.NewDcClient(hcClient) request := &model.UpdateExtendAttributeRequest{} request.VirtualInterfaceId = "{virtual_interface_id}" haTypeExtendAttribute:= model.GetVifExtendAttributeHaTypeEnum().BFD haModeExtendAttribute:= model.GetVifExtendAttributeHaModeEnum().AUTO_SINGLE detectMultiplierExtendAttribute:= int32(3) minRxIntervalExtendAttribute:= int32(500) minTxIntervalExtendAttribute:= int32(500) extendAttributebody := &model.VifExtendAttribute{ HaType: &haTypeExtendAttribute, HaMode: &haModeExtendAttribute, DetectMultiplier: &detectMultiplierExtendAttribute, MinRxInterval: &minRxIntervalExtendAttribute, MinTxInterval: &minTxIntervalExtendAttribute, } request.Body = &model.UpdateExtendAttributeRequestBody{ ExtendAttribute: extendAttributebody, } response, err := client.UpdateExtendAttribute(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 | OK |
Error Codes
See Error Codes.
What is your overall rating for this page?
Thank 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