1. 接口描述
接口请求域名: bma.tencentcloudapi.com 。
查询作品基本信息
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeCRWorkInfo。 |
Version | 是 | String | 公共参数,本接口取值:2021-06-24。 |
Region | 否 | String | 公共参数,本接口不需要传递此参数。 |
WorkId | 是 | Integer | 作品ID 示例值:123 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
WorkName | String | 作品名称 示例值:xxx |
MonitorStatus | Integer | 监测状态 示例值:xxx |
AuthStatus | Integer | 授权文件状态 示例值:xxx |
CommStatus | Integer | 委托书状态 示例值:xxx |
IsProducer | Integer | 是否著作权人 示例值:xxx |
EvidenceStatus | Integer | 存证证书状态 示例值:xxx |
WorkCategory | String | 作品类型 示例值:xxx |
IsOriginal | String | 是否原创 示例值:xxx |
IsRelease | String | 是否已发表 示例值:xxx |
ProducerName | String | 著作权人姓名 示例值:xxx |
ProduceTime | String | 发表时间 示例值:xxx |
WhiteLists | Array of String | 白名单 示例值:xxx |
WorkDesc | String | 作品描述 示例值:xxx |
Authorization | String | 授权书 示例值:xxx |
AuthorizationStartTime | String | 授权书生效日期 示例值:xxx |
AuthorizationEndTime | String | 授权书截止日期 示例值:xxx |
Commission | String | 委托书 示例值:xxx |
CommissionStartTime | String | 委托书生效日期 示例值:xxx |
CommissionEndTime | String | 委托书截止日期 示例值:xxx |
EvidenceUrl | String | 存证证书 示例值:xxx |
EvidenceStartTime | String | 存证证书生效日期 示例值:xxx |
EvidenceEndTime | String | 存证证书截止日期 示例值:xxx |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询作品基本信息
输入示例
POST / HTTP/1.1
Host: bma.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeCRWorkInfo
<公共请求参数>
{
"WorkId": 111
}
输出示例
{
"Response": {
"EvidenceStatus": 0,
"MonitorStatus": 1,
"AuthorizationEndTime": "xx",
"Commission": "xx",
"AuthStatus": 1,
"Authorization": "xx",
"AuthorizationStartTime": "xx",
"IsOriginal": "xx",
"EvidenceStartTime": "xx",
"CommissionStartTime": "xx",
"EvidenceEndTime": "xx",
"IsRelease": "xx",
"WorkDesc": "xx",
"EvidenceUrl": "xx",
"ProduceTime": "xx",
"RequestId": "xx",
"ProducerName": "xx",
"IsProducer": 0,
"WhiteLists": [
"xx"
],
"WorkName": "xx",
"CommissionEndTime": "xx",
"CommStatus": 1,
"WorkCategory": "xx"
}
}
5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
AuthFailure | CAM签名/鉴权错误。 |
FailedOperation | 操作失败。 |
InternalError | 内部错误。 |
InvalidAction | 接口不存在。 |
InvalidParameter | 参数错误。 |
InvalidParameterValue | 参数取值错误。 |
LimitExceeded | 超过配额限制。 |
MissingParameter | 缺少参数错误。 |
NoSuchVersion | 接口版本不存在。 |
OperationDenied | 操作被拒绝。 |
RequestLimitExceeded | 请求的次数超过了频率限制。 |
ResourceInUse | 资源被占用。 |
ResourceInsufficient | 资源不足。 |
ResourceNotFound | 资源不存在。 |
ResourceUnavailable | 资源不可用。 |
ResourcesSoldOut | 资源售罄。 |
UnauthorizedOperation | 未授权操作。 |
UnknownParameter | 未知参数错误。 |
UnsupportedOperation | 操作不支持。 |