Domain name for API request: vod.intl.tencentcloudapi.com.
This API is used to query the information of samples and supports paginated queries by sample ID, name, and tag.
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 | VOD application ID. Customers who activate VOD services after December 25, 2023 must fill this field with the application ID when accessing resources in on-demand applications (whether default or newly created). |
| Type | No | String | Pulled material type. Valid values: Default value: UserDefine, pull user-customized material library materials. Description: If you pull the system default material library, you can only use the material name or material ID + material name via pull, and the facial features image returns only one. |
| PersonIds.N | No | Array of String | Material ID, with an array length limit of 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 | Pagination 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=Tom
&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. |
文档反馈