All Products
Search
Document Center

:ModifyInstance

Last Updated:Mar 01, 2024

Modifies the configurations of a specified instance.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

There is currently no authorization information disclosed in the API.

Request syntax

PUT /v2/openapi/instances/{instanceId}

Request parameters

ParameterTypeRequiredDescriptionExample
instanceIdstringYes

The instance ID.

airec-cn-xxxxxx

Response parameters

ParameterTypeDescriptionExample
object
resultobject

The returned results.

regionIdstring

The region where the instance resides.

cn-beijing
typestring

The type of the instance. Only the Standard edition is supported.

Standard
lockModestring

The lock mode of the instance. Valid values: Unlock, ManualLock, and LockByExpiration.

Unlock
expiredTimestring

The time when the instance expires. The time follows the ISO 8601 standard in the yyyy-MM-ddThh:mm:ssZ format.The time is displayed in UTC.

2019-01-06T16:00:00.000Z
statusstring

The state of the instance. Valid values: Initializing, Ready, and Running.

Running
gmtCreatestring

The time when the instance was created. The time follows the ISO 8601 standard in the yyyy-MM-ddThh:mm:ssZ format. The time is displayed in UTC.

2018-12-06T06:14:01.000Z
chargeTypestring

The billing method. Valid values: PrePaid and PostPaid. Only the PrePaid billing method is supported.

PrePaid
industrystring

The type of the industry. Valid values: content, item, news, video, and sns.

news
commodityCodestring

The commodity code of the recommended item.

airecpre
gmtModifiedstring

The time when the instance was last modified. The time follows the ISO 8601 standard in the yyyy-MM-ddThh:mm:ssZ format. The time is displayed in UTC.

2018-12-06T11:17:49.000Z
dataSetVersionstring

The version of the dataset that provides online services.

20181206170353
namestring

The name of the instance.

Test instance
instanceIdstring

The instance ID.

airec-cn-o400whm78004
codestring

The error code.

InternalServerError
requestIdstring

The request ID.

8F81A922-6C81-46D6-B78C-CC35E16B1691
messagestring

The error message.

An internal server error occurred

Examples

Sample success responses

JSONformat

{
  "result": {
    "regionId": "cn-beijing",
    "type": "Standard",
    "lockMode": "Unlock",
    "expiredTime": "2019-01-06T16:00:00.000Z",
    "status": "Running",
    "gmtCreate": "2018-12-06T06:14:01.000Z",
    "chargeType": "PrePaid",
    "industry": "news",
    "commodityCode": "airecpre",
    "gmtModified": "2018-12-06T11:17:49.000Z",
    "dataSetVersion": "20181206170353",
    "name": "Test instance\n",
    "instanceId": "airec-cn-o400whm78004"
  },
  "code": "InternalServerError",
  "requestId": "8F81A922-6C81-46D6-B78C-CC35E16B1691",
  "message": "An internal server error occurred"
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
No change history