diff --git a/docs/uniCloud/cf-functions.md b/docs/uniCloud/cf-functions.md index 93a036eb31b56e6e893cf804fb47759c9d66634a..f2b4c673850af4fcee21a9220003fca189d68f6c 100644 --- a/docs/uniCloud/cf-functions.md +++ b/docs/uniCloud/cf-functions.md @@ -289,6 +289,18 @@ errMsg用于存放具体错误信息,包括展示给开发者、终端用户 |uniCloud.init() |获取指定服务空间的uniCloud实例 [详见](uniCloud/concepts/space.md?id=multi-space) | |uniCloud.logger |云函数中打印日志到[uniCloud web控制台](https://unicloud.dcloud.net.cn/)的日志系统(非HBuilderX控制台)[详情](rundebug.md?id=uniCloudlogger) | +## 错误对象@uni-cloud-error + +云函数调用uniCloud接口时(包括请求云函数、云对象、云存储等)可能存在抛出错误的场景,此时会抛出uniCloud标准的错误对象(以下记为uniCloudError),uniCloudError包含以下属性 + +|属性 |类型 |必备 |说明 | +|-- |-- |-- |-- | +|errCode |string |是 |错误码 | +|errMsg |string |是 |错误信息 | +|requestId |string |否 |请求Id,用于排查错误 | +|detail |object |否 |仅云对象用户主动返回错误对应的响应体规范时会有此属性 | + +另外uniCloudError对象上还有code属性和message属性,两者均不推荐使用。 ## 访问数据库 diff --git a/docs/uniCloud/client-sdk.md b/docs/uniCloud/client-sdk.md index dbec4004a6d986f022a78261876909d5b35201d2..cf9639e97becffae65e6ff7e16396d2442985386 100644 --- a/docs/uniCloud/client-sdk.md +++ b/docs/uniCloud/client-sdk.md @@ -371,4 +371,17 @@ uniCloud.offNeedLogin(log) 用法:`uniCloud.config.provider` -访问此属性会返回`tencent`、`aliyun`分别代表腾讯云和阿里云 \ No newline at end of file +访问此属性会返回`tencent`、`aliyun`分别代表腾讯云和阿里云 + +## 错误对象@uni-cloud-error + +客户端请求云端时(包括请求云函数、云对象、clientDB、云存储等)可能存在抛出错误的场景,此时会抛出uniCloud标准的错误对象(以下记为uniCloudError),uniCloudError包含以下属性 + +|属性 |类型 |必备 |说明 | +|-- |-- |-- |-- | +|errCode |string |是 |错误码 | +|errMsg |string |是 |错误信息 | +|requestId |string |是 |请求Id,用于排查错误 | +|detail |object |否 |仅云对象用户主动返回错误对应的响应体规范时会有此属性 | + +另外uniCloudError对象上还有code属性和message属性,两者均不推荐使用。 diff --git a/docs/uniCloud/rundebug.md b/docs/uniCloud/rundebug.md index f75da96c6d788e278550bc49090d02a2cc59a04f..456ed1ca6d41c14aac638dd3f1be3351012d68bd 100644 --- a/docs/uniCloud/rundebug.md +++ b/docs/uniCloud/rundebug.md @@ -261,14 +261,18 @@ const hour = getOffsetDate(8).getHours() "appId": "", // 应用DCloud AppId "locale": "", // 客户端语言 // HBuilderX 3.5.1及更高版本还允许模拟调用来源(context.SOURCE)、客户端ip(context.CLIENTIP)、客户端ua(context.CLIENTUA) - "source": "client", - "clientIP": "127.0.0.1", - "ua": "xx MicroMessenger/xxx" // 注意非本地运行环境下客户端getSystemInfoSync也会获取ua参数并上传给云函数,但是云函数会从http请求头里面获取ua而不是clientInfo里面的ua + "source": "client", // 调用来源,不传时默认为 client + "clientIP": "127.0.0.1", // 客户端ip,不传时默认为 127.0.0.1 + "ua": "xx MicroMessenger/xxx" // 客户端ua,不传时默认为 HBuilderX // ...其他客户端信息 } } ``` +**注意** + +- 非本地运行环境下客户端getSystemInfoSync也会获取ua参数并上传给云函数,但是云函数会从http请求头里面获取ua而不是clientInfo里面的ua + ### 传入uniIdToken@mock-uni-id-token 客户端调用云函数时自动在data内加入了uniIdToken,使用配置参数运行时也一样在参数内传入即可