DocsICP FilingConsole
Documentation

SwitchLSQLV3MySQLService

Updated at:
Copy as MD
Product
My Favorites

Enables or disables the Lindorm protocol that is compatible with MySQL.

Operation description

Before you call this operation, make sure that the following requirements are met:

  • The version of LindormTable for the instance is 2.6.0 or later.

  • LindormTable supports Lindorm SQL (LSQL) V3. You can check whether LSQL V3 is supported by calling the GetLindormInstance operation. If the EnableLsqlVersionV3 parameter in the response is true, LSQL V3 is supported. For instances that are purchased after October 24, 2023, this feature is enabled by default. For existing instances, contact Alibaba Cloud support for an evaluation before enabling this feature.

You can enable the MySQL protocol only if the two preceding conditions are met.

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:SwitchLSQLV3MySQLService

update

*All Resource

*

 None None

Request parameters

Parameter

Type

Required

Description

Example
InstanceId

string

Yes

The ID of the instance.

ld-bp1o3y0yme2i2****
ActionType

integer

Yes

The type of the operation. Valid values:

  • 1: Enable

  • 0: Disable

1

Response elements

Element

Type

Description

Example

object

RequestId

string

The ID of the request.

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

string

The details about the access denial.

{"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
403 MinorVersion.TooLow The minor version is too low. Please upgrade. The minor version is an earlier one. Update the minor version.
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.
403 API.Forbidden The API operation is forbidden in this environment. This operation is not supported in the current environment.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.