调用GetUserGateways获取网关列表。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String GetUserGateways

系统规定参数。取值:GetUserGateways

PageSize Integer 20

每页记录数,大小不要超过3000。

PageNumber Integer 1

页码,取值:大于0且不超过Integer的最大值。

默认值:1。

SearchKey String test

按照名称或者备注模糊查询。

RegionId String cn-hangzhou

地域ID。

返回数据

名称 类型 示例值 描述
Data String [{\"creatorId\":\"\",\"dgVersion\":\"3\",\"exceptionMsg\":\"\",\"gatewayDesc\":\"test\",\"gatewayId\":\"dg-a55it25s******\",\"gatewayName\":\"shu**test\",\"numOfExceptionInstance\":0,\"numOfRunningInstance\":0,\"regionId\":\"cn-hangzhou\",\"status\":\"STOPPED\",\"userId\":\"140692647******\"}]

网关信息。

RequestId String E68F1794-354B-4F18-AA6D-1F00353E632E

请求ID。

Success Boolean true

请求是否成功,返回值如下:

  • true:请求成功。
  • false:请求失败。
Code String 200

响应码。

ErrorMsg String SYSTEM_ERR

异常信息。

Count Integer 15

总条数。

示例

请求示例

http(s)://dg.cn-hangzhou.aliyuncs.com/?Action=GetUserGateways
&PageSize=20
&PageNumber=1
&SearchKey=test
&RegionId=cn-hangzhou
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<GetUserGatewaysResponse>
    <Data>[{\"creatorId\":\"\",\"dgVersion\":\"3\",\"exceptionMsg\":\"\",\"gatewayDesc\":\"test\",\"gatewayId\":\"dg-a55it25s******\",\"gatewayName\":\"shu**test\",\"numOfExceptionInstance\":0,\"numOfRunningInstance\":0,\"regionId\":\"cn-hangzhou\",\"status\":\"STOPPED\",\"userId\":\"140692647******\"}]</Data>
    <RequestId>E68F1794-354B-4F18-AA6D-1F00353E632E</RequestId>
    <Success>true</Success>
    <Code>200</Code>
    <ErrorMsg>SYSTEM_ERR</ErrorMsg>
    <Count>15</Count>
</GetUserGatewaysResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "Data" : "[{\\\"creatorId\\\":\\\"\\\",\\\"dgVersion\\\":\\\"3\\\",\\\"exceptionMsg\\\":\\\"\\\",\\\"gatewayDesc\\\":\\\"test\\\",\\\"gatewayId\\\":\\\"dg-a55it25s******\\\",\\\"gatewayName\\\":\\\"shu**test\\\",\\\"numOfExceptionInstance\\\":0,\\\"numOfRunningInstance\\\":0,\\\"regionId\\\":\\\"cn-hangzhou\\\",\\\"status\\\":\\\"STOPPED\\\",\\\"userId\\\":\\\"140692647******\\\"}]",
  "RequestId" : "E68F1794-354B-4F18-AA6D-1F00353E632E",
  "Success" : true,
  "Code" : "200",
  "ErrorMsg" : "SYSTEM_ERR",
  "Count" : 15
}

错误码

访问错误中心查看更多错误码。