GetSqlInstance - Simple Log Service - Alibaba Cloud Documentation Center

Queries information about the Dedicated SQL instance of a project, such as the number of compute units (CUs) and whether the Dedicated SQL instance is enabled by default. Before you call this operation, you must create a Dedicated SQL instance by calling the CreateSqlInstance or UpdateSqlInstance operation.

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

log:GetSqlInstance

none

*Project

acs:log:{#regionId}:{#accountId}:project/{#ProjectName}

None

Request syntax

GET /sqlinstance HTTP/1.1

Request parameters

Parameter

Type

Required

Description

Example

No parameters required.

Response elements

Element	Type	Description	Example
	array	Dedicated SQL instance
	object	Dedicated SQL instance
name	string	The value is group1. This is an internal parameter that you can ignore.	group1
cu	integer	The maximum number of CUs that the Dedicated SQL version can use. A CU is a compute core that can be used for parallel processing when the Dedicated SQL version is running.	2
createTime	integer	The time when the configuration for the Dedicated SQL version was created. This is a UNIX timestamp.	1710230272。Unix时间戳。
updateTime	integer	The time when the configuration for the Dedicated SQL version was updated. This is a UNIX timestamp.	1710230272
useAsDefault	boolean	Indicates whether the Dedicated SQL version is enabled by default for the project. If this parameter is set to true, all query and analysis operations in the project, such as alerts and dashboards, use the Dedicated SQL version.	true

Examples

Success response

JSON format

[
  {
    "name": "group1",
    "cu": 2,
    "createTime": 0,
    "updateTime": 1710230272,
    "useAsDefault": true
  }
]

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.