1. 接口描述
接口请求域名: facefusion.tencentcloudapi.com 。
通常通过腾讯云人脸融合的控制台可以查看到素材相关的参数数据,可以满足使用。本接口返回活动的素材数据,包括素材状态等。用于用户通过Api查看素材相关数据,方便使用。
默认接口请求频率限制:1次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeMaterialList。 |
Version | 是 | String | 公共参数,本接口取值:2018-12-01。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表,本接口仅支持其中的: ap-beijing, ap-chengdu, ap-guangzhou, ap-nanjing, ap-shanghai 。 |
ActivityId | 是 | Integer | 活动Id 示例值:300314 |
MaterialId | 否 | String | 素材Id 示例值:qc_300314_789050_75 |
Limit | 否 | Integer | 每次拉取条数 示例值:20 |
Offset | 否 | Integer | 偏移量 示例值:0 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
MaterialInfos | Array of PublicMaterialInfos | 素材列表数据 示例值:[{"CreateTime":"2022-11-29 18:46:34","MaterialFaceList":[{"FaceId":"mt_1597542526641664000_1","FaceInfo":{"Height":167,"Width":128,"X":221,"Y":125}}],"MaterialId":"mt_1597542526641664000","MaterialName":"test1.png","MaterialStatus":0,"UpdateTime":"2022-11-29 18:46:34"},{"CreateTime":"2022-12-15 14:19:51","MaterialFaceList":[{"FaceId":"mt_1603273612711829504_1","FaceInfo":{"Height":167,"Width":128,"X":221,"Y":125}}],"MaterialId":"mt_1603273612711829504","MaterialName":"test2.png","MaterialStatus":0,"UpdateTime":"2022-12-15 14:19:51"},{"CreateTime":"2022-11-10 10:28:10","MaterialFaceList":[{"FaceId":"mt_1590531733435097088_1","FaceInfo":{"Height":167,"Width":128,"X":221,"Y":125}}],"MaterialId":"mt_1590531733435097088","MaterialName":"test3.png","MaterialStatus":1,"UpdateTime":"2022-12-07 17:10:54"},{"CreateTime":"2022-12-07 16:13:41","MaterialFaceList":[{"FaceId":"mt_1600403157392855040_1","FaceInfo":{"Height":236,"Width":177,"X":186,"Y":95}}],"MaterialId":"mt_1600403157392855040","MaterialName":"test4.png","MaterialStatus":3,"UpdateTime":"2022-12-07 16:13:52"},{"CreateTime":"2022-12-15 14:20:21","MaterialFaceList":[{"FaceId":"mt_1603273738050215936_1","FaceInfo":{"Height":129,"Width":119,"X":215,"Y":69}}],"MaterialId":"mt_1603273738050215936","MaterialName":"test5.jpg","MaterialStatus":3,"UpdateTime":"2022-12-15 14:25:28"}] |
Count | Integer | 素材条数 示例值:10 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 素材列表
拉起素材列表(对外)
输入示例
POST / HTTP/1.1
Host: facefusion.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeMaterialList
<公共请求参数>
{
"ActivityId": "10",
"Limit": "10",
"MaterialId": "\"q-materialId-000\"",
"Offset": "1"
}
输出示例
{
"Response": {
"MaterialInfos": [
{
"MaterialStatus": 2,
"MaterialId": "qc_300232_698652_24",
"MaterialFaceList": [
{
"FaceId": "300232_24_1",
"FaceInfo": {
"X": 43,
"Y": 86,
"Width": 127,
"Height": 127
}
}
],
"CreateTime": "2020-04-09T03:27:02.903Z",
"UpdateTime": "2020-04-09T03:27:02.903Z",
"BlendParamPtu": 50,
"BlendParamYoutu": 50,
"PositionParamPtu": 50,
"PositionParamYoutu": 50,
"Url": "https://facefusion-test-1254418846.cos.ap-guangzhou.myqcloud.com/251009261/300232/qc_300232_698652_24?q-sign-algorithm=sha1&q-ak=AKIDwPsEPTKPkvyqWIN2iCUeeU9brvnUQIgx&q-sign-time=1589864388;1589864688&q-key-time=1589864388;1589864688&q-header-list=&q-url-param-list=&q-signature=0238eb819c073d889ba056a151cdfe4688c1b5fa"
}
],
"Count": 1,
"RequestId": "testDescribeMaterialList1589864389240"
}
}
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.InvalidAuthorization | 认证失败。 |
FailedOperation | 操作失败。 |
FailedOperation.FuseMaterialNotExist | 素材不存在。 |
FailedOperation.InnerError | 服务内部错误。 |
FailedOperation.ParameterValueError | 参数字段或者值有误。 |
FailedOperation.RequestTimeout | 后端服务超时。 |
FailedOperation.ServerError | 系统内部错误。 |
InvalidParameterValue.ActivityIdNotFound | 未查找到活动id。 |
InvalidParameterValue.MaterialIdNotFound | 未查找到素材Id。 |
ResourceUnavailable.InArrears | 账号已欠费。 |