FindUserGatewayById-阿里云帮助中心

Retrieves the details of a gateway, including the user who created it and the number of running gateway instances.

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 gateway.	dg-nmz841r7b681****

Response elements

Element	Type	Description	Example
	object
Code	string	The response code.	200
ErrorMsg	string	The error message.	Gateway exception, please launch local dg first
RequestId	string	The request ID, used to locate logs and troubleshoot issues.	41FC4DFE-EA8A-5A56-A16C-F607C3409C79
Success	boolean	Indicates whether the request was successful. Valid values: true: The request succeeded. false: The request failed.	true
Gateway	object	The details of the gateway.
GatewayDesc	string	The description of the gateway.	test
GatewayName	string	The name of the gateway.	test
RegionId	string	The ID of the region.	cn-hangzhou
GatewayId	string	The ID of the gateway.	dg-pv33g51gw69h****
Status	string	The status of the gateway.	RUNNING
UserId	string	The user ID.	100****
CreatorId	string	The user who created the gateway.	test_user
DgVersion	string	The version of DG.	3.0
ExceptionMsg	string	The exception message.	Gateway exception, please launch local dg first
NumOfExceptionInstance	integer	The number of gateway instances that are in an exception state.	3
NumOfRunningInstance	integer	The number of running gateway instances.	3
AccessDeniedDetail	object	Details of the access denial.
AuthAction	string	The API operation that was called.	dms-dg:FindUserGatewayById
AuthPrincipalDisplayName	string	The identity used for authentication in the request.	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 message.	AQEAAAAAaEo6p0VFOTM5RkEwLTRBRUItNTA5NS04Q0JGLTJFRjUxNDJDRjkwQg==
NoPermissionType	string	The reason the authentication failed.	ExplicitDeny
PolicyType	string	The policy type that caused the authentication failure.	COST_OPTIMIZED

Examples

Success response

JSON format

{
  "Code": "200",
  "ErrorMsg": "Gateway exception, please launch local dg first",
  "RequestId": "41FC4DFE-EA8A-5A56-A16C-F607C3409C79",
  "Success": true,
  "Gateway": {
    "GatewayDesc": "test",
    "GatewayName": "test",
    "RegionId": "cn-hangzhou",
    "GatewayId": "dg-pv33g51gw69h****",
    "Status": "RUNNING",
    "UserId": "100****",
    "CreatorId": "test_user",
    "DgVersion": "3.0",
    "ExceptionMsg": "Gateway exception, please launch local dg first",
    "NumOfExceptionInstance": 3,
    "NumOfRunningInstance": 3
  },
  "AccessDeniedDetail": {
    "AuthAction": "dms-dg:FindUserGatewayById",
    "AuthPrincipalDisplayName": "23894333884425****",
    "AuthPrincipalOwnerId": "1218522260143***",
    "AuthPrincipalType": "SubUser",
    "EncodedDiagnosticMessage": "AQEAAAAAaEo6p0VFOTM5RkEwLTRBRUItNTA5NS04Q0JGLTJFRjUxNDJDRjkwQg==",
    "NoPermissionType": "ExplicitDeny",
    "PolicyType": "COST_OPTIMIZED"
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.