requesttask my.request(object object)

基础库  或更高版本； 且 支付宝客户端 10.1.32 或更高版本； 若版本较低，建议采取 兼容处理 。

支小宝客户端 支持

安诊儿客户端 支持

以 promise 风格调用： 支持 。

主体： 企业支付宝小程序 、 个人支付宝小程序

相关文档： 网络 api 使用须知 、 常见问题

使用 my.request、my.uploadfile 前，需要先配置 服务器域名白名单。

• 自研小程序： 登录 > 进入 小程序详情页面 > 开发 > 开发设置 > 服务器域名白名单。
• 第三方应用： 登录 > 进入 第三方应用详情页面 > 开发设置 > 服务器域名白名单。

在小程序开发过程中，可在小程序开发者工具（ide）配置忽略域名合法性检查，如果选择忽略，则在开发者工具中不会校验域名合法性。

• 小程序开发者工具： 右上角点击 详情 > 域名信息 > 忽略 http 请求域名合法性检查。

注意：

• 在开发者工具中配置的忽略域名合法性检查，仅对开发阶段生效，若小程序上线，请务必先在开放平台上配置 服务器域名白名单。
• 在控制台中修改关于 服务器域名白名单 的配置后，只对之后构建和发布的小程序版本生效，已上线的版本使用的是修改前的域名配置。

object object

查看示例

url 参数说明

• 只支持 https 协议的请求
• 只支持与 域名白名单 中的域名通讯
• 开发过程中，可通过开发者工具 详情 > 域名信息 > 忽略 http 请求域名合法性检查 忽略该限制
• 正式/体验版本必须在 小程序详情页面 > 开发 > 开发设置 > 服务器域名白名单 中配置，并重新构建/发布小程序

data 参数说明

传给服务器的数据最终会是 string 类型，如果 data 不是 string 类型，会被转换成 string 。转换规则如下:

• 若方法为 get ，会将 data 转换成 querystring 形式： encodeuricomponent(k)=encodeuricomponent(v)&encodeuricomponent(k)=encodeuricomponent(v)...，追加在 url 后面。
• 若方法为 post 且 headers['content-type'] 为 application/json ，会对数据进行 json 序列化。
• 若方法为 post 且 headers['content-type'] 为 application/x-www-form-urlencoded ，会将 data 转换成 querystring 形式： encodeuricomponent(k)=encodeuricomponent(v)&encodeuricomponent(k)=encodeuricomponent(v)...，追加在 url 后面。

headers 参数说明

• "content-type" 字段默认为 application/json
• referer 可以通过 referrerstyle 参数进行格式控制
• cookie 字段必须结合 enablecookie: true 才能生效

referrerstyle 参数说明

• 该参数只在客户端 10.3.50 及以上版本支持，低于 10.3.50 的客户端相当于 referrerstyle 恒为 'full'，referer 为当前页面的完整 url（含 hash），某些情况下可能导致 header 超长请求失败。
• 在 app.json 中设置behavior.requestreferrerstyle 字段可以改变 referrerstyle 参数的默认值。示例如下。注意：behavior.requestreferrerstyle 兼容性同 referrerstyle 参数的兼容性。

{
  "pages": ["pages/index/index", "pages/logs/logs"],
  "window": {
    "defaulttitle": "demo"
  },
  "behavior": {
    "requestreferrerstyle": "full" // 修改 my.request 参数 referrerstyle 的默认值为 full
  }
}

success 回调函数

参数

object res

查看示例

fail 回调函数

参数

object err

查看示例

requesttask

请求任务对象。可用于获取 http 响应头，以及取消请求任务

fail 回调的参数为 object，error 属性为错误码，errormessage 属性为错误消息。

my.request({
  url: 'https://httpbin.org/post',
  method: 'post',
  data: {
    from: '支付宝',
    production: 'alipayjsapi',
  },
  headers: {
    'content-type': 'application/json', //默认值
  },
  datatype: 'json',
  success: function (res) {
    my.alert({ content: 'success' });
  },
  fail: function (error) {
    console.error('fail: ', json.stringify(error));
  },
  complete: function (res) {
    my.hideloading();
    my.alert({ content: 'complete' });
  },
});

my.request({
  url: 'https://gw.alipayobjects.com/mdn/miniapp_de/afts/img/a*g1kwsjbe2zeaaaaaaaaaaabjarqnaq',
  method: 'get',
  datatype: 'base64',
  success: resp => {
    console.log('resp data length', resp.data.length);
    console.log('resp data', resp.data); // 返回格式类似于：data:image/png;base64,ivborw0kg...
  },
  fail: err => {
    console.log('error', err);
  },
});

my.request({
  url: 'https://httpbin.org/put',
  method: 'put',
  data: {
    from: '支付宝',
    production: 'alipayjsapi',
  },
  headers: {
    'content-type': 'application/json', //默认值
  },
  datatype: 'json',
  success: function (res) {
    my.alert({ content: 'success' });
  },
  fail: function (error) {
    console.error('fail: ', json.stringify(error));
  },
  complete: function (res) {
    my.hideloading();
    my.alert({ content: 'complete' });
  },
});

my.request({
  url: 'https://httpbin.org/delete',
  method: 'delete',
  data: {
    from: '支付宝',
    production: 'alipayjsapi',
  },
  headers: {
    'content-type': 'application/x-www-form-urlencoded',
  },
  datatype: 'json',
  success: function (res) {
    console.log('正常请求'  json.stringify(res));
    my.alert({
      content: '正常请求'  json.stringify(res),
    });
  },
  fail: function (error) {
    console.error('fail: ', json.stringify(error));
  },
  complete: function (res) {},
});

{
  "data": {},
  "status": 200,
  "headers": {
    "server": "tengine",
    "date": "fri, 23 sep 2022 08:33:43 gmt",
    "content-type": "application/json; charset=utf-8",
    "content-length": "725",
    "connection": "keep-alive",
    "keep-alive": "timeout=5",
    "x-server-id": "49-5352",
    "request-id": "0bff86ca16639220231708789893",
    "x-officeingress-sign": "927c5956339dafa23904a10bfc8589cf33251eaebe5b052c7ee623eee9f43e9b47cc69def3b68e1e840f452f17026ca642dd1b9c9ff4a586ee27d6c3e173a3e039884cf89d3038d1",
    "vary": "accept-encoding",
    "x-rc-zone": "gz00d-gz00g",
    "x-content-version": "tue, 23 aug 2022 11:36:07 gmt",
    "x-render-pack-md5": "20d9993e41ed62ffcd41aa3869fe148c",
    "x-render-pack-pro-mode": "1",
    "access-control-allow-origin": "*",
    "cache-control": "max-age=0, s-maxage=120, must-revalidate",
    "x-render-date": "fri, 23 sep 2022 08:33:43 gmt",
    "etag": "w/\"2e2-qvaq0jsjuxu/qqwpmvtms/etwtm\"",
    "x-frame-options": "sameorigin",
    "x-xss-protection": "1; mode=block",
    "x-content-type-options": "nosniff",
    "x-download-options": "noopen"
  }
}

{
  "error": 4,
  "errormessage": "未配置域名白名单，无权访问域名。查看如何配置：https://opendocs.alipay.com/mini/api/owycmh#错误码"
}
// 当错误码为 14 或 19 时，会多返回 status、data、headers。可通过这些字段获取服务端相关错误信息。
{
  "status": 405,
  "headers": {
      "server": "openresty/1.11.2.5",
      "x-powered-by": "php/5.6.32",
      "content-type": "text/html; charset=utf-8",
      "access-control-allow-methods": "post, get, options",
      "access-control-allow-origin": "*",
      "date": "tue, 14 mar 2023 02:01:06 gmt",
      "access-control-allow-headers": "content-type",
      "connection": "keep-alive"
  },
  "data": "",
  "error": 19,
  "errormessage": "http status error"
}

• tip

  如需在不同环境请求不同的 url，可通过 my.env 的 clientenv （基础库 2.7.24 ）判断当前客户端环境（生产环境/沙箱环境），以及通过 my.getaccountinfosync().miniprogram.envversion 判断小程序自身的版本（开发版/正式版等）。
• bug

  支付宝 10.3.90 以下版本 android 端 my.request 不支持 http 重定向，请求会失败。此问题 10.3.90 已修复
• bug

  支付宝 10.5.10 以下版本，当响应的状态码 >= 400 时，ios 端 fail 回调参数的 data 字段可能为空。此缺陷 10.5.10 已修复。
• bug

  ios 端 10.5.10 以前，即使 url 是 https 协议，可能也会误报 {error: 20, errormessage: '请求 url 不支持 http，请使用 https'}。此缺陷 10.5.10 版本已修复。

q：my.request 是否支持 ip 地址请求？是否支持 ipv6 域名？

q：my.request 支持 promise 风格调用吗？

q：小程序是否支持 cookie？

q：request 请求头过大导致 http 请求返回 400 状态码，如何处理？