AI 助理
备案控制台
文档
输入文档关键字查找
首页 移动开发平台 mPaaS 小程序 小程序开发 小程序开发服务端接口 接口说明

接口说明

更新时间：
产品详情
我的收藏

获取上传文件 token

请求 - GetMcubeFileTokenRequest

参数名称

类型

说明

appId

String

所属的 App。

workspaceId

String

所属的 workspace。

tenantId

String

所属的租户。

onexFlag

Boolean

固定传值为 true。

返回值 - GetMcubeFileTokenResponse

{
    "getFileTokenResult":{
        "fileToken":{
            "accessid":"LTAI7z7XPfKU****",
            "dir":"mds/tempFileForOnex/ONEXE9B092D/test/PUQYHL/8b574cb7-3596-403f-a0e9-208660fc2081/",
            "expire":"1584327372",
            "host":"https://mcube-test.oss-cn-hangzhou.aliyuncs.com",
            "policy":"QwM2YtYTBlOS0yMDg2NjBmYzIwODEvIl1dfQ==",
            "signature":"kisfP5YhbPtmES8+w="
        },
        "resultMsg":"",
        "success":true
    },
    "requestId":"8BAA3288-662E-422C-9960-2EEBFC08369F",
    "resultCode":"OK"
}

返回值说明

返回值名称

类型

说明

requestId

String

标识请求的 ID。

resultCode

String

正常情况下，请求返回的 code 是 OK。若有其他情况，则表明 API 请求异常。

getFileTokenResult

Object

返回的具体对象，具体含义见下表。

在返回的对象中，包含的字段含义如下：

名称

类型

说明

resultMsg

String

查询失败后的返回值。

success

Boolean

查询是否成功。

查询虚拟域名

请求 - QueryMcubeVhostRequest

参数名称

类型

说明

appId

String

所属的 App。

workspaceId

String

所属的 workspace。

tenantId

String

所属的租户。

返回值 - QueryMcubeVhostResponse

{
    "queryVhostResult":{
        "data":"test.com",
        "resultMsg":"",
        "success":true
    },
    "requestId":"637D5BE0-0111-4C53-BCEE-473CFFA0DBAD",
    "resultCode":"OK"
}

返回值说明

返回值名称

类型

说明

requestId

String

标识请求的 ID。

resultCode

String

正常情况下，请求返回的 code 是 OK。若有其他情况，则表明 API 请求异常。

queryVhostResult

Object

返回的具体对象，具体含义见下表。

在返回的对象中，包含的字段含义如下：

名称

类型

说明

data

String

查询到的虚拟域名信息。

resultMsg

String

查询失败后的返回值。

success

Boolean

查询是否成功。

创建虚拟域名

请求 - CreateMcubeVhostRequest

名称

类型

说明

appId

String

所属的 App。

workspaceId

String

所属的 workspace。

tenantId

String

所属的租户。

vhost

String

虚拟域名的值。

返回值 - CreateMcubeVhostResponse

{
    "createVhostResult":{
        "data":"success",
        "resultMsg":"",
        "success":true
    },
    "requestId":"F9C681F2-6377-488D-865B-1144E0CE69D2",
    "resultCode":"OK"
}

返回值说明

返回值名称

类型

说明

requestId

String

标识请求的 ID。

resultCode

String

正常情况下，请求返回的 code 是 OK。若有其他情况，则表明 API 请求异常。

createVhostResult

Object

返回的具体对象，具体含义见下表。

在返回的对象中，包含的字段含义如下：

名称

类型

说明

resultMsg

String

查询失败后的返回值。

success

Boolean

查询是否成功。

查询密钥文件是否存在

请求 - ExistMcubeRsaKeyRequest

参数名称

类型

说明

appId

String

所属的 App。

workspaceId

String

所属的 workspace。

tenantId

String

所属的租户。

返回值 - ExistMcubeRsaKeyResponse

{
    "checkRsaKeyResult":{
        "data":"fail",
        "resultMsg":"",
        "success":false
    },
    "requestId":"8F76783A-8070-4182-895D-14E5D66F8BA3",
    "resultCode":"OK"
}

返回值说明

返回值名称

类型

说明

requestId

String

标识请求的 ID。

resultCode

String

正常情况下，请求返回的 code 是 OK。若有其他情况，则表明 API 请求异常。

checkRsaKeyResult

Object

返回的具体对象，具体含义见下表。

在返回的对象中，包含的字段含义如下：

名称

类型

说明

data

String

查询密钥是否存在返回结果。fail 表示密钥不存在，success 表示密钥存在。

resultMsg

String

查询失败后的返回值。

success

Boolean

查询是否成功。

上传密钥文件

请求 - UploadMcubeRsaKeyRequest

名称

类型

说明

appId

String

所属的 App。

workspaceId

String

所属的 workspace。

tenantId

String

所属的租户。

onexFlag

Boolean

固定传值为 true。

fileUrl

String

密钥文件在 OSS 中的存储地址。

返回值 - UploadMcubeRsaKeyResponse

{
    "requestId":"519E35CF-CC60-4890-8C8E-89A98CEA6BB0",
    "resultCode":"OK",
    "uploadRsaResult":{
        "data":"处理成功",
        "resultMsg":"",
        "success":true
    }
}

返回值说明

返回值名称

类型

说明

requestId

String

标识请求的 ID。

resultCode

String

正常情况下，请求返回的 code 是 OK。若有其他情况，则表明 API 请求异常。

uploadRsaResult

Object

返回的具体对象，具体含义见下表。

在返回的对象中，包含的字段含义如下：

名称

类型

说明

resultMsg

String

查询失败后的返回值。

success

Boolean

查询是否成功。

获取小程序列表

请求 - ListMcubeMiniAppsRequest

参数名称

类型

说明

appId

String

所属的 App。

workspaceId

String

所属的 workspace。

tenantId

String

所属的租户。

返回值 - ListMcubeMiniAppsResponse

{
    "listMiniResult":{
        "miniProgramList":[
            {
                "appCode":"ONEXE9B092D052019-test",
                "gmtCreate":"2019-12-05T21:30:23+08:00",
                "gmtModified":"2019-12-05T21:30:23+08:00",
                "h5Id":"1111111111111111",
                "h5Name":"111111111111111111"
            },
            {
                "appCode":"ONEXE9B092D052019-test",
                "gmtCreate":"2020-03-13T20:04:53+08:00",
                "gmtModified":"2020-03-13T20:04:53+08:00",
                "h5Id":"2222222222222222",
                "h5Name":"test1"
            }
        ],
        "resultMsg":"",
        "success":true
    },
    "requestId":"BE9BF836-72E5-4ACE-A48D-389BA27F8D95",
    "resultCode":"OK"
}

返回值说明

返回值名称

类型

说明

requestId

String

标识请求的 ID。

resultCode

String

正常情况下，请求返回的 code 是 OK。若有其他情况，则表明 API 请求异常。

listMiniResult

Object

返回的具体对象，具体含义见下表。

在返回的对象中，包含的字段含义如下：

名称

类型

说明

appCode

String

appId+”-“+workspaceId

gmtCreate

Date

创建时间。

gmtModified

Date

更新时间。

h5Id

String

小程序 App 的 ID。

h5Name

String

小程序 App 的名称。

resultMsg

String

查询失败后的返回值。

success

Boolean

查询是否成功。

创建小程序

请求 - CreateMcubeMiniAppRequest

名称

类型

说明

appId

String

所属的 App。

workspaceId

String

所属的 workspace。

tenantId

String

所属的租户。

h5Id

String

H5App 的 ID，是一个 16 位数字。

h5Name

String

H5App 的名称。

返回值 - CreateMcubeMiniAppResponse

{
    "createMiniResult":{
        "data":"处理成功",
        "resultMsg":"",
        "success":true
    },
    "requestId":"8A593C1D-9688-4409-BB01-8DB8AD897DD4",
    "resultCode":"OK"
}

返回值说明

返回值名称

类型

说明

requestId

String

标识请求的 ID。

resultCode

String

正常情况下，请求返回的 code 是 OK。若有其他情况，则表明 API 请求异常。

createMiniResult

Object

返回的具体对象，具体含义见下表。

在返回的对象中，包含的字段含义如下：

名称

类型

说明

resultMsg

String

查询失败后的返回值。

success

Boolean

查询是否成功。

删除小程序

请求 - DeleteMcubeMiniAppRequest

名称

类型

说明

appId

String

所属的 App。

workspaceId

String

所属的 workspace。

tenantId

String

所属的租户。

h5Id

String

小程序 App 的 ID。

返回值 - DeleteMcubeMiniAppResponse

{
    "deleteMiniResult":{
        "data":"处理成功",
        "resultMsg":"",
        "success":true
    },
    "requestId":"3DA95CA4-2579-4A2E-9A44-0A4215AEE431",
    "resultCode":"OK"
}

返回值说明

返回值名称

类型

说明

requestId

String

标识请求的 ID。

resultCode

String

正常情况下，请求返回的 code 是 OK。若有其他情况，则表明 API 请求异常。

deleteMiniResult

Object

返回的具体对象，具体含义见下表。

在返回的对象中，包含的字段含义如下：

名称

类型

说明

resultMsg

String

查询失败后的返回值。

success

Boolean

查询是否成功。

上传小程序资源包

请求 - UploadMcubeMiniPackageRequest

名称

类型

是否必传

说明

appId

String

-

所属的 App。

workspaceId

String

-

所属的 workspace。

tenantId

String

-

所属的租户。

h5Id

String

是

小程序 App 的 ID。

h5Name

String

是

小程序 App 的名称。

h5Version

String

是

小程序包的版本。需要保证在单个的小程序 App 中是唯一的。

mainUrl

String

否

小程序包主入口。

vhost

String

是

小程序 App 的虚拟域名，格式为小程序 ID+ 之前设置的虚拟域名的值。

extendInfo

String

否

json 格式字符串，扩展字段。

autoInstall

Long

是

下载时机：

  • 0-仅 WIFI（非 WIFI 需用户使用应用时才会下载）

  • 1-所有网络都下载（会对用户流量造成负面影响，非特殊场景禁用）

resourceType

Long

是

资源类型，固定为 4。

installType

Long

是

安装时机：

  • 0-不预加载（只有进入小程序页面时才安装）

  • 1-预加载（小程序下载完成后则自动安装）

platform

String

是

使用平台，分为 all（全平台）、Android 和 iOS。

clientVersionMin

String

是

客户端最低版本。选择了指定的 platform 之后，最低版本必传；使用 aaa;bbb 的格式。其中 ; 前面的 aaa 对应的是 iOS 的版本，后面的 bbb 对应的是 Android 的版本。即便平台只选择了一个，参数值中的分号也不可省略，如只选择 Android，那么值为 ;bbb。

clientVersionMax

String

否

客户端最高版本，可不填。如果 platform 为 all 的话，则此值要成对存在。即 iOS 和 Android 二者或者必须都写，或者都不写。

resourceFileUrl

String

是

小程序资源包地址。参考概述及准备中的上传方法获取文件地址。

iconFileUrl

String

是

小程序的图标 OSS 地址。

enableTabBar

Long

是

是否显示底部导航栏：

  • 0-否

  • 1-是

enableOptionMenu

String

是

显示右上角功能选项：

  • 0-否

  • 1-是

enableKeepAlive

String

是

是否后台保活。

packageType

Long

否

小程序包类型：

  • 1-功能包

  • 2-插件包

  • 3-真机测试包

  • 4-真机预览包

如果不传，默认为 1。目前尚未细分到四种，只有 12、34 两个分类，12 属于正式包，34 属于测试包。

userId

String

否

上传的资源包类型，packageType 不为 1 或者 2 时，需要指定上传的用户 ID 来实现资源包的上传和发布。

uuid

String

否

当 packageType 为 3-真机调试 时，通过指定 uuid 的值，来实现真机调包的发布和远程 debug。

返回值 - UploadMcubeMiniPackageResponse

packageType ≠ 3 或 4

当上传资源包的 packageType 为 3 或 4 以外的值时，上传小程序资源包的 response 形式如下。

{
    "requestId":"768E2C47-130B-4947-A0BD-2DE81C9090BE",
    "resultCode":"OK",
    "uploadMiniPackageResult":{
        "resultMsg":"",
        "returnPackageResult":{
            "packageId":"3209"
        },
        "success":true
    }
}

返回值说明

返回值名称

类型

说明

requestId

String

标识请求的 ID。

resultCode

String

正常情况下，请求返回的 code 是 OK。若有其他情况，则表明 API 请求异常。

uploadMiniPackageResult

Object

返回的具体对象，具体含义见下表。

在返回的对象中，包含的字段含义如下：

名称

类型

说明

resultMsg

String

查询失败后的返回值。

success

Boolean

查询是否成功。

packageId

String

创建的资源包主键 ID。

packageType ＝ 3 或 4

当上传资源包的 packageType 为 3 或者 4 时，会自动创建发布任务，上传小程序资源包的 response 形式如下。

{
    "requestId":"768E2C47-130B-4947-A0BD-2DE81C9090BE",
    "resultCode":"OK",
    "uploadMiniPackageResult":{
        "resultMsg":"",
        "returnPackageResult":{
            "packageId":"3209"，
              "debugUrl": "mpaas://platformapi/startapp?appId=20001101&token=ide_qr&scheme=mpaas%3A%2F%2Fplatformapi%2Fstartapp%3FappId%3D9970212150000000&nbsv%3D1.0.1.7&nbsource%3Ddebug&nbprefer%3DYES&nbsn%3DDEBUG&nbof",
            "userId":"user_id"
        },
        "success":true
    }
}

返回值说明

返回值名称

类型

说明

requestId

String

标识请求的 ID。

resultCode

String

正常情况下，请求返回的 code 是 OK。若有其他情况，则表明 API 请求异常。

uploadMiniPackageResult

Object

返回的具体对象，具体含义见下表。

在返回的对象中，包含的字段含义如下：

名称

类型

说明

resultMsg

String

查询失败后的返回值。

success

Boolean

查询是否成功。

debugUrl

String

扫码的 schema。

userId

String

当前上传的用户 ID。

获取小程序资源包列表

请求 - ListMcubeMiniPackagesRequest

名称

类型

说明

appId

String

所属的 App。

workspaceId

String

所属的 workspace。

tenantId

String

所属的租户。

h5Id

String

小程序 App 的 ID。

packageTypes

String

包类型，多个类型使用逗号（,）分隔。

返回值 - ListMcubeMiniPackagesResponse

{
    "listMiniPackageResult":{
        "miniPackageList":[
            {
                "appCode":"ONEXE9B092D052019-test",
                "autoInstall":0,
                "clientVersionMax":"",
                "clientVersionMin":"1.1;1.1",
                "downloadUrl":"https://mcube-test.oss-cn-hangzhou.aliyuncs.com/ONEXE9B092D052019-test/1111111111111111/1.1.1.1_all/nebula/1111111111111111_1.1.1.1.amr",
                "extendInfo":"",
                "extraData":"{"enableKeepAlive":"1","enableOptionMenu":"1","enableTabBar":"0","iconUrl":"https://mcube-test.oss-cn-hangzhou.aliyuncs.com/ONEXE9B092D052019-test/1111111111111111/1.1.1.1_all/icon/1111111111111111_1.1.1.1_2.jpg","resourceType":"4"}",
                "fallbackBaseUrl":"https://mcube-test.oss-cn-hangzhou.aliyuncs.com/ONEXE9B092D052019-test/1111111111111111/1.1.1.1_all/nebula/fallback/;https://mcube-test.oss-cn-hangzhou.aliyuncs.com/ONEXE9B092D052019-test/1111111111111111/1.1.1.1_all/nebula/fallback/",
                "gmtCreate":"2019-12-05T21:31:03+08:00",
                "gmtModified":"2019-12-17T14:35:50+08:00",
                "h5Id":"1111111111111111",
                "h5Name":"111111111111111111",
                "h5Version":"1.1.1.1",
                "id":3127,
                "installType":0,
                "mainUrl":"",
                "memo":"https://mcube-test.oss-cn-hangzhou.aliyuncs.com/ONEXE9B092D052019-test/1111111111111111/1.1.1.1_all/nebula/nebula_json/h5_json.json",
                "packageType":1,
                "platform":"all",
                "publishPeriod":5,
                "resourceType":4,
                "status":1
            }
        ],
        "resultMsg":"",
        "success":true
    },
    "requestId":"96151643-8F75-49B9-A5AA-6F57C6B647BD",
    "resultCode":"OK"
}

返回值说明

返回值名称

类型

说明

requestId

String

标识请求的 ID。

resultCode

String

正常情况下，请求返回的 code 是 OK。若有其他情况，则表明 API 请求异常。

listMiniPackageResult

Object

返回的具体对象，具体含义见下表。

在返回的对象中，包含的字段含义如下：

名称

类型

说明

resultMsg

String

查询失败后的返回值。

success

Boolean

查询是否成功。

appCode

String

appId+”-“+workspaceId

autoInstall

Integer

下载时机：

  • 0-仅 WIFI（非 WIFI 需用户使用应用时才会下载）

  • 1-所有网络都下载（会对用户流量造成负面影响，非特殊场景禁用）

clientVersionMax

String

客户端最高版本，可不填。如果 platform 为 all 的话，则此值要成对存在。即 iOS 和 Android 二者或者必须都写，或者都不写。

clientVersionMin

String

客户端最低版本。选择了指定的 platform 之后，最低版本必传；使用 aaa;bbb 的格式。其中 ; 前面的 aaa 对应的是 iOS 的版本，后面的 bbb 对应的是 Android 的版本。即便平台只选择了一个，参数值中的分号也不可省略，如只选择 Android，那么值为 ;bbb。

creator

String

创建者，目前没有使用。

debugUrl

String

当前返回中无意义。

downloadUrl

String

下载小程序包 arm 文件地址。

extendInfo

String

上传时传递的扩展信息。

extraData

String

扩展参数，返回上传时设置的几个配置参数，以及图标地址。

fallbackBaseUrl

String

小程序包 fallback 地址，使用分号分隔，分号前是内网地址，分号后是外网地址。

fileSize

String

文件大小。

gmtCreate

Date

创建时间。

gmtModified

Date

更新时间。

h5Id

String

小程序 App 的 ID。

h5Name

String

小程序 App 的名称。

h5Version

String

当前小程序包的版本号。

id

Long

主键。

installType

Integer

安装时机：

  • 0-不预加载（只有进入小程序页面时才安装）

  • 1-预加载（小程序下载完成后则自动安装）

lazyLoad

Integer

启动加载，目前都是 0。

mainUrl

String

小程序包主入口。

md5

String

小程序包文件的 md5。

memo

String

小程序包的 h5.json 文件的下载地址。

metaId

Long

无意义。

modifier

修改者

目前没有使用。

platform

平台

使用平台，分为 all（全平台）、Android 和 iOS。

publishPeriod

Integer

发布状态：

  • 1-内部灰度发布

  • 2-外部灰度发布

  • 3-正式发布

  • 4-回滚发布

  • 5-发布任务结束

releaseVersion

String

发布版本号。

resourceType

Integer

资源类型，固定为 4。

status

Integer

状态。

packageType

Integer

小程序包类型：

  • 1-功能包

  • 2-插件包

  • 3-真机测试包

  • 4-真机预览包

如果不传，默认为 1。目前尚未细分到四种，只有 12、34 两个分类，12 属于正式包，34 属于测试包。

根据 id 获取指定的小程序资源包信息

请求 - QueryMcubeMiniPackageRequest

名称

类型

说明

appId

String

所属的 App。

workspaceId

String

所属的 workspace。

tenantId

String

所属的租户。

id

String

资源包的主键 ID。

返回值 - QueryMcubeMiniPackageResponse

{
    "queryMiniPackageResult":{
        "miniPackageInfo":{
            "appCode":"ONEXE9B092D052019-test",
            "autoInstall":0,
            "clientVersionMax":"10;10",
            "clientVersionMin":"1;1",
            "downloadUrl":"https://mcube-test.oss-cn-hangzhou.aliyuncs.com/ONEXE9B092D052019-test/1111111111111111/1.1.1.2_all/nebula/1111111111111111_1.1.1.2.amr",
            "extendInfo":"{"key":"value"}",
            "extraData":"{"enableKeepAlive":"1","enableOptionMenu":"1","enableTabBar":"1","iconUrl":"https://mcube-test.oss-cn-hangzhou.aliyuncs.com/ONEXE9B092D052019-test/1111111111111111/1.1.1.2_all/icon/1111111111111111_1.1.1.2_2.jpg","resourceType":"4"}",
            "fallbackBaseUrl":"https://mcube-test.oss-cn-hangzhou.aliyuncs.com/ONEXE9B092D052019-test/1111111111111111/1.1.1.2_all/nebula/fallback/;https://mcube-test.oss-cn-hangzhou.aliyuncs.com/ONEXE9B092D052019-test/1111111111111111/1.1.1.2_all/nebula/fallback/",
            "gmtCreate":"2020-03-16T10:55:00+08:00",
            "gmtModified":"2020-03-16T11:22:10+08:00",
            "h5Id":"1111111111111111",
            "h5Name":"111111111111111111",
            "h5Version":"1.1.1.2",
            "id":3209,
            "installType":1,
            "mainUrl":"index",
            "memo":"https://mcube-test.oss-cn-hangzhou.aliyuncs.com/ONEXE9B092D052019-test/1111111111111111/1.1.1.2_all/nebula/nebula_json/h5_json.json",
            "packageType":1,
            "platform":"all",
            "publishPeriod":3,
            "resourceType":4,
            "status":1
        },
        "resultMsg":"",
        "success":true
    },
    "requestId":"1DAFB8E6-F812-48CF-B7F7-1F5FEF57908F",
    "resultCode":"OK"
}

返回值说明

返回值名称

类型

说明

requestId

String

标识请求的 ID。

resultCode

String

正常情况下，请求返回的 code 是 OK。若有其他情况，则表明 API 请求异常。

queryMiniPackageResult

Object

返回的具体对象，具体含义见下表。

在返回的对象中，包含的字段含义如下：

名称

类型

说明

resultMsg

String

查询失败后的返回值。

success

Boolean

查询是否成功。

appCode

String

appId+”-“+workspaceId

autoInstall

Integer

下载时机：

  • 0-仅 WIFI（非 WIFI 需用户使用应用时才会下载）

  • 1-所有网络都下载（会对用户流量造成负面影响，非特殊场景禁用）

clientVersionMax

String

客户端最高版本，可不填。如果 platform 为 all 的话，则此值要成对存在。即 iOS 和 Android 二者或者必须都写，或者都不写。

clientVersionMin

String

客户端最低版本。选择了指定的 platform 之后，最低版本必传；使用 aaa;bbb 的格式。其中 ; 前面的 aaa 对应的是 iOS 的版本，后面的 bbb 对应的是 Android 的版本。即便平台只选择了一个，参数值中的分号也不可省略，如只选择 Android，那么值为 ;bbb。

creator

String

创建者，目前没有使用。

debugUrl

String

当前返回中无意义。

downloadUrl

String

下载小程序包 arm 文件地址。

extendInfo

String

上传时传递的扩展信息。

extraData

String

扩展参数，返回上传时设置的几个配置参数，以及图标地址。

fallbackBaseUrl

String

小程序包 fallback 地址，使用分号分隔，分号前是内网地址，分号后是外网地址。

fileSize

String

文件大小。

gmtCreate

Date

创建时间。

gmtModified

Date

更新时间。

h5Id

String

小程序 App 的 ID。

h5Name

String

小程序 App 的名称。

h5Version

String

当前小程序包的版本号。

id

Long

主键。

installType

Integer

安装时机：

  • 0-不预加载（只有进入小程序页面时才安装）

  • 1-预加载（小程序下载完成后则自动安装）

lazyLoad

Integer

启动加载，目前都是 0。

mainUrl

String

小程序包主入口。

md5

String

小程序包文件的 md5。

memo

String

小程序包的 h5.json 文件的下载地址。

metaId

Long

无意义。

modifier

修改者

目前没有使用。

platform

平台

使用平台，分为 all（全平台）、Android 和 iOS。

publishPeriod

Integer

发布状态：

  • 1-内部灰度发布

  • 2-外部灰度发布

  • 3-正式发布

  • 4-回滚发布

  • 5-发布任务结束

releaseVersion

String

发布版本号。

resourceType

Integer

资源类型，固定为 4。

status

Integer

状态。

packageType

Integer

小程序包类型：

  • 1-功能包

  • 2-插件包

  • 3-真机测试包

  • 4-真机预览包

如果不传，默认为 1。目前尚未细分到四种，只有 12、34 两个分类，12 属于正式包，34 属于测试包。

创建小程序发布任务

请求 - CreateMcubeMiniTaskRequest

名称

类型

是否必填

说明

appId

String

-

所属的 App。

workspaceId

String

-

所属的 workspace。

tenantId

String

-

所属的租户。

publishType

Integer

是

发布类型：

  • 2-灰度发布

  • 3-正式发布

publishMode

Integer

如果 publishType 为3，则填 0

发布模式：

  • 1-白名单

  • 2-时间窗

memo

String

否

发布描述。

id

Long

是

只能传 0，标识是创建，不是修改。

greyEndtimeData

String

否，当 publishMode 为 2 时必填。

灰度时间窗发布的结束时间，格式为 YYYY-MM-dd HH:mm:ss，时间必须大于当前时间并且与当前时间的间隔小于 7 天。

greyNum

Integer

否，当 publishMode 为 2 时必填。

时间窗灰度的人数。

whitelistIds

String

否，当 publishMode 为 1 时必填。

白名单主键 ID，多个使用 , 分隔。

packageId

Long

是

发布的资源包主键 ID。

greyConfigInfo

String

否

发布的高级规则条件，json 字符串，具体含义见下表。

高级规则

高级规则示例：

{"ruleElement":"city","operation":1,"value":"上海市,北京市,天津市"},{"ruleElement":"mobileModel","operation":2,"value":"REDMI NOTE 3,VIVO X5M"},{"ruleElement":"osVersion","operation":3,"value2":"9.2.1","value1":"9.2.1","value":"9.2.1-9.2.1"}

高级规则说明：

名称

类型

说明

ruleElement

String

规则类型：

  • city-城市

  • mobileModel-机型

  • netType-网络

  • osVersion-设备系统版本

value

String

规则值，多个使用”,”分隔，当 operation 为 3 或者 4 时，value 值是 aa-bb 的格式，其中 aa 是较小的值，bb 是较大的值。

operation

Integer

操作关系：

  • 1-包含

  • 2-不包含

  • 3-范围内

  • 4-在范围外

如果 ruleElement 为 city、mobileModel 和 netType 时，operation 只有：

  • 1-包含

  • 2-不包含

当 ruleElement 为 osVersion 时，operation 的值可以是 4 种里面的任意一种。

返回值 - CreateMcubeMiniTaskResponse

{
    "createMiniTaskResult":{
        "miniTaskId":"5244",
        "resultMsg":"",
        "success":true
    },
    "requestId":"53103033-5018-4090-9FAC-1E1B556DA14F",
    "resultCode":"OK"
}

返回值说明

返回值名称

类型

说明

requestId

String

标识请求的 ID。

resultCode

String

正常情况下，请求返回的 code 是 OK。若有其他情况，则表明 API 请求异常。

createMiniTaskResult

Object

返回的具体对象，具体含义见下表。

在返回的对象中，包含的字段含义如下：

名称

类型

说明

resultMsg

String

查询失败后的返回值。

success

Boolean

查询是否成功。

miniTaskId

String

创建的任务 ID。

获取小程序发布任务列表

请求 - ListMcubeMiniTasksRequest

名称

类型

说明

appId

String

所属的 App。

workspaceId

String

所属的 workspace。

tenantId

String

所属的租户。

id

String

任务对应的小程序资源包 ID。

返回值 - ListMcubeMiniTasksResponse

{
    "listMiniTaskResult":{
        "miniTaskList":[
            {
                "appCode":"10EE034211053-default",
                "bizType":"nebula",
                "bundles":[ ],
                "creator":"",
                "gmtCreate":"2019-04-24 17:43:54",
                "gmtModified":"2019-04-24 17:43:54",
                "gmtModifiedStr":"2019-04-24 17:43:54",
                "greyConfigInfo":"{"operator":"and","subRules":[{"operator":"contains","left":["上海市","北京市","天津市"],"right":"city","defaultResult":false},{"operator":"excludes","left":["REDMI NOTE 3","VIVO X5M"],"right":"mobileModel","defaultResult":false},{"operator":"vLimitIn","exclusive":false,"left":{"lower":"9.2.1","upper":"9.2.1"},"right":"osVersion","defaultResult":false}],"defaultResult":false}",
                "greyEndtime":null,
                "greyEndtimeData":"",
                "greyNum":0,
                "id":212,
                "memo":"h5小包发布",
                "modifier":"",
                "packageId":572,
                "percent":0,
                "platform":"iOS",
                "productId":"10EE034211053-default-1234567812345678",
                "productVersion":"1.1.1.4",
                "publishMode":1,
                "publishType":2,
                "releaseVersion":"20190424103618",
                "resIds":"572",
                "status":1,
                "syncResult":"",
                "taskName":"1234",
                "taskStatus":1,
                "taskType":0,
                "taskVersion":1556099034158,
                "upgradeNoticeNum":0,
                "upgradeProgress":"",
                "whitelistIds":"931"
            }
        ],
        "resultMsg":"",
        "success":true
    },
    "requestId":"4A0C156E-0B8F-4007-9B3C-4EE267723361",
    "resultCode":"OK"
}

返回值说明

返回值名称

类型

说明

requestId

String

标识请求的 ID。

resultCode

String

正常情况下，请求返回的 code 是 OK。若有其他情况，则表明 API 请求异常。

listMiniTaskResult

Object

返回的具体对象，具体含义见下表。

在返回的对象中，包含的字段含义如下：

名称

类型

说明

resultMsg

String

查询失败后的返回值。

success

Boolean

查询是否成功。

appCode

String

appId+”-“+workspaceId

bizType

String

小程序包为 nebula。

bundles

Array

目前没有使用。

creator

String

目前没有使用。

gmtCreate

Date

创建时间。

gmtModified

Date

更新时间。

gmtModifiedStr

String

更新时间字符串。

greyConfigInfo

String

高级规则的字符串，和上传时的展示方式不同，具体见 greyConfigInfo 字段内容解释。

greyEndtime

Date

时间窗灰度截止时间。

greyEndtimeData

String

时间窗灰度截止时间字符串。

greyNum

Integer

时间窗灰度人数。

id

Long

当前发布任务主键 ID。

memo

String

发布描述。

modifier

String

更新者，没有使用。

packageId

Long

当前任务对应小程序资源包的 ID。

percent

Integer

灰度百分比，目前都是 0。

platform

String

打当前发布任务的平台：all-双平台、iOS、Android。

productId

String

产品id，appId + workspaceId + h5id

productVersion

String

小程序资源包的版本号。

publishMode

Integer

发布模型：

  • 0-默认值

  • 1-白名单

  • 2-时间窗

publishType

Integer

发布类型：

  • 2-灰度发布

  • 3-正式发布

releaseVersion

String

内部发布版本号

resIds

String

对应的小程序资源包 ID。

status

Integer

状态：

  • 0-无效

  • 1-有效

syncResult

String

目前没有使用。

taskName

String

任务名称，和小程序 App 名称相同。

taskStatus

Integer

任务状态：

  • 0-待发布

  • 1-发布中

  • 2-已结束

  • 3-暂停

taskType

Integer

任务类型：

  • 0-普通任务

  • 1-回滚任务

taskVersion

Long

任务版本号，使用的是任务创建的当前时间。

upgradeNoticeNum

Integer

目前没有使用。

upgradeProgress

String

目前没有使用。

whitelistIds

String

白名单主键 ID，多个使用 , 分隔。

greyConfigInfo 字段内容解释

名称

类型

说明

operator

String

规则关系，and 表示“与”规则，对 subRules 里面的结果进行与操作。

defaultResult

boolean

默认返回的结果。

subRules

List

规则集合。

operator

String

规则名称：

  • contains-包含

  • excludes-不包含

  • vLimitIn-在范围内

  • vLimitOut-在范围外

left

当 operator 为 contains 和 excludes 时，是 List 字符集合，每个元素表示一个规则的值。当 operator 为 vLimitIn 和 vLimitOut 时，是一个对象，其中的 lower 表示较低的值，upper 表示较高的值。

见类型中描述。

right

String

规则类型名称。

defaultResult

Boolean

默认结果。

根据 id 查询指定的发布任务

请求 - QueryMcubeMiniTaskRequest

名称

类型

说明

appId

String

所属的 App。

workspaceId

String

所属的 workspace。

tenantId

String

所属的租户。

taskId

Long

想要查询的任务 ID 主键。

返回值 - QueryMcubeMiniTaskResponse

{
    "queryMiniTaskResult":{
        "miniTaskInfo":{
            "appCode":"ONEXE9B092D052019-test",
            "gmtCreate":"2020-03-16T11:22:10+08:00",
            "gmtModified":"2020-03-16T11:22:10+08:00",
            "greyConfigInfo":"",
            "greyEndtimeData":"",
            "greyNum":0,
            "id":5244,
            "memo":"memo",
            "packageId":3209,
            "platform":"all",
            "productVersion":"1.1.1.2",
            "publishMode":0,
            "publishType":3,
            "status":"1",
            "taskStatus":1,
            "whitelistIds":""
        },
        "resultMsg":"",
        "success":true
    },
    "requestId":"C02CC6F5-9CDB-42C0-8967-9F728A48C7F6",
    "resultCode":"OK"
}

返回值说明

返回结果同 获取小程序发布任务列表 的返回值。

修改任务状态

请求 - ChangeMcubeMiniTaskStatusRequest

名称

类型

说明

appId

String

所属的 App。

workspaceId

String

所属的 workspace。

tenantId

String

所属的租户。

bizType

String

传 nebula。

packageId

Long

任务对应的小程序资源包的 ID。

taskId

Long

当前发布任务的 ID。

taskStatus

Long

需要改变到的状态：

  • 0-待发布

  • 1-发布中

  • 2-已结束

  • 3-暂停

返回值 - ChangeMcubeMiniTaskStatusResponse

{
    "changeMiniTaskStatusResult":{
        "data":"处理成功",
        "resultMsg":"",
        "success":true
    },
    "requestId":"8F2A9BC1-3FDF-4578-A164-B305D6FB59B0",
    "resultCode":"OK"
}

返回值说明

返回值名称

类型

说明

requestId

String

标识请求的 ID。

resultCode

String

正常情况下，请求返回的 code 是 OK。若有其他情况，则表明 API 请求异常。

changeMiniTaskStatusResult

Object

返回的具体对象，具体含义见下表。

在返回的对象中，包含的字段含义如下：

名称

类型

说明

resultMsg

String

查询失败后的返回值。

success

Boolean

查询是否成功。

创建白名单

请求 - CreateMcubeWhitelistRequest

名称

类型

说明

appId

String

所属的 App。

workspaceId

String

所属的 workspace。

tenantId

String

所属的租户。

whiteListName

String

白名单名称，名称在 2-10 个字符之间。

whitelistType

String

白名单类型：

  • normal-普通白名单

  • regular-正则白名单

返回值 - CreateMcubeWhitelistResponse

{
    "createWhitelistResult":{
        "resultMsg":"",
        "success":true,
        "whitelistId":"2733"
    },
    "requestId":"72224B8A-351D-4FFD-8F0E-C1D21F0C22C8",
    "resultCode":"OK"
}

返回值说明

返回值名称

类型

说明

requestId

String

标识请求的 ID。

resultCode

String

正常情况下，请求返回的 code 是 OK。若有其他情况，则表明 API 请求异常。

createWhitelistResult

Object

返回的具体对象，具体含义见下表。

在返回的对象中，包含的字段含义如下：

名称

类型

说明

resultMsg

String

查询失败后的返回值。

success

Boolean

查询是否成功。

whitelistId

String

创建的白名单的 ID。

获取白名单列表

请求 - ListMcubeWhitelistRequest

参数名称

类型

说明

appId

String

所属的 App。

workspaceId

String

所属的 workspace。

tenantId

String

所属的租户。

返回值 - ListMcubeWhitelistResponse

{
    "listWhitelistResult":{
        "resultMsg":"",
        "success":true,
        "whitelists":[
            {
                "appCode":"ONEXE9B092D052019-test",
                "gmtCreate":"2020-03-16T12:38:14+08:00",
                "gmtModified":"2020-03-16T12:38:14+08:00",
                "id":2733,
                "whiteListCount":0,
                "whiteListName":"testWhite",
                "whitelistType":"normal"
            },
            {
                "appCode":"ONEXE9B092D052019-test",
                "gmtCreate":"2019-12-05T21:46:15+08:00",
                "gmtModified":"2019-12-05T21:46:15+08:00",
                "id":2701,
                "whiteListCount":0,
                "whiteListName":"23",
                "whitelistType":"normal"
            }
        ]
    },
    "requestId":"C33D3132-5E33-4744-B146-9BDF36D99A5E",
    "resultCode":"OK"
}

返回值说明

返回值名称

类型

说明

requestId

String

标识请求的 ID。

resultCode

String

正常情况下，请求返回的 code 是 OK。若有其他情况，则表明 API 请求异常。

listWhitelistResult

Object

返回的具体对象，具体含义见下表。

在返回的对象中，包含的字段含义如下：

名称

类型

说明

resultMsg

String

查询失败后的返回值。

success

Boolean

查询是否成功。

appCode

String

appId+”-“+workspaceId

gmtCreate

Date

创建时间。

gmtModified

Date

更新时间。

id

Long

白名单 ID 主键。

whiteListCount

Integer

白名单中 ID 数量。

whiteListName

String

白名单名称。

whitelistType

String

白名单类型：

  • normal-普通白名单

  • regular-正则白名单

增加白名单内容

请求 - UpdateMcubeWhitelistRequest

名称

类型

是否必传

说明

appId

String

-

所属的 App。

workspaceId

String

-

所属的 workspace。

tenantId

String

-

所属的租户。

keyIds

String

否，与 ossUrl 二选一即可

白名单用户，多个 userId 用英文逗号 ,分隔。

ossUrl

String

否，与 keyIds 二选一即可

白名单文件地址，每行一条记录，文件小于 5 M。

onexFlag

Boolean

固定传值为 true

-

id

String

是

白名单 ID。

返回值 - UpdateMcubeWhitelistResponse

{
    "addWhitelistResult":{
        "addWhitelistInfo":{
            "failNum":0,
            "failUserIds":"",
            "successNum":2
        },
        "resultMsg":"",
        "success":true
    },
    "requestId":"A0462D16-824B-40E1-A000-66E0D2376B5B",
    "resultCode":"OK"
}

返回值说明

返回值名称

类型

说明

requestId

String

标识请求的 ID。

resultCode

String

正常情况下，请求返回的 code 是 OK。若有其他情况，则表明 API 请求异常。

addWhitelistResult

Object

返回的具体对象，具体含义见下表。

在返回的对象中，包含的字段含义如下：

名称

类型

说明

resultMsg

String

查询失败后的返回值。

success

Boolean

查询是否成功。

failNum

Integer

添加失败的白名单数量。

failUserIds

String

添加失败的白名单内容。

successNum

Integer

上传成功的白名单数量。

删除白名单

请求 - DeleteMcubeWhitelistRequest

名称

类型

说明

appId

String

所属的 App。

workspaceId

String

所属的 workspace。

tenantId

String

所属的租户。

id

Integer

白名单主键 ID。

返回值 - DeleteMcubeWhitelistResponse

{
    "deleteWhitelistResult":{
        "data":"1",
        "resultMsg":"",
        "success":true
    },
    "requestId":"26B80D2D-D62C-428D-8124-D0DC4968350B",
    "resultCode":"OK"
}

返回值说明

返回值名称

类型

说明

requestId

String

标识请求的 ID。

resultCode

String

正常情况下，请求返回的 code 是 OK。若有其他情况，则表明 API 请求异常。

deleteWhitelistResult

Object

返回的具体对象，具体含义见下表。

在返回的对象中，包含的字段含义如下：

名称

类型

说明

data

String

删除的白名单数量。

resultMsg

String

查询失败后的返回值。

success

Boolean

查询是否成功。

在 IDE 中进行小程序预览和 debug 时使用的白名单创建

请求 - CreateMcubeWhitelistForIdeRequest

名称

类型

说明

appId

String

所属的 App。

workspaceId

String

所属的 workspace。

tenantId

String

所属的租户。

userId

String

需要调用的用户的 ID。

whitelistValue

String

白名单内容。

返回值 - CreateMcubeWhitelistForIdeResponse

{
    "createWhitelistForIdeResult":{
        "resultMsg":"",
        "success":true,
        "whitelistId":"2734"
    },
    "requestId":"E59980F5-3AF1-4972-8830-F0A4848C4CA4",
    "resultCode":"OK"
}

返回值说明

返回值名称

类型

说明

requestId

String

标识请求的 ID。

resultCode

String

正常情况下，请求返回的 code 是 OK。若有其他情况，则表明 API 请求异常。

createWhitelistForIdeResult

Object

返回的具体对象，具体含义见下表。

在返回的对象中，包含的字段含义如下：

名称

类型

说明

resultMsg

String

查询失败后的返回值。

success

Boolean

查询是否成功。

whitelistId

String

创建的白名单的 ID。

上一篇：概述及准备下一篇：小程序基础库说明
文档推荐