DocsICP FilingConsole
Documentation

CreateGatewayVerifyCode

Updated at:
Copy as MD
Product
My Favorites

Generates a verification code to link an on-premises Database Gateway installation to its corresponding gateway in the cloud.

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 gateway ID.

dg-8e0j08630s08****

Response elements

Element

Type

Description

Example

object

Code

string

The response code.

200
Data

string

The generated verification code.

0N3ufVIG43RRAs7diEoep6WHVOHPKj3a
ErrorMsg

string

The error message.

Gateway exception, please launch local dg first
RequestId

string

The request ID. Use this ID to locate logs and troubleshoot issues.

C9ADD2AA-27E3-5D62-A676-092EDC5303C1
Success

boolean

Indicates whether the request was successful. Valid values:

  • true: The request was successful.

  • false: The request failed.

true
AccessDeniedDetail

object

Access denial details.

AuthAction

string

The API name.

dms-dg:CreateGatewayVerifyCode
AuthPrincipalDisplayName

string

The display name of the authenticating principal.

23894333884425****
AuthPrincipalOwnerId

string

The ID of the principal owner.

1218522260143***
AuthPrincipalType

string

The principal type.

SubUser
EncodedDiagnosticMessage

string

The encoded diagnostic message.

AQFpaFA9aWhQPUVGNTY4MDU3LTE1OEQtMzYwMi05RkM5LUM0MEJGRjA4RkExOQ==
NoPermissionType

string

The reason for the authorization failure.

ExplicitDeny
PolicyType

string

The policy type that caused the authorization failure.

COST_OPTIMIZED

Examples

Success response

JSON format

{
  "Code": "200",
  "Data": "0N3ufVIG43RRAs7diEoep6WHVOHPKj3a",
  "ErrorMsg": "Gateway exception, please launch local dg first",
  "RequestId": "C9ADD2AA-27E3-5D62-A676-092EDC5303C1",
  "Success": true,
  "AccessDeniedDetail": {
    "AuthAction": "dms-dg:CreateGatewayVerifyCode",
    "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.