ModifyInstance

Updated at:

You can call the ModifyInstance operation to upgrade the resource configuration of an instance. This operation creates an order for the resource upgrade and automatically completes the payment.

Debug

You can run this operation directly in OpenAPI Explorer. This saves you the trouble of calculating signatures. After a successful run, OpenAPI Explorer can automatically generate SDK code examples.

Request parameters

Name

Type

Required

Sample value

Description

Action

String

Yes

ModifyInstance

The operation to perform. Set the value to ModifyInstance.

ModifyType

String

Yes

Upgrade

The modification type. For DataBase Audit, set the value to Upgrade.

Parameter.1.Code

String

Yes

SeriesCode

The code of the first group of properties for DataBase Audit. Set the value to SeriesCode. This parameter specifies the model series of the DataBase Audit instance.

Parameter.1.Value

String

Yes

alpha

The value of the first group of properties for DataBase Audit. Set the value to alpha. This value indicates that the model series of the DataBase Audit instance is C100.

Parameter.2.Code

String

Yes

NetworkType

The code of the second group of properties for DataBase Audit. Set the value to NetworkType. This parameter specifies the network type of the DataBase Audit instance.

Parameter.2.Value

String

Yes

vpc

The value of the second group of properties for DataBase Audit. Set the value to vpc. This value indicates that the network type of the DataBase Audit instance is VPC.

Parameter.3.Code

String

Yes

PlanCode

The code of the third group of properties for DataBase Audit. Set the value to PlanCode. This parameter specifies the edition of the DataBase Audit instance.

Parameter.3.Value

String

Yes

alpha.basic

The value of the third group of properties for DataBase Audit. This parameter specifies the edition of the DataBase Audit instance. Valid values:

  • alpha.advance: Enterprise Edition, which supports 25 instances.

  • alpha.advanceplus: Enterprise Plus Edition, which supports 50 instances.

  • alpha.professional: Professional Edition, which supports 3 instances.

  • alpha.basic: Premium Edition, which supports 5 instances.

  • alpha.premium: Premium Plus Edition, which supports 10 instances.

  • alpha.ultimate: Ultimate Edition, which supports 80 instances.

Parameter.4.Code

String

Yes

LogStorage

The code of the fourth group of properties for DataBase Audit. Set the value to LogStorage. This parameter specifies the log storage capacity of the DataBase Audit instance.

Parameter.4.Value

String

Yes

5

The value of the fourth group of properties for DataBase Audit. This parameter specifies the log storage capacity of the DataBase Audit instance. The value can be an integer from 0 to 200. Unit: TB.

Parameter.5.Code

String

Yes

RegionId

The code of the fifth group of properties for DataBase Audit. Set the value to RegionId. This parameter specifies the region of the DataBase Audit instance.

Parameter.5.Value

String

Yes

cn-shanghai

The value of the fifth group of properties for DataBase Audit. This parameter specifies the region where DataBase Audit is available. Valid values:

  • Regions in China

    • cn-hangzhou: China (Hangzhou)

    • cn-shanghai: China (Shanghai)

    • cn-qingdao: China (Qingdao)

    • cn-beijing: China (Beijing)

    • cn-zhangjiakou: China (Zhangjiakou)

    • cn-shenzhen: China (Shenzhen)

    • cn-huhehaote: China (Hohhot)

    • cn-chengdu: China (Chengdu)

    • cn-hongkong: China (Hong Kong)

  • Regions outside China

    • ap-northeast-1: Japan (Tokyo)

    • ap-southeast-1: Singapore

    • ap-southeast-3: Malaysia (Kuala Lumpur)

    • ap-southeast-5: Indonesia (Jakarta)

    • us-east-1: US (Virginia)

    • us-west-1: US (Silicon Valley)

    • eu-central-1: Germany (Frankfurt)

ProductCode

String

Yes

dbaudit

The product code.

The product code for Database Audit is dbaudit.

SubscriptionType

String

Yes

Subscription

Billing method

The billing method. For DataBase Audit, set this parameter to Subscription, which indicates the subscription billing method.

ProductType

String

No

dbaudit

The product type. You do not need to specify this parameter.

InstanceId

String

No

dbaudit-cn-****

The ID of the instance for which you want to change the configuration.

ClientToken

String

No

JASIOFKVNVI****

A client token to ensure the idempotence of the request. The server checks for requests with the same client token. If a match is found, the server returns the result of the previous call. This prevents duplicate request submissions.

Returned data

Name

Type

Example

Description

Code

String

Success

The status code of the request.

Data

Struct

The data returned for the request.

HostId

String

testId

The host ID.

OrderId

String

2026532523****

The ID of the order that was created.

Message

String

Successful!

The error message returned for the request.

RequestId

String

6000EE23-274B-4E07-A697-FF2E999520A4

The ID of the request.

Success

Boolean

true

Indicates whether the request was successful.

Examples

Request example

http(s)://[Endpoint]/?Action=ModifyInstance
&ModifyType=Upgrade
&Parameter.1.Code=SeriesCode
&Parameter.1.Value=alpha
&Parameter.2.Code=NetworkType
&Parameter.2.Value=vpc
&Parameter.3.Code=PlanCode
&Parameter.3.Value=alpha.basic
&Parameter.4.Code=LogStorage
&Parameter.4.Value=5
&Parameter.5.Code=RegionId
&Parameter.5.Value=cn-shanghai
&ProductCode=dbaudit
&SubscriptionType=Subscription
&<Common request parameters>

Response example

XML format

<ModifyInstanceResponse>
      <Message>Successful!</Message>
      <RequestId>6000EE23-274B-4E07-A697-FF2E999520A4</RequestId>
      <Success>true</Success>
      <Code>Success</Code>
      <Data>
            <OrderId>2026532523****</OrderId>
      </Data>
</ModifyInstanceResponse>

JSON format

{
    "Message": "Successful!",
    "RequestId": "6000EE23-274B-4E07-A697-FF2E999520A4",
    "Success": true,
    "Code": "Success",
    "Data": {
        "OrderId": "2026532523****"
    }
}

Error codes

For more information about error codes, visit the Error Center.