Updating a Bandwidth Package
Function
This API is used to update a bandwidth package.
Debugging
You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.
URI
PUT /v3/{domain_id}/ccaas/bandwidth-packages/{id}
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
domain_id |
Yes |
String |
Account ID. |
id |
Yes |
String |
Instance ID. |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
No |
String |
User token. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
bandwidth_package |
Yes |
UpdateBandwidthPackage object |
Request body for updating a bandwidth package. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
name |
No |
String |
Instance name. |
description |
No |
String |
Resource description. Angle brackets (<>) are not allowed. |
bandwidth |
No |
Integer |
Bandwidth in the bandwidth package. |
billing_mode |
No |
Integer |
Billing mode of the bandwidth package on the Chinese mainland website or the international website.
|
prepaid_options |
No |
UpdatePrepaidOptions object |
Payment attributes. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
period_type |
No |
String |
Unit of a subscription period. Both monthly and yearly subscription periods are supported.
|
period_num |
No |
Integer |
Number of subscription periods. The value varies depending on the operations policy. The value ranges from 1 to 9, if period_type is set to month. The value ranges from 1 to 3, if period_type is set to year. |
is_auto_renew |
No |
Boolean |
Whether to enable auto renewal.
|
is_auto_pay |
No |
Boolean |
Whether the payment will be automatically deducted from your account balance when an order is submitted.
If you use automatic payment, the order is paid with your account balance. If you want to use cash coupons, do not use automatic payment and select the cash coupons for the payment in the Billing Center. |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
request_id |
String |
Request ID. |
bandwidth_package |
BandwidthPackage object |
Bandwidth package. |
Parameter |
Type |
Description |
---|---|---|
id |
String |
Instance ID. |
name |
String |
Instance name. |
description |
String |
Resource description. Angle brackets (<>) are not allowed. |
domain_id |
String |
ID of the account that the instance belongs to. |
enterprise_project_id |
String |
ID of the enterprise project that the resource belongs to. |
project_id |
String |
Project ID. |
created_at |
String |
Time when the resource was created. The UTC time is in the yyyy-MM-ddTHH:mm:ss format. |
updated_at |
String |
Time when the resource was updated. The UTC time must be in the yyyy-MM-ddTHH:mm:ss format. |
resource_id |
String |
ID of the resource that the bandwidth package is bound to. |
resource_type |
String |
Type of the resource that the bandwidth package is bound to. cloud_connection: The bandwidth package is bound to a cloud connection. |
local_area_id |
String |
Local geographic region. Cloud Connect is available in the following geographic regions:
|
remote_area_id |
String |
Remote geographic region. Cloud Connect is available in the following geographic regions:
|
spec_code |
String |
Specification code of the bandwidth package. |
billing_mode |
Integer |
Billing mode of the bandwidth package on the Chinese mainland website or the International website.
|
tags |
Array of Tag objects |
Resource tags. |
status |
String |
Status of the bandwidth package. ACTIVE: The bandwidth package is available. |
admin_state_up |
Boolean |
Administrative status of the bandwidth package. |
order_id |
String |
Order ID of the bandwidth package. |
product_id |
String |
Product ID of the bandwidth package. |
charge_mode |
String |
Bandwidth billing option. The bandwidth is billed by capacity. |
bandwidth |
Integer |
Capacity specified for the bandwidth package. |
interflow_mode |
String |
Bandwidth package applicability.
|
Example Requests
Changing the bandwidth capacity of a bandwidth package
PUT https://{cc_endpoint}/v3/{domain_id}/ccaas/bandwidth-packages/{id} { "bandwidth_package" : { "bandwidth" : 10 } }
Example Responses
Status code: 200
The bandwidth package has been updated.
{ "request_id" : "d58cc011274d4702642f71318e3e488c", "bandwidth_package" : { "bandwidth" : 10, "status" : "ACTIVE", "id" : "XXXXX", "name" : "test_bwp_name", "description" : "", "domain_id" : "XXX", "created_at" : "2023-09-20T08:37:15Z", "updated_at" : "2023-09-20T09:20:15Z", "project_id" : "XXX", "resource_type" : "", "resource_id" : "", "local_area_id" : "Chinese-Mainland", "remote_area_id" : "Chinese-Mainland", "admin_state_up" : true, "charge_mode" : "bandwidth", "billing_mode" : "5", "spec_code" : "bandwidth.cmtocm", "order_id" : "", "product_id" : "", "enterprise_project_id" : "0", "tags" : [ ], "interflow_mode" : "Area" } }
SDK Sample Code
The SDK sample code is as follows.
Changing the bandwidth capacity of a bandwidth package
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.GlobalCredentials; 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.cc.v3.region.CcRegion; import com.huaweicloud.sdk.cc.v3.*; import com.huaweicloud.sdk.cc.v3.model.*; public class UpdateBandwidthPackageSolution { 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"); ICredential auth = new GlobalCredentials() .withAk(ak) .withSk(sk); CcClient client = CcClient.newBuilder() .withCredential(auth) .withRegion(CcRegion.valueOf("<YOUR REGION>")) .build(); UpdateBandwidthPackageRequest request = new UpdateBandwidthPackageRequest(); request.withId("{id}"); UpdateBandwidthPackageRequestBody body = new UpdateBandwidthPackageRequestBody(); UpdateBandwidthPackage bandwidthPackagebody = new UpdateBandwidthPackage(); bandwidthPackagebody.withBandwidth(10); body.withBandwidthPackage(bandwidthPackagebody); request.withBody(body); try { UpdateBandwidthPackageResponse response = client.updateBandwidthPackage(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()); } } } |
Changing the bandwidth capacity of a bandwidth package
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 |
# coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import GlobalCredentials from huaweicloudsdkcc.v3.region.cc_region import CcRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkcc.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"] credentials = GlobalCredentials(ak, sk) client = CcClient.new_builder() \ .with_credentials(credentials) \ .with_region(CcRegion.value_of("<YOUR REGION>")) \ .build() try: request = UpdateBandwidthPackageRequest() request.id = "{id}" bandwidthPackagebody = UpdateBandwidthPackage( bandwidth=10 ) request.body = UpdateBandwidthPackageRequestBody( bandwidth_package=bandwidthPackagebody ) response = client.update_bandwidth_package(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
Changing the bandwidth capacity of a bandwidth package
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 |
package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/global" cc "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cc/v3" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cc/v3/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cc/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") auth := global.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). Build() client := cc.NewCcClient( cc.CcClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.UpdateBandwidthPackageRequest{} request.Id = "{id}" bandwidthBandwidthPackage:= int32(10) bandwidthPackagebody := &model.UpdateBandwidthPackage{ Bandwidth: &bandwidthBandwidthPackage, } request.Body = &model.UpdateBandwidthPackageRequestBody{ BandwidthPackage: bandwidthPackagebody, } response, err := client.UpdateBandwidthPackage(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 |
The bandwidth package has been updated. |
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