Updated on 2026-01-06 GMT+08:00

Modify Instance Specifications

Function

This API is used to modify the instance specifications. The account must have the payment permission. If the payment permission is not granted, an order can be generated but not automatically paid.

Calling Method

For details, see Calling APIs.

URI

PUT /v2/aad/instance

Request Parameters

Table 1 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

token

Content-Type

Yes

String

Content-Type

Table 2 Request body parameters

Parameter

Mandatory

Type

Description

instance_id

Yes

String

Instance ID.

upgrade_data

Yes

UpgradeInstanceData object

Upgrade specifications.

Table 3 UpgradeInstanceData

Parameter

Mandatory

Type

Description

basic_bandwidth

No

String

Baseline bandwidth, in Gbit/s.

elastic_bandwidth

No

String

Elastic bandwidth, in Gbit/s.

service_bandwidth

No

Integer

Service bandwidth.

port_num

No

Integer

Number of ports

bind_domain_num

No

Integer

Number of domain names.

elastic_service_bandwidth_type

No

Integer

Elastic service bandwidth. 0: disabled. 3: monthly 95th percentile billing.

elastic_service_bandwidth

No

Integer

Increased elastic service bandwidth.

basic_qps

No

Integer

Service QPS. If no QPS has been purchased for the instance, you need to upgrade the specifications on the page to enable QPS. Then, you can modify the specifications through the API.

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

order_id

String

Order ID.

Status code: 400

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_description

String

Error description.

Example Requests

None

Example Responses

None

SDK Sample Code

The SDK sample code is as follows.

 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
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.aad.v2.region.AadRegion;
import com.huaweicloud.sdk.aad.v2.*;
import com.huaweicloud.sdk.aad.v2.model.*;


public class UpgradeInstanceSpecSolution {

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

        AadClient client = AadClient.newBuilder()
                .withCredential(auth)
                .withRegion(AadRegion.valueOf("<YOUR REGION>"))
                .build();
        UpgradeInstanceSpecRequest request = new UpgradeInstanceSpecRequest();
        UpgradeInstanceSpecV2RequestBody body = new UpgradeInstanceSpecV2RequestBody();
        request.withBody(body);
        try {
            UpgradeInstanceSpecResponse response = client.upgradeInstanceSpec(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());
        }
    }
}
 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
# coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import GlobalCredentials
from huaweicloudsdkaad.v2.region.aad_region import AadRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkaad.v2 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 = AadClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(AadRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = UpgradeInstanceSpecRequest()
        request.body = UpgradeInstanceSpecV2RequestBody(
        )
        response = client.upgrade_instance_spec(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)
 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
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/global"
    aad "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/aad/v2"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/aad/v2/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/aad/v2/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 := aad.NewAadClient(
        aad.AadClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.UpgradeInstanceSpecRequest{}
	request.Body = &model.UpgradeInstanceSpecV2RequestBody{
	}
	response, err := client.UpgradeInstanceSpec(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

400

Error response

Error Codes

See Error Codes.