平台账号管理

客户端3.45.0版本以上支持

1.账号分页列表

  • Path:/api/v1/account/list
  • Method: POST
  • Content-Type:application/json
  • 接口描述:查询平台账号的信息。用户仅能查询自己有权限的平台账号信息。
  • 请求体可以所有字段都为空,但是必须传 {},不能是空请求体。
  • 如果传空字符串,该字段不会进行过滤查询。
  • 需要具备"团队设置-编辑-环境-我的账号-密码查看"权限才能返回账号密码信息,没有此权限则返回null。

请求参数

参数名称类型必传说明
accountNamestring账号
namestring账号名称
currentint当前页,默认值为1
sizeint每页数据,默认值为10

请求示例

{
    "current": 1,
    "size": 10
}

执行成功返回

{
	"code": 0,
	"msg": "Success",
	"requestId": "1c68583789ab472a8fab783e5a5485f1",
	"timestamp": 1756094388606,
	"data": {
		"list": [{
			"accountId": 1,
			"name": "name",
			"accountName": "accountName",
			"accountPassword": "accountPassword",
			"otpSecret": "",
			"siteName": "siteName",
			"siteAlias": null,
			"domainName": null
		}],
		"total": 1
	}
}

2. 账号更新

  • Path:/api/v1/account/update
  • Method:POST
  • Content-Type:application/json
  • 接口描述:修改账号信息
注意:
- accountId 为必传参数。
- accountPassword, name, otpSecret 三个参数中必须至少有一个,可以多个。
- 如果给某个可选参数传递空字符串 (如 "name": ""),则会清空数据库中该字段对应的数据。
- 如果不传递某个可选参数 (例如不传 name 字段),则不对该字段进行任何修改。

请求参数

参数名称类型必传说明
accountIdbigint账号id
accountPasswordstring账号密码,accountPassword, name, otpSecret 三个参数中必须至少有一个,可以多个
namestring账号名称,accountPassword, name, otpSecret 三个参数中必须至少有一个,可以多个
otpSecretstring2FA密钥,accountPassword, name, otpSecret 三个参数中必须至少有一个,可以多个

请求示例:

{
    "accountId": 1,
    "accountPassword": "password",
    "name": "自定义账号名称",
    "otpSecret": "otpSecret"
}

返回示例

{
	"code": 0,
	"msg": "Success",
	"requestId": "10f1569c234847cc82ed91c421a406b5",
	"timestamp": 1756094713083,
	"data": true
}

3. 添加环境账号

  • Path:/api/v1/container/add-account
  • Method:POST
  • Content-Type:application/json
  • 接口描述:为环境添加账号信息
注意:
- 当 siteName 为 "自定义平台" 时,系统会判断此为自定义平台。如果 domainName 相同,则不会新增账号记录。
- 当 siteName 为官方内置平台名称(如“加拿大亚马逊”)时,系统会判断此为内置平台。需要平台名称 (siteName) 和平台账号 (accountName) 都相同,才不会被添加;如果其中任何一个不同,都会添加一条新的账号记录。

请求参数

参数名称类型必传说明
accountNamestring平台账号
accountPasswordstring平台密码
containerCodeint环境编号
domainNamestring自定义平台的域名
namestring自定义账号名称
otpSecretstring2FA密钥
siteAliasstring自定义平台的别名
siteNamestring平台名称

请求示例:

{
    "accountName": "zhanghao",
    "accountPassword": "password",
    "containerCode": 854921712,
    "domainName": "https://www.baidu.com",
    "name": "账号名称",
    "otpSecret": "otpSecret",
    "siteAlias": "自定义平台",
    "siteName": "自定义平台"
}

返回示例

{
	"code": 0,
	"msg": "Success",
	"requestId": "5e4694a6369b46b09c1288c5efd8b905",
	"timestamp": 1756097123655,
	"data": true
}

4. 账号删除

  • Path:/api/v1/account/del
  • Method:POST
  • Content-Type:application/json
  • 接口描述:删除账号信息
    注意:
  • 请求体不能为空,必须包含 accountIds 字段。可以传空数组 {},但不能完全不传请求体。
  • accountIds 数组不能为空,必须包含至少一个账号ID。
  • 可以同时传入多个账号ID进行批量删除。
  • 该操作具有原子性,如果提供的账号ID列表中有一个不存在,则整个删除操作都会失败,不会删除任何账号。

请求参数

参数名称类型必传说明
accountIdsarray 账号ID数组,例:[1111]

请求示例:

{
    "accountIds": [1]
}

返回示例

{
	"code": 0,
	"msg": "Success",
	"requestId": "2c6352d593fb4c8db012a3b79e44be8b",
	"timestamp": 1756094713360,
	"data": true
}
2025-08-25
0 0