Domain name for API request: vod.intl.tencentcloudapi.com.
This API is used to query material sample information by material ID, name, or tag with paging.
A maximum of 100 requests can be initiated per second for this API.
The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| Action | Yes | String | Common Params. The value used for this API: DescribePersonSamples. |
| Version | Yes | String | Common Params. The value used for this API: 2018-07-17. |
| Region | No | String | Common Params. This parameter is not required. |
| SubAppId | No | Integer | Video-on-demand (VOD) application ID. For customers who activate VOD services from December 25, 2023, if they access resources in VOD applications (whether the default application or a newly created application), this field must be filled in as the application ID. |
| Type | No | String | Pulled material type. Available values: Default value: UserDefine, which pulls materials from the user-customized material library. |
| PersonIds.N | No | Array of String | Material ID. Array length limit: 100. |
| Names.N | No | Array of String | Material name. Array length limit: 20. |
| Tags.N | No | Array of String | Material tag. Array length limit: 20. |
| Offset | No | Integer | Paging offset. Default value: 0. |
| Limit | No | Integer | Number of returned entries. Default value: 100. Maximum value: 100. |
| Parameter Name | Type | Description |
|---|---|---|
| TotalCount | Integer | Total number of qualified records. |
| PersonSet | Array of AiSamplePerson | Character information. |
| RequestId | String | The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. |
https://vod.intl.tencentcloudapi.com/?Action=DescribePersonSamples
&PersonIds.0=10569
&Names.0=Zhang San
&Tags.0=Star
&Offset=0
&Limit=20
&<Common request parameters>{
"Response": {
"TotalCount": 1,
"PersonSet": [
{
"PersonId": "10569",
"Name": "Zhang San",
"Description": "Chinese-language film and television male actor, Director, Producer",
"UsageSet": [
"Recognition"
],
"FaceInfoSet": [
{
"FaceId": "10024",
"Url": "http://example.com/8b0dd2b5vodcq1256768367/4d27b39f5285890783754292994/face.jpeg"
}
],
"TagSet": [
USA
Star
],
"CreateTime": "2018-10-01T10:00:00Z",
"UpdateTime": "2018-10-01T10:00:00Z"
}
],
"RequestId": "7d80775f-fb6d-4204-9540-1876f0d1c5a9"
}
}TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
| Error Code | Description |
|---|---|
| FailedOperation | Operation failed. |
| InternalError | Internal error. |
| InvalidParameterValue | Parameter value error. |
| UnauthorizedOperation | Unauthorized operation. |
Was this page helpful?
You can also Contact sales or Submit a Ticket for help.
Help us improve! Rate your documentation experience in 5 mins.
Feedback