You can call this operation to obtain the detailed information of a gateway based on the gateway ID.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes FindUserGatewayById

The operation that you want to perform. Set the value to FindUserGatewayById.
GatewayId String Yes dg-yhss6sdlaffaq68

The ID of the gateway.

Response parameters

Parameter Type Example Description
Code String 200

The status code.
Data String {\"gatewayDesc\":\"Alibaba Cloud Database Gateway\",\"gatewayId\":\"dg-c34g913zl54f7h7z\",\"gatewayName\":\"Production environment\",\"gmtCreate\":1563430627000,\"gmtCreateString\":\"2019-07-18 14:17\",\"gmtModified\":1568881049000,\"gmtModifiedString\":\"2019-09-19 16:17\",\"hosts\":\"10.25.37.78\",\"parentId\":\"123123\",\"status\":\"RUNNING\",\"userId\":\"123123\",\"regionId\":\"cn-hangzhou\"}

The detailed information of the gateway.
ErrorMsg String ""

The error message.
RequestId String 31728E14-8164-49C3-928B-044E93B8A11E

The ID of the request.
Success Boolean true

Indicates whether the call is successful.

Examples

Sample requests


http(s)://dg.[regionId].aliyuncs.com/?Action=FindUserGatewayById
&GatewayId=dg-yhss6sdlaffaq68
&<Common request parameters>

Sample success responses

XML format 

<FindUserGatewayByIdResponse>
      <RequestId>31728E14-8164-49C3-928B-044E93B8A11E</RequestId>
      <ErrorMsg></ErrorMsg>
      <Data>{"gatewayDesc":"Alibaba Cloud Database Gateway","gatewayId":"dg-c34g913zl54f7h7z","gatewayName":"Production environment","gmtCreate":1563430627000,"gmtCreateString":"2019-07-18 14:17","gmtModified":1568881049000,"gmtModifiedString":"2019-09-19 16:17","hosts":"10.25.37.78","parentId":"123123","status":"RUNNING","userId":"123123","regionId":"cn-hangzhou"}</Data>
      <Code>200</Code>
      <Success>true</Success>
</FindUserGatewayByIdResponse>

JSON format 

{
	"Data":"{\"gatewayDesc\":\"Alibaba Cloud Database Gateway\",\"gatewayId\":\"dg-c34g913zl54f7h7z\",\"gatewayName\":\"Production environment\",\"gmtCreate\":1563430627000,\"gmtCreateString\":\"2019-07-18 14:17\",\"gmtModified\":1568881049000,\"gmtModifiedString\":\"2019-09-19 16:17\",\"hosts\":\"10.25.37.78\",\"parentId\":\"123123\",\"status\":\"RUNNING\",\"userId\":\"123123\",\"regionId\":\"cn-hangzhou\"}",
	"RequestId":"31728E14-8164-49C3-928B-044E93B8A11E",
	"ErrorMsg":"",
	"Success":true,
	"Code":"200"
}

Error codes

For a list of error codes, visit the API Error Center.