适用范围
- 该访问接口用于账户内实例的创建、续费、变更,不包含特定实例的操作。
- 特定实例的操作可由 API 获取独立面板的 URL 地址,从独立页面进行操作。
- 获取到的独立面板的 URL 地址,可用于 iframe 内嵌使用。
通用部分
- 接口统一使用 POST 请求,使用 x-www-form-urlencoded 类型传输字段。
- 每个请求均携带 access_id 与 access_key 参数,即接口编码与接口秘钥。
可从【网站后台->账号设置->访问接口】查看。 - 返回结果,以 JSON 返回:
如果成功,则返回 “data” 字段,包含具体结果,类型以具体请求而定;
如果出错,则返回 “error” 字段,包含具体错误,类型为文本。 - 请求均以 curl 为例说明,替换参数即可直接测试。
请求说明
查询账户下所有实例
请求:
curl --location 'https://www.yingyongdun.com/user/api/instances' \ --header 'Content-Type: application/x-www-form-urlencoded' \ --data-urlencode 'access_id=接口编码' \ --data-urlencode 'access_key=接口秘钥'
返回:
{ "data": [ { "id": 100002, /* 编码 */ "label": "防护实例", /* 名称 */ "is_disabled": false, /* 是否被禁用 */ "is_paused": false, /* 是否被暂停(包括到期或手动暂停) */ "client": 200, /* 客户端同时在线数配额 */ "bandwidth": 20, /* 带宽配额 */ "target": 5, /* 源机数配额 */ "tip": "", /* 系统提示(通常包含管理员留言) */ "create_time": 1692515895, /* 创建时间(时间戳) */ "external": { /* 独立面板信息,未创建为 null */ "is_opened": true, /* - 是否启用面板 */ "uuid": "fac199ca", /* - 独立面板编码 */ "url": "https://..../i/fac199ca/" /* - 独立面板访问网址 */ }, "plan": { /* 套餐, 调试实例为 null */ "plan_id": 2002, /* - 套餐编码 */ "remain": 32789404, /* - 剩余时间(单位:秒) */ "expire_time": 1760944778 /* - 到期日期(时间戳) */ } }, ... /* 注意是数组包含多条记录 */ ] }
根据ID查询指定实例
请求:
curl --location 'https://www.yingyongdun.com/user/api/instance' \ --header 'Content-Type: application/x-www-form-urlencoded' \ --data-urlencode 'access_id=接口编码' \ --data-urlencode 'access_key=接口秘钥' \ --data-urlencode 'instance_id=实例编码'
返回:
{ "data": { "id": 100002, /* 编码 */ "label": "防护实例", /* 名称 */ "is_disabled": false, /* 是否被禁用 */ "is_paused": false, /* 是否被暂停(包括到期或手动暂停) */ "client": 200, /* 客户端同时在线数配额 */ "bandwidth": 20, /* 带宽配额 */ "target": 5, /* 源机数配额 */ "tip": "", /* 系统提示(通常包含管理员留言) */ "create_time": 1692515895, /* 创建时间(时间戳) */ "external": { /* 独立面板信息,未创建为 null */ "is_opened": true, /* - 是否启用面板 */ "uuid": "fac199ca", /* - 独立面板编码 */ "url": "https://..../i/fac199ca/" /* - 独立面板访问网址 */ }, "plan": { /* 套餐, 调试实例为 null */ "plan_id": 2002, /* - 套餐编码 */ "remain": 32789404, /* - 剩余时间(单位:秒) */ "expire_time": 1760944778 /* - 到期日期(时间戳) */ } } }
查询账户资金
请求:
curl --location 'https://www.yingyongdun.com/user/api/fund' \ --header 'Content-Type: application/x-www-form-urlencoded' \ --data-urlencode 'access_id=接口编码' \ --data-urlencode 'access_key=接口秘钥'
返回:
{ "data": { "balance": "192.00", /* 余额 */ "profit": "0" /* 收益(来源于推广活动等) */ } }
获取套餐计划列表
请求:
curl --location 'https://www.yingyongdun.com/user/api/plans' \ --header 'Content-Type: application/x-www-form-urlencoded' \ --data-urlencode 'access_id=接口编码' \ --data-urlencode 'access_key=接口秘钥'
返回:
{ "data": [ { "id": 2002, /* 编码 */ "group": "个人", /* 分组 */ "label": "特惠版", /* 名称 */ "client": 200, /* 客户端同时在线数配额 */ "target": 5, /* 源机数配额 */ "price": "399.00" /* 每月价格 */ }, ... /* 注意是数组包含多条记录 */ ] }
计算实例新购价格
请求:
curl --location 'https://www.yingyongdun.com/user/api/instance/plan/create-calc' \ --header 'Content-Type: application/x-www-form-urlencoded' \ --data-urlencode 'access_id=接口编码' \ --data-urlencode 'access_key=接口秘钥' \ --data-urlencode 'plan_id=套餐编码' \ --data-urlencode 'month=月数'
返回:
{ "data": { "price": "399.00", /* 价格 */ "save": "0.00", /* 已减(通常因年付或促销减去的金额) */ "is_disabled": false, /* 是否不能购买(比如旧套餐或业务冲突) */ "tip": "" /* 系统提示(比如无法购买的原因) */ } }
实例新购
请求:
curl --location 'https://www.yingyongdun.com/user/api/instance/plan/create' \ --header 'Content-Type: application/x-www-form-urlencoded' \ --data-urlencode 'access_id=接口编码' \ --data-urlencode 'access_key=接口秘钥' \ --data-urlencode 'plan_id=套餐编码' \ --data-urlencode 'month=月数' \ --data-urlencode 'label=名称'
返回:
{ "data": { "instance_id": 10002 /* 编号 */ } }
计算实例变更价格
请求:
curl --location 'https://www.yingyongdun.com/user/api/instance/plan/modify-calc' \ --header 'Content-Type: application/x-www-form-urlencoded' \ --data-urlencode 'access_id=接口编码' \ --data-urlencode 'access_key=接口秘钥' \ --data-urlencode 'instance_id=实例编码' \ --data-urlencode 'plan_id=需变更到的套餐编码'
返回:
{ "data": { "price": "399.00", /* 补充费用(降级不退费,且需临近到期才可操作) */ "is_disabled": false, /* 是否不能购买(比如旧套餐或业务冲突) */ "tip": "" /* 系统提示(比如无法升级的原因) */ } }
实例变更
请求:
curl --location 'https://www.yingyongdun.com/user/api/instance/plan/modify' \ --header 'Content-Type: application/x-www-form-urlencoded' \ --data-urlencode 'access_id=接口编码' \ --data-urlencode 'access_key=接口秘钥' \ --data-urlencode 'instance_id=实例编码' \ --data-urlencode 'plan_id=需变更到的套餐编码'
返回:
{ "data": null /* 无返回结果 */ }
计算实例续期价格
请求:
curl --location 'https://www.yingyongdun.com/user/api/instance/plan/renew-calc' \ --header 'Content-Type: application/x-www-form-urlencoded' \ --data-urlencode 'access_id=接口编码' \ --data-urlencode 'access_key=接口秘钥' \ --data-urlencode 'instance_id=实例编码' \ --data-urlencode 'month=月数'
返回:
{ "data": { "price": "399.00", /* 价格 */ "save": "0.00", /* 已减(通常因年付或促销减去的金额) */ "is_disabled": false, /* 是否不能续期(比如旧套餐或业务冲突) */ "tip": "" /* 系统提示(比如无法续期的原因) */ } }
实例续期
请求:
curl --location 'https://www.yingyongdun.com/user/api/instance/plan/renew' \ --header 'Content-Type: application/x-www-form-urlencoded' \ --data-urlencode 'access_id=接口编码' \ --data-urlencode 'access_key=接口秘钥' \ --data-urlencode 'instance_id=实例编码' \ --data-urlencode 'month=月数'
返回:
{ "data": null /* 无返回结果 */ }