Domain name for API request: vod.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 | The VOD application ID. For customers who activate VOD service from December 25, 2023, if they want to access resources in a VOD application (whether it's the default application or a newly created one), they must fill in this field with the application ID. |
Type | No | String | Type of samples to pull. Valid values: Default value: UserDefine. Samples in the custom sample library will be pulled. Note: samples from the default library can only be pulled by providing the name or both the ID and name of a sample. Only one face image will be returned. |
PersonIds.N | No | Array of String | IDs of samples. Array length limit: 100. |
Names.N | No | Array of String | Names of samples. Array length limit: 20. |
Tags.N | No | Array of String | Tags of a sample. Array length limit: 20. |
Offset | No | Integer | Pagination offset. Default value: 0. |
Limit | No | Integer | Number of entries to be returned. Default value: 100. Maximum value: 100. |
Parameter Name | Type | Description |
---|---|---|
TotalCount | Integer | Number of eligible entries. |
PersonSet | Array of AiSamplePerson | Figure 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.tencentcloudapi.com/?Action=DescribePersonSamples
&PersonIds.0=10569
&Names.0=John Smith
&Tags.0=Celebrity
&Offset=0
&Limit=20
&<Common request parameters>
{
"Response": {
"TotalCount": 1,
"PersonSet": [
{
"PersonId": "10569",
"Name": "John Smith",
"Description": "American actor, director, and producer",
"UsageSet": [
"Recognition"
],
"FaceInfoSet": [
{
"FaceId": "10024",
"Url": "http://1256768367.vod2.myqcloud.com/8b0dd2b5vodcq1256768367/4d27b39f5285890783754292994/face.jpeg"
}
],
"TagSet": [
"US",
"Celebrity"
],
"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 | Incorrect parameter value. |
UnauthorizedOperation | Unauthorized operation. |
Was this page helpful?