All Products
Search
Document Center

Lindorm:UpdateLindormInstanceAttribute

Last Updated:Sep 18, 2026

Updates the instance name or deletion protection.

Operation description

When you create an instance, select at least one data engine. For example, to create a LindormTable engine, you must specify both the LindormNum (number of LindormTable engine nodes) and LindormSpec (LindormTable engine node specifications) parameters. For more information about data engines and storage specifications, see How to select a data engine and How to select storage specifications.

Important If you do not specify data engine parameters when creating an instance, the API call fails.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

  • Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.

  • API: The API that you can call to perform the action.

  • Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.

  • Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.

    • For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.

    • For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.

  • Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.

  • Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

lindorm:UpdateLindormInstanceAttribute

update

*Instance

acs:lindorm:{#regionId}:{#accountId}:instance/{#InstanceId}

None None

Request parameters

Parameter

Type

Required

Description

Example

InstanceId

string

Yes

The instance ID.

ld-bp1z3506imz2f****

InstanceAlias

string

No

The instance name.

lindorm-test

DeletionProtection

boolean

No

Specifies whether to enable deletion protection. Valid values:

  • true: Enabled.

  • false: Disabled.

true

DispositionType

string

No

The risk disposition type for a single zone.

Valid values:

  • EXTERNAL_BIZ_HA :

    External business high availability.

  • PLAN_MIGRATION :

    Planned migration.

  • NO_SET :

    Not set.

PLAN_MIGRATION

PlannedCompletionDate

string

No

The planned completion date for risk disposition, in the yyyy-MM-dd format.

2026-10-01

Response elements

Element

Type

Description

Example

object

RequestId

string

The request ID.

1556DCB0-043A-4444-8BD9-CF4A68E7EE64

AccessDeniedDetail

string

The detailed reason why access was denied.

{"AuthAction":"xxx","AuthPrincipalDisplayName":"222","AuthPrincipalOwnerId":"111","AuthPrincipalType":"SubUser",,"NoPermissionType":"ImplicitDeny","PolicyType":"AccountLevelIdentityBasedPolicy","EncodedDiagnosticMessage":"xxxxxx"}

Examples

Success response

JSON format

{
  "RequestId": "1556DCB0-043A-4444-8BD9-CF4A68E7EE64",
  "AccessDeniedDetail": "{\"AuthAction\":\"xxx\",\"AuthPrincipalDisplayName\":\"222\",\"AuthPrincipalOwnerId\":\"111\",\"AuthPrincipalType\":\"SubUser\",,\"NoPermissionType\":\"ImplicitDeny\",\"PolicyType\":\"AccountLevelIdentityBasedPolicy\",\"EncodedDiagnosticMessage\":\"xxxxxx\"}"
}

Error codes

HTTP status code

Error code

Error message

Description

400 Lindorm.Errorcode.ParameterInvaild The parameter is invalid.
400 Instance.IsNotValid The instance is invalid. The specified instance is invalid.
403 API.Forbidden The API operation is forbidden in this environment. This operation is not supported in the current environment.
403 Lindorm.Errorcode.OperationDenied You are not authorized to operate on the specified resource. You are not authorized to manage the specified resource.
403 Lindorm.Errorcode.ServiceLinkedRoleNoPermission No permission to create service linked role. You are not authorized to create the service-linked role.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.