All Products
Search
Document Center

AnalyticDB:AllocateClusterPublicConnection

Last Updated:Aug 30, 2024

Applies for a public endpoint for an AnalyticDB for MySQL cluster.

Operation description

For information about the endpoints of AnalyticDB for MySQL, see Endpoints .

Debugging

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

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
adb:AllocateClusterPublicConnectionupdate
  • DBClusterLakeVersion
    acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
DBClusterIdstringYes

The ID of the AnalyticDB for MySQL Data Lakehouse Edition (V3.0) cluster.

amv-bp1z5d2q71is2****
ConnectionStringPrefixstringYes

The prefix of the public endpoint.

  • The prefix can contain lowercase letters, digits, and hyphens (-). It must start with a lowercase letter.
  • The prefix can be up to 30 characters in length.
test12
EnginestringNo

The database engine of the cluster. Valid values:

  • AnalyticDB (default): the AnalyticDB for MySQL engine.
  • Clickhouse: the wide table engine.
Clickhouse

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The request ID.

868EF07F-D0B2-5043-B092-0C14CD00B65A

Examples

Sample success responses

JSONformat

{
  "RequestId": "868EF07F-D0B2-5043-B092-0C14CD00B65A"
}

Error codes

HTTP status codeError codeError messageDescription
400InvalidConnectionStringPrefix.MalformedThe specified connection string is invalid.The specified connection string is invalid.
400InvalidDBClusterId.NotFoundThe DBClusterId provided does not exist in our records.The specified DBClusterId parameter does not exist. Make sure that the DBClusterId value is valid.
400InvalidDBClusterId.MalformedThe specified parameter DBClusterId is not valid.The DBClusterId parameter is invalid. Check the parameter.
400ACS.InvalidParameter.%sParameter %s is invalid.The specified parameter is invalid.

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

Change history

Change timeSummary of changesOperation
2024-06-13The Error code has changed. The request parameters of the API has changedView Change Details
2023-03-31API Description Update. The Error code has changedView Change Details