DICloak API-环境接口 - DICloak Help Center

一、环境接口详情

GET 获取环境列表

GET /v1/env/{env_id}/open

请求参数

名称	类型	必选	说明
page_no	integer	是	页码，默认1
page_size	integer	是	分页大小，默认10
serial_num	integer	否	序号
name	string	否	名称
group_id	string	否	分组
proxy_host	string	否	代理主机(方式1)
status	string	否	状态（DISABLED停用 ENABLED正常）
platform_user	string	否	平台
remark	string	否	备注
start_create_time	string	否	开始时间
end_create_time	string	否	结束时间
operate_status	string	否	环境打开状态 ENABLED 打开，DISABLED 关闭

响应参数

名称	类型	说明
id	string	环境id，env_id
create_time	string	创建时间
update_time	string	修改时间
serial_num	integer	序号
group_id	string	分组ID
group_name	string	分组名称
name	string	名称
browser	string	浏览器类型 (CHROME:Chrome)
ua_type	string	ua类型
ua	string	User Agent
ua_os	string	User Agent OS WINDOWS/MAC/ANDROID/IOS/LINUX
cookie	string	cookie
other_cookie	string	其它cookie
proxy_way	string	代理方式 (CUSTOM:自定义 SELECT_EXIST:选择已有)
proxy_id	string	代理ID(方式2)
proxy_type	string	代理类型(方式1) (NON_USE:不使用 HTTP HTTPS SSH SOCKS5 IPFLY)
proxy_host	string	代理主机(方式1)
proxy_port	integer(int32)	代理端口(方式1)
proxy_user_name	string	代理账号(方式1)
proxy_passwd	string	代理密码(方式1)
proxy_ip_type	string	IP查询渠道(方式1) (IP2LOCATION)
urls	[string]	url列表
config	string	高级设置JSON
status	string	状态（DISABLED停用 ENABLED正常）
remark	string	备注
last_open_time	string	最近打开时间
operate_status	string	操作状态 DISABLED关闭 ENABLED启用 LOCK锁定
account_list	[object]	账号
font_id	string	字体id
data_config	string	数据配置
browser_config	string	浏览器配置
env_mutil_open_type	string	环境多开: GLOBAL：全局 ALLOW:允许 BAN:禁止
operate_members	[object]	当前环境操作人信息
config_ext_map	object	扩展字段
total	integer(int32)	总条数

响应示例(Python)

{
    "code": 0,
    "msg": "success",
    "data": {
        "list": [
            {
                "id": "1848687666096832515",
                "create_time": "2024-10-22 19:27:41",
                "update_time": "2024-10-23 21:28:15",
                "serial_num": 166,
                "group_id": "1776895967565094913",
                "group_name": null,
                "name": "env——name",
                "browser": "CHROME",
                "ua": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_14_6) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/119.0.6005.0 Safari/537.36",
                "ua_os": "MAC",
                "cookie": "",
                "other_cookie": null,
                "urls": [
                    
                ],
                "status": "ENABLED",
                "remark": null,
                "last_open_time": "2024-10-23 21:26:15",
                "operate_status": "DISABLED",
                "account_list": null,
                "font_id": "",
                "data_config": "{\"type\":25,\"dataType\":\"custom\"}",
                "browser_config": "{\"type\":1,\"browserType\":\"custom\"}",
                "env_mutil_open_type": "GLOBAL",
                "config_ext_map": null
            }
        ],
        "total": 65
    }
}

PATCH 打开环境

PATCH /v1/env/{env_id}/open

请求参数

名称	类型	必选	说明
env_id	string	是	环境ID，对应列表中的id

响应参数

名称	类型	必选	说明
serial_number	integer(int32)	是	环境序号
pid	string	是	环境的进程id
debug_port	integer	是	环境端口

响应示例(Python)

{
    'code': 0,
    'msg': 'success',
    'data': {
        'serial_number': 2,
        'pid': '27028',
        'debug_port': 17539
    }
}

PATCH 关闭环境

PATCH /v1/env/{env_id}/close

请求参数

名称	类型	必选	说明
env_id	string	是	环境ID，对应列表中的id

响应参数

名称	类型	必选	说明
serial_number	integer(int32)	是	环境序号
pid	string	是	环境的进程id
debug_port	integer	是	环境端口

响应示例(Python)

{
    'code': 0,
    'msg': 'success'
}

POST 新增环境

POST /v1/env

请求参数

名称	类型	必选	说明
group_id	string	是	分组ID
name	string	否	名称
browser	string	是	浏览器类型 (CHROME:Chrome)
os	OsVO	是	操作系统
ua_type	string	是	ua类型（查看附录ua类型）
ua	string	是	User Agent
ua_os	string	是	Ua OS WINDOWS/LINUX/MAC/ANDROID/IOS
cookie	string	否	cookie
other_cookie	string	否	其它cookie
proxy_way	string	否	代理方式 (CUSTOM:自定义 SELECT_EXIST:选择已有)
proxy_id	string	否	代理ID(方式2)
proxy_type	string	否	代理类型(方式1) (NON_USE:不使用 HTTP HTTPS SSH SOCKS5 IPFLY)
proxy_host	string	否	代理主机
proxy_port	integer(int32)	否	代理端口
proxy_user_name	string	否	代理账号
proxy_password	string	否	代理密码
proxy_ip_type	string	否	IP查询渠道 (IP2LOCATION)
urls	[string]	否	url列表
config	string	是	高级设置JSON（查看附表:环境高级设置）
remark	string	否	备注
data_config	string	否	数据配置（附录：数据同步）
browser_config	string	否	浏览器配置（附录：浏览器配置）
config_ext_map	object	否	扩展字段
env_mutil_open_type	string	否	环境多开:（ GLOBAL：全局 ALLOW:允许 BAN:禁止）
extensions_type	string	否	扩展配置: （ALLOW:允许 BAN:禁止）
extensions_group_id	string	否	扩展分组id
account_list	[EnvironmentAccount]	否	账号

名称	类型	必选	说明
platform	string	是	平台
url	string	是	url
user_name	string	否	登录账号
passwd	string	否	登录密码
secret	string	否	密钥
remark	string	否	账号备注

{
    "extensions_type": "ALLOW",
    "name": "测试环境",
    "group_id": "1858448274955902978",
    "browser": "CHROME",
    "os": {
        "windows": [
            "windows-all"
        ],
        "mac": [
            
        ],
        "android": [
            
        ],
        "ios": [
            
        ],
        "linux": [
            
        ]
    },
    "ua_type": "[\"all\"]",
    "ua": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/121.0.6166.0 Safari/537.36",
    "proxy_way": "CUSTOM",
    "proxy_type": "NON_USE",
    "proxy_ip_type": "IPAPI",
    "account_list": [
        
    ],
    "urls": [
        
    ],
    "config": "{\"acceptLangType\":\"ip\",\"acceptLangValue\":[\"en-US\",\"en\"],\"langType\":\"acceptLang\",\"langValue\":\"local\",\"timezoneType\":\"ip\",\"timezoneValue\":\"local\",\"geoType\":\"ask\",\"geoSubType\":\"ip\",\"geoValue\":{},\"fontType\":\"custom\",\"fontValue\":[\"Academy Engraved LET\",\"Yrsa SemiBold\",\"Yu Gothic UI\",\"Yu Gothic UI Regular\",\"Z003\"],\"webrtcType\":\"disable\",\"webrtcValue\":\"\",\"canvasType\":\"noise\",\"canvasValue\":\"42541\",\"ratioType\":\"truth\",\"ratioValue\":\"\",\"webGLImageType\":\"noise\",\"webGLImageValue\":\"92132\",\"webGLMetadataType\":\"custom\",\"webglManufacturer\":\"Google Inc. (AMD)\",\"webglRender\":\"ANGLE (AMD, Radeon RX 580 Series Direct3D11 vs_5_0 ps_5_0, D3D11-31.0.14051.5006)\",\"webGPUType\":\"disable\",\"audioContextType\":\"noise\",\"audioContextValue\":91094,\"clientRectsType\":\"noise\",\"clientRectsValue\":3530,\"speechVoicesType\":\"noise\",\"speechVoicesValue\":10408,\"deviceMemoryValue\":\"8\",\"trackType\":\"0\",\"batteryType\":\"noise\",\"batteryValue\":62582,\"portType\":\"1\",\"portValue\":\"\",\"accelerateType\":\"0\",\"hardwareConcurrencyValue\":\"12\",\"ratioWidth\":\"\"}",
    "data_type": "global",
    "browser_type": "global",
    "env_mutil_open_type": "GLOBAL",
    "ua_os": "WINDOWS",
    "extensions_group_id": "1858448274955902979",
    "data_config": "{\"type\":0,\"dataType\":\"global\"}",
    "browser_config": "{\"type\":0,\"browserType\":\"global\"}"
}

响应参数（Python)

名称	类型	说明
id	string	环境唯一id
serial_number	integer	环境序号
其它同请求参数	string	环境详情（参考请求参数定义）

{
    "code": 0,
    "msg": "成功",
    "data": {
        "id": "1864934151789899778",
        "serial_num": 1,
        "extensions_type": "ALLOW",
        "name": "测试环境",
        "group_id": "1858448274955902978",
        "browser": "CHROME",
        "os": {
            "windows": [
                "windows-all"
            ],
            "mac": [
                
            ],
            "android": [
                
            ],
            "ios": [
                
            ],
            "linux": [
                
            ]
        },
        "ua_type": "[\"all\"]",
        "ua": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/121.0.6166.0 Safari/537.36",
        "proxy_way": "CUSTOM",
        "proxy_type": "NON_USE",
        "proxy_ip_type": "IPAPI",
        "account_list": [
            
        ],
        "urls": [
            
        ],
        "config": "{\"acceptLangType\":\"ip\",\"acceptLangValue\":[\"en-US\",\"en\"],\"langType\":\"acceptLang\",\"langValue\":\"local\",\"timezoneType\":\"ip\",\"timezoneValue\":\"local\",\"geoType\":\"ask\",\"geoSubType\":\"ip\",\"geoValue\":{},\"fontType\":\"custom\",\"fontValue\":[\"Academy Engraved LET\",\"Yrsa SemiBold\",\"Yu Gothic UI\",\"Yu Gothic UI Regular\",\"Z003\"],\"webrtcType\":\"disable\",\"webrtcValue\":\"\",\"canvasType\":\"noise\",\"canvasValue\":\"42541\",\"ratioType\":\"truth\",\"ratioValue\":\"\",\"webGLImageType\":\"noise\",\"webGLImageValue\":\"92132\",\"webGLMetadataType\":\"custom\",\"webglManufacturer\":\"Google Inc. (AMD)\",\"webglRender\":\"ANGLE (AMD, Radeon RX 580 Series Direct3D11 vs_5_0 ps_5_0, D3D11-31.0.14051.5006)\",\"webGPUType\":\"disable\",\"audioContextType\":\"noise\",\"audioContextValue\":91094,\"clientRectsType\":\"noise\",\"clientRectsValue\":3530,\"speechVoicesType\":\"noise\",\"speechVoicesValue\":10408,\"deviceMemoryValue\":\"8\",\"trackType\":\"0\",\"batteryType\":\"noise\",\"batteryValue\":62582,\"portType\":\"1\",\"portValue\":\"\",\"accelerateType\":\"0\",\"hardwareConcurrencyValue\":\"12\",\"ratioWidth\":\"\"}",
        "data_type": "global",
        "browser_type": "global",
        "env_mutil_open_type": "GLOBAL",
        "ua_os": "WINDOWS",
        "extensions_group_id": "1858448274955902979",
        "data_config": "{\"type\":0,\"dataType\":\"global\"}",
        "browser_config": "{\"type\":0,\"browserType\":\"global\"}"
    },
    "next": null
}

PUT 编辑环境

PUT /v1/env/{env_id}

请求参数

名称	类型	必选	说明
env_id	string	是	环境唯一id
其它请求参数	string	是	参考新增环境请求参数定义，如字段未传则会忽略更新

响应参数（Python)

{
    'code': 0,
    'msg': 'success'
}

DELETE 删除环境

DELETE /v1/env/{env_id}

请求参数

名称	类型	必选	说明
env_id	string	是	环境唯一id

响应参数(Python)

{
    'code': 0,
    'msg': 'success'
}

DELETE 彻底删除环境

DELETE /v1/env/{env_id}/thorough

请求参数

名称	类型	必选	说明
env_id	string	是	环境唯一id

响应参数（Python)

{
    'code': 0,
    'msg': 'success'
}

DICloak帮助中心