Skip to content

PDF转换任务查询

适用版本>=v7.0.2502b.20250227

接口说明:PDF转换任务查询

请求说明

请求地址配置域名+/openapi+/v7/kdocs/pdf/convert/tasks/{task_id}/meta
请求方法GET
签名方式KSO-1(配置域名+/openapi不参与签名)
权限要求应用文档PDF转换(应用授权) kso.appfile.pdf_cps.readwrite

请求头(Header)

Header参数类型是否必填说明
X-Kso-DatestringRFC1123 格式的日期,例: Wed, 23 Jan 2013 06:43:08 GMT
X-Kso-AuthorizationstringKSO-1 签名值,详见《签名方法》
Authorizationstring授权凭证,格式为:Bearer {access_token}

路径参数(Path)

名称类型是否必填说明
task_idstring任务ID

响应体(Response)

名称类型说明
dataobject
err_codeintegerpdf转换任务错误码
err_msgstringpdf转换任务错误信息
statusstringpdf转换任务任务状态,success:成功;running:进行中;failed:失败;
fileobject文件信息
created_byobject创建者信息
idstring身份ID
typestringEnum: "user" "sp",身份类型
ctimeinteger创建时间,时间戳,单位为秒
driveobject驱动盘信息
allotee_idstring盘归属的应用id,长度不超过1024位
allotee_typestring盘归属身份类型,固定为app
company_idstring企业id(应用文档:忽略此参数)
created_byobject创建者信息
idstring身份ID
typestringEnum: "user" "sp",身份类型
ctimeinteger创建时间,时间戳,单位为秒
descriptionstring盘描述
ext_attrsobject[]盘扩展属性
namestring名称
valuestring
idstring驱动盘id
mtimeinteger修改时间,时间戳,单位为秒
namestring驱动盘名称
permission_modestringEnum: "builtin" "callback",权限校验模式
quotaobject[]盘容量(应用文档:返回-1)
deletedinteger回收站中的文件占用的总空间,以字节为单位。只读。
remaininginteger剩余的总空间,以字节为单位。只读。
totalinteger允许的总存储空间,以字节为单位。只读。
usedinteger已使用的总空间,以字节为单位。只读。
sourcestring盘来源,应用文档:appfile
statusstringEnum: "inuse" "deleted",盘状态
storage_modestringEnum: "tree" "kv",驱动盘组织结构
drive_idstring驱动盘id
idstring文件id
link_idstring链接id(应用文档:忽略此参数)
link_urlstring链接url(应用文档:忽略此参数)
modified_byobject修改者信息
idstring身份ID
typestringEnum: "user" "sp",身份类型
mtimeinteger修改时间,时间戳,单位为秒
namestring文件名
parent_idstring父目录id(应用文档:0)
sharedboolean是否开启分享(应用文档:false)
sizeinteger文件大小
typestringEnum: "folder" "file" "shortcut",文件类型(应用文档:file)
versioninteger文件版本号
codeint错误码
msgstring状态信息
detailstring详细信息

响应体示例

json
{
  "data": {
    "err_code": 0,
    "err_msg": "string",
    "file": {
      "created_by": {
        "id": "string",
        "type": "sp"
      },
      "ctime": 0,
      "drive": {
        "allotee_id": "string",
        "allotee_type": "app",
        "company_id": "string",
        "created_by": {
          "id": "string",
          "type": "sp"
        },
        "ctime": 0,
        "description": "string",
        "ext_attrs": [
          {
            "name": "string",
            "value": "string"
          }
        ],
        "id": "string",
        "mtime": 0,
        "name": "string",
        "permission_mode": "callback",
        "quota": {
          "deleted": -1,
          "remaining": -1,
          "total": -1,
          "used": -1
        },
        "source": "string",
        "status": "inuse",
        "storage_mode": "kv"
      },
      "drive_id": "string",
      "id": "string",
      "link_id": "string",
      "link_url": "string",
      "modified_by": {
        "id": "string",
        "type": "sp"
      },
      "mtime": 0,
      "name": "string",
      "parent_id": "string",
      "shared": false,
      "size": 0,
      "type": "file",
      "version": 0
    },
    "status": "success"
  },
  "code": 0,
  "detail": "string",
  "msg": "string"
}