查询字幕文件上传进度,返回各文件的处理状态和详细信息

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

const columns = [
  {
    width: '20%',
    title: '参数',
    dataIndex: 'Name',
    className: 'openapi-doc-parameter-table-name'
  },
  {
    width: 130,
    title: '类型',
    dataIndex: 'DataType',
    className: 'openapi-doc-parameter-table-type'
  },
  {
    width: 90,
    title: '是否必填',
    dataIndex: 'IsRequired',
    className: 'openapi-doc-parameter-table-required'
  },
  {
    width: '20%',
    title: '示例值',
    dataIndex: 'Example',
    className: 'openapi-doc-parameter-table-example'
  },
  {
    title: '描述',
    dataIndex: 'Description',
    className: 'openapi-doc-parameter-table-description'
  },
];

const data = [
  {
    rowKey: '->Action',
    Name: 'Action',
    DataType: 'String',
    IsRequired: '是',
    Example: <RenderMd content={"VideoProjectGetUploadSubtitleStatus"} />,
    Description: <RenderMd content={"要执行的操作，取值：VideoProjectGetUploadSubtitleStatus。"} />,
    children: [
    ]
  },
  {
    rowKey: '->Version',
    Name: 'Version',
    DataType: 'String',
    IsRequired: '是',
    Example: <RenderMd content={"2021-05-21"} />,
    Description: <RenderMd content={"API的版本，取值：2021-05-21。"} />,
    children: [
    ]
  },
  {
    rowKey: '->projectId',
    Name: 'projectId',
    DataType: 'String',
    IsRequired: '是',
    Example: <RenderMd content={"123456"} />,
    Description: <RenderMd content={"项目ID,指定需查询进度的项目"} />,
    children: [
    ]
  },
  {
    rowKey: '->batchId',
    Name: 'batchId',
    DataType: 'String',
    IsRequired: '是',
    Example: <RenderMd content={"789012"} />,
    Description: <RenderMd content={"批次ID,通过字幕上传API获取"} />,
    children: [
    ]
  },

];

return (<Table
  rowKey="rowKey"
  className="openapi-doc-parameter-table"
  columns={columns}
  data={data}
  border={ { cell: true, wrapper: true } }
  scroll={ { x: "auto" } }
  pagination={false}
/>);

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结构。

const columns = [
  {
    width: '25%',
    title: '参数',
    dataIndex: 'Name',
    className: 'openapi-doc-parameter-table-name',
  },
  {
    width: 130,
    title: '类型',
    dataIndex: 'DataType',
    className: 'openapi-doc-parameter-table-type'
  },
  {
    width: '25%',
    title: '示例值',
    dataIndex: 'Example',
    className: 'openapi-doc-parameter-table-example'
  },
  {
    title: '描述',
    dataIndex: 'Description',
    className: 'openapi-doc-parameter-table-description'
  },
];

const data = [
  {
    rowKey: "->data",
    Name: "data",
    DataType: "Object",
    Example: <RenderMd content={"{\n\"batchId\": \"345617748226\",\n        \"uploadSubtitleInfos\": [\n            {\n                \"projectId\": \"337358631938\",\n                \"subtitleId\": \"343462698498\",\n                \"url\": \"https://sf1-cdn-tos.huoshanstatic.com/obj/ies.fe.starling/qqqq_zh_1_a638140ebc454f9db8aed6c1cb62c437.ass\",\n                \"name\": \"重生后得到\",\n                \"langs\": [\n                    \"zh\"\n                ],\n                \"type\": 0,\n                \"fileType\": 2,\n                \"bindVid\": \"v0334dg10001d91r4sfog65ik18vndog\",\n                \"status\": 2\n            }\n        ],}"} />,
    Description: <RenderMd content={"上传字幕返回结果"} />,
    children: [
        {
          rowKey: "->data->batchId",
          Name: "batchId",
          DataType: "String",
          Example: <RenderMd content={""} />,
          Description: <RenderMd content={"上传字幕的批次id"} />,
          children: [
          ]
        },
        {
          rowKey: "->data->uploadSubtitleInfos",
          Name: "uploadSubtitleInfos",
          DataType: "Array of Object",
          Example: <RenderMd content={""} />,
          Description: <RenderMd content={"字幕文件上传状态列表"} />,
          children: [
            {
              rowKey: "->data->uploadSubtitleInfos->projectId",
              Name: "projectId",
              DataType: 'String',
              Example: <RenderMd content={"123456"} />,
              Description: <RenderMd content={"项目ID"} />,
              children: [
              ]
            },
            {
              rowKey: "->data->uploadSubtitleInfos->subtitleId",
              Name: "subtitleId",
              DataType: 'String',
              Example: <RenderMd content={"111"} />,
              Description: <RenderMd content={"字幕文件的唯一标识(上传成功后生成)"} />,
              children: [
              ]
            },
            {
              rowKey: "->data->uploadSubtitleInfos->url",
              Name: "url",
              DataType: 'String',
              Example: <RenderMd content={"https://example.com/subtitle.srt"} />,
              Description: <RenderMd content={"字幕文件的原始URL"} />,
              children: [
              ]
            },
            {
              rowKey: "->data->uploadSubtitleInfos->name",
              Name: "name",
              DataType: 'String',
              Example: <RenderMd content={"episode1_en"} />,
              Description: <RenderMd content={"字幕文件名称"} />,
              children: [
              ]
            },
            {
              rowKey: "->data->uploadSubtitleInfos->fileType",
              Name: "fileType",
              DataType: 'Integer',
              Example: <RenderMd content={"1"} />,
              Description: <RenderMd content={"字幕文件格式: 1-SRT, 2-ASS"} />,
              children: [
              ]
            },
            {
              rowKey: "->data->uploadSubtitleInfos->bindVid",
              Name: "bindVid",
              DataType: 'String',
              Example: <RenderMd content={"v12345"} />,
              Description: <RenderMd content={"字幕文件关联的vid,没有则为空"} />,
              children: [
              ]
            },
            {
              rowKey: "->data->uploadSubtitleInfos->status",
              Name: "status",
              DataType: 'Integer',
              Example: <RenderMd content={"2"} />,
              Description: <RenderMd content={"上传状态: 1-上传中, 2-上传成功, 3-上传失败"} />,
              children: [
              ]
            },
            {
              rowKey: "->data->uploadSubtitleInfos->errMsg",
              Name: "errMsg",
              DataType: 'String',
              Example: <RenderMd content={""} />,
              Description: <RenderMd content={"错误信息,上传失败时返回"} />,
              children: [
              ]
            },
            {
              rowKey: "->data->uploadSubtitleInfos->langs",
              Name: "langs",
              DataType: 'Array of String',
              Example: <RenderMd content={""} />,
              Description: <RenderMd content={"字幕文件的语种"} />,
              children: [
              ]
            },
          ]
        },
    ]
  },
];

return (<Table
  rowKey="rowKey"
  className="openapi-doc-parameter-table"
  columns={columns}
  data={data}
  border={ { cell: true, wrapper: true } }
  scroll={ { x: "auto" } }
  pagination={false}
/>);

请求示例

GET /?Action=VideoProjectGetUploadSubtitleStatus&Version=2021-05-21&projectId=123456&batchId=789012 HTTP/1.1
Host: open.volcengineapi.com

返回示例

{"ResponseMetadata":{"RequestId":"202506241234560002","Action":"VideoProjectGetUploadSubtitleStatus","Version":"2021-05-21","Service":"i18n_console","Region":"cn-beijing"},"Result":{"uploadId":"789012","uploadSubtitleInfos":[{"projectId":"123456","subtitleId":"111","url":"https://example.com/subtitle.srt","name":"episode1_en","lang":"en","fileType":1,"bindVid":"v12345","status":2}]}}

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

const columns = [
  {
    title: '状态码',
    dataIndex: 'HttpCode',
    width: '12%',
    className: 'openapi-doc-errorcode-table-httpcode'
  },
  {
    title: '错误码',
    dataIndex: 'ErrorCode',
    width: '22%',
    className: 'openapi-doc-errorcode-table-errorcode'
  },
  {
    title: '错误信息',
    dataIndex: 'ErrorMessage',
    width: '33%',
    className: 'openapi-doc-errorcode-table-errormessage'
  },
  {
    title: '说明',
    dataIndex: 'Description',
    width: '33%',
    className: 'openapi-doc-errorcode-table-description'
  },
];

const data = [
  {
    HttpCode: 400,
    ErrorCode: '1001',
    ErrorMessage: <RenderMd content={"Server Error"} />,
    Description: <RenderMd content={"服务内部错误"} />,
  },
];

return (<Table
  columns={columns}
  data={data}
  border={ { cell: true, wrapper: true } }
  scroll={ { x: "auto" } }
  pagination={false}
/>);