DocsICP FilingConsole
Documentation

RetryDatabase

Updated at:
Copy as MD
Product
My Favorites

Call this API operation to reconnect a database gateway to a database.

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
GatewayId

string

Yes

The ID of the database gateway.

dg-nmz841r7b681****
Host

string

Yes

The hostname or IP address of the database.

127.0.XX.XX
Port

integer

Yes

The port number of the database.

3306
DbType

string

No

The type of the database.

MYSQL
DbUserName

string

No

The username used to access the database.

test
DbPassword

string

No

The password used to access the database.

HongRui****
DbDescription

string

No

The description of the database.

test
RegionId

string

Yes

The ID of the region.

cn-hangzhou
DbName

string

No

The name of the database.

test
ClientToken

string

No

A client-generated token to ensure the idempotence of the request. The token must be unique across requests and is case-sensitive. It can contain up to 64 ASCII characters.

XXXXX

Response elements

Element

Type

Description

Example

object

The response.

Code

string

The response code.

200
Data

string

The result of the request.

SUCCESS
ErrorMsg

string

The error message that is returned if the request fails.

Gateway exception, please launch local dg first
RequestId

string

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

19EDB8E2-FCE6-5797-91F4-80F832C90371
Success

boolean

Indicates whether the request was successful. Valid values:

  • true: The request was successful.

  • false: The request failed.

true
AccessDeniedDetail

object

The details of the request failure.

AuthAction

string

The name of the API operation.

dms-dg:RetryDatabase
AuthPrincipalDisplayName

string

The display name of the authorization principal.

23894333884425****

AuthPrincipalOwnerId

string

The ID of the owner of the authorization principal.

1218522260143***
AuthPrincipalType

string

The type of the authorization principal.

SubUser

EncodedDiagnosticMessage

string

The complete, encoded diagnostic information.

AQFpaFA9aWhQPUVGNTY4MDU3LTE1OEQtMzYwMi05RkM5LUM0MEJGRjA4RkExOQ==
NoPermissionType

string

The reason why the authorization failed.

ExplicitDeny

PolicyType

string

The type of the policy that caused the authorization to fail.

COST_OPTIMIZED

Examples

Success response

JSON format

{
  "Code": "200",
  "Data": "SUCCESS",
  "ErrorMsg": "Gateway exception, please launch local dg first",
  "RequestId": "19EDB8E2-FCE6-5797-91F4-80F832C90371",
  "Success": true,
  "AccessDeniedDetail": {
    "AuthAction": "dms-dg:RetryDatabase",
    "AuthPrincipalDisplayName": "23894333884425****\n",
    "AuthPrincipalOwnerId": "1218522260143***",
    "AuthPrincipalType": "SubUser\n",
    "EncodedDiagnosticMessage": "AQFpaFA9aWhQPUVGNTY4MDU3LTE1OEQtMzYwMi05RkM5LUM0MEJGRjA4RkExOQ==",
    "NoPermissionType": "ExplicitDeny\n",
    "PolicyType": "COST_OPTIMIZED\n"
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.