Help Center/ DataArts Lake Formation/ API Reference/ API/ Console/ Instance Management/ Modifying Instance Specifications
Updated on 2024-02-21 GMT+08:00
View PDF
Share

Modifying Instance Specifications

Function

This API is used to modify LakeFormation instance specifications.

URI

POST /v1/{project_id}/instances/{instance_id}/scale

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID. For how to obtain the project ID, see Obtaining a Project ID (lakeformation_04_0026.xml).

instance_id

Yes

String

LakeFormation instance ID. The value is automatically generated when the instance is created, for example, 2180518f-42b8-4947-b20b-adfc53981a25.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Tenant token.
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

specs

No

Array of CreateSpec objects

Specification list.

charge_mode

No

String

Billing type. postPaid indicates the pay-per-use billing and prePaid indicates the yearly/monthly billing.

Enumeration values:

  • postPaid

  • prePaid

change_classify

No

String

Change type. The value can be UPGRADE (upgrade) or RENEW_CHANGE (renewal change). RENEW_CHANGE takes effect only for yearly/monthly instances. The default value is SCALE_UP for pay-per-use instances.

Enumeration values:

  • UPGRADE

  • RENEW_CHANGE

charge_info

No

ChargeInfo object

Billing information. This parameter cannot be left blank when charge_mode is set to prePaid.
Table 4 CreateSpec

Parameter

Mandatory

Type

Description

product_id

No

String

Product ID. The system automatically generates a value, for example, OFFI8XXXXXXXXXXXXXXXX4.

spec_code

Yes

String

Specification code. The system automatically generates a value, for example, lakeformation.unit.basic.qps.

stride_num

Yes

Integer

Number of steps. QPS indicates the maximum number of requests per second. The minimum value is 5 and the step is 1.
Table 5 ChargeInfo

Parameter

Mandatory

Type

Description

period_type

No

String

Subscription period type. This parameter is valid and mandatory when charge_mode is set to prePaid. The options are MONTH (monthly) and YEAR (yearly).

Enumeration values:

  • MONTH

  • YEAR

period_num

No

Integer

Subscription period. This parameter is valid and mandatory only when charge_mode is set to prePaid. If period_type is set to month, the parameter value ranges from 1 to 9. If period_type is set to year, the parameter value ranges from 1 to 3. When a floating-point value is transferred, the value is automatically truncated to an integer.

is_auto_renew

No

Boolean

Whether to automatically renew the subscription. This parameter is valid and mandatory when charge_mode is set to prePaid. The payment is automatically made during subscription renewal. The default renewal period is one month for monthly subscription and one year for yearly subscription. The renewal period can be configured as needed. true: Automatic renewal is enabled. false: Automatic renewal is disabled. The default value is false.

is_auto_pay

No

Boolean

Whether the order will be automatically paid after yearly/monthly DB instances are created. This parameter does not affect the payment mode of automatic renewal. And it is valid and mandatory when charge_mode is set to prePaid. true: The order will be automatically paid. false: The order will be manually paid. The default value is false.

Response Parameters

Status code: 200

Table 6 Response header parameters

Parameter

Type

Description

X-request-id

String

Request ID, which is used to locate auxiliary information.

Status code: 400

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

common_error_code

String

CBC common error code.

solution_msg

String

Solution.

Status code: 404

Table 8 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

common_error_code

String

CBC common error code.

solution_msg

String

Solution.

Status code: 500

Table 9 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

common_error_code

String

CBC common error code.

solution_msg

String

Solution.

Example Requests

POST https://{endpoint}/v1/{project_id}/instances/{instance_id}/scale

{
  "specs" : [ {
    "spec_code" : "hws.resource.type.lakeformation.qps",
    "stride_num" : 1
  } ]
}

Example Responses

Status code: 400

Bad Request

{
  "error_code" : "common.01000001",
  "error_msg" : "failed to read http request, please check your input, code: 400, reason: Type mismatch., cause: TypeMismatchException"
}

Status code: 401

Unauthorized

{
  "error_code": 'APIG.1002',
  "error_msg": 'Incorrect token or token resolution failed'
}

Status code: 403

Forbidden

{
  "error" : {
    "code" : "403",
    "message" : "X-Auth-Token is invalid in the request",
    "error_code" : null,
    "error_msg" : null,
    "title" : "Forbidden"
  },
  "error_code" : "403",
  "error_msg" : "X-Auth-Token is invalid in the request",
  "title" : "Forbidden"
}

Status code: 404

Not Found

{
  "error_code" : "common.01000001",
  "error_msg" : "response status exception, code: 404"
}

Status code: 408

Request Timeout

{
  "error_code" : "common.00000408",
  "error_msg" : "timeout exception occurred"
}

Status code: 500

Internal Server Error

{
  "error_code" : "common.00000500",
  "error_msg" : "internal error"
}

Status Codes

Status Code

Description

200

Instance specification changed.

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

408

Request Timeout

500

Internal Server Error

Error Codes

See Error Codes.

Parent topic: Instance Management