返回结果

介绍阿里云RPA接口调用涉及的返回参数。

返回参数

名称

类型

示例值

描述

requestId

String

7906bcd8-5054-4be4-a08f-27e13630607e

请求 ID

success

Boolean

true

请求是否成功

code

Integer

0

状态码

msg

String

调用成功

请求结果信息

msgCode

String

result.success

请求结果信息码

data

List

请求结果详细信息,详见各接口返回参数说明

pager

Object

若无分页返回null,若有分页,返回分页详情

pager 分页数据

名称

类型

描述

currentPage

Integer

当前页码

totalPage

Integer

总页数

pageSize

Integer

每页大小

total

Long

总数据数量

正常返回示例

接口调用成功后会返回接口返回参数和请求 ID,我们称这样的返回为正常返回。HTTP 状态码为 2xx。

{
    "requestId":"7906bcd8-5054-4be4-a08f-27e13630607e",
    "success":true,
    "code":0,
    "msg":"调用成功",
    "msgCode":"result.success",
    "data":[
        # 不同接口返回的数据不同,详见各接口返回参数说明
    ],
    "pager":null
}

异常返回示例

接口调用出错后,会返回错误码、错误信息和请求 ID,我们称这样的返回为异常返回。HTTP 状态码为 4xx 或者 5xx。您可以根据接口错误码,参考公共错误码以及API 错误中心排查错误。

{
    "timestamp":1589095122608,
    "status":403,
    "error":"Forbidden",
    "message":"Forbidden",
    "path":"/rpa/openapi/client/updateClientInfo"
}