1. 接口描述
接口请求域名: vcube.tencentcloudapi.com 。
用于优图美视资源列表展示
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeXMagicResourceList。 |
Version | 是 | String | 公共参数,本接口取值:2022-04-10。 |
Region | 否 | String | 公共参数,此参数为可选参数。 |
PageNumber | 是 | Integer | 分页页码 第一页是0 示例值:1 |
PageSize | 是 | Integer | 每页数量 示例值:50 |
AppName | 否 | String | 关联的应用名称 示例值:腾讯云 |
ResourceId | 否 | String | 优图资源Id 示例值:xmc11671a6134d082bf79 |
Word | 否 | String | 查询关键字,资源Id、应用名称、包名 示例值:nengc |
Platform | 否 | String | 平台信息,pc 或者 mobile 示例值:pc |
BizType | 否 | String | 所属业务,xmagic:优图, avatar:虚拟人,不传查全部 示例值:xmagic |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
Resources | Array of XMagicResourceSimpleInfo | 优图资源包信息 |
Count | Integer | 资源数量 示例值:12 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 获取优图资源列表
视立方获取资源列表
输入示例
POST / HTTP/1.1
Host: vcube.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeXMagicResourceList
<公共请求参数>
{
"PageNumber": 1,
"PageSize": 1
}
输出示例
{
"Response": {
"Count": 1,
"RequestId": "094a3e49-200a-4841-8d29-849763a6e6a4",
"Resources": [
{
"AppId": "1317625488",
"Application": {
"AppId": "1317625488",
"AppName": "nengc.app",
"AppType": "formal",
"BundleId": "com.nengc.app",
"CreatedAt": "2023-02-13T06:44:23.605Z",
"DomainList": [
"tencet.com"
],
"Id": 412,
"MacBundleId": "com.nengc",
"PackageName": "com.nengc.app",
"UpdatedAt": "2024-09-05T08:32:57.951Z",
"WinProcessName": "com.nengc"
},
"AutoRenewFlag": 1,
"Operation": [
"negnc"
],
"BizType": "xmagic",
"CreatedAt": "2024-04-12T04:13:33.438Z",
"Duration": "1",
"EndTime": "2025-04-12T12:13:33+08:00",
"Id": 79,
"IsUse": false,
"Name": "Advanced S101",
"Plan": "S1-01",
"ResourceId": "xmc11671a6134d082bf79",
"StartTime": "2024-04-12T12:13:33+08:00",
"Status": 2,
"UpdatedAt": "2024-04-12T04:18:17.000Z",
"XMagic": {
"Id": 301,
"Status": 1
},
"XMagicType": "combined"
}
]
}
}
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 | 操作失败。 |
FailedOperation.UploadLicenseFileFail | License文件上传失败。 |
InternalError | 内部错误。 |
InvalidParameter | 参数错误。 |
InvalidParameterValue | 参数取值错误。 |
ResourceInUse | 资源被占用。 |
ResourceInsufficient | 资源不足。 |
ResourceNotFound | 资源不存在。 |
ResourceUnavailable | 资源不可用。 |
UnauthorizedOperation | 未授权操作。 |