AddDatabaseList

Updated at:

Adds multiple databases to a gateway in a batch 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

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request parameters

Parameter

Type

Required

Description

Example

DatabaseString

string

Yes

A JSON string that contains information about the databases to add.

[{"host":"127.0.0.1","port":"3306","gatewayId":"dg-xsdasdasdas****"}]

ClientToken

string

No

A unique, client-generated token that ensures request idempotency. The token is case-sensitive and can be up to 64 ASCII characters long.

ETnLKlblzczshOTUbOCzxxxx

Response elements

Element

Type

Description

Example

object

Code

string

The response code.

200

Data

string

The result of the operation.

SUCCESS

ErrorMsg

string

The error message.

ERROR

RequestId

string

The request ID. You can use this ID to locate logs and troubleshoot issues.

514F794F-7E30-5DAA-97C0-0B0D75DA0259

Success

boolean

Indicates whether the request succeeded. Valid values:

  • true: The request succeeded.

  • false: The request failed.

true

AccessDeniedDetail

object

Details about the request failure.

AuthAction

string

The API name.

dms-dg:AddDatabaseList

AuthPrincipalDisplayName

string

The principal that initiated the request.

23894333884425****

AuthPrincipalOwnerId

string

The ID of the main account that the principal belongs to.

1218522260143***

AuthPrincipalType

string

The type of the principal.

SubUser

EncodedDiagnosticMessage

string

The complete, encoded diagnostic information.

AQFpaFA9aWhQPUVGNTY4MDU3LTE1OEQtMzYwMi05RkM5LUM0MEJGRjA4RkExOQ==

NoPermissionType

string

The reason for the authorization failure.

ExplicitDeny

PolicyType

string

The type of policy that caused the authorization failure.

COST_OPTIMIZED

Examples

Success response

JSON format

{
  "Code": "200",
  "Data": "SUCCESS",
  "ErrorMsg": "ERROR",
  "RequestId": "514F794F-7E30-5DAA-97C0-0B0D75DA0259",
  "Success": true,
  "AccessDeniedDetail": {
    "AuthAction": "dms-dg:AddDatabaseList",
    "AuthPrincipalDisplayName": "23894333884425****",
    "AuthPrincipalOwnerId": "1218522260143***",
    "AuthPrincipalType": "SubUser",
    "EncodedDiagnosticMessage": "AQFpaFA9aWhQPUVGNTY4MDU3LTE1OEQtMzYwMi05RkM5LUM0MEJGRjA4RkExOQ==",
    "NoPermissionType": "ExplicitDeny",
    "PolicyType": "COST_OPTIMIZED"
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.