Domain name for API request: mps.tencentcloudapi.com.
This API is used to query the information of image samples. It supports paginated queries by image 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: 2019-06-12. |
Region | No | String | Common Params. This parameter is not required for this API. |
Type | No | String | Type of images to pull. Valid values: Default value: UserDefine. Samples in the custom image library will be pulled. Note: you can pull the default image library only using the image name or a combination of the image name and ID, and only one face image is returned. |
PersonIds.N | No | Array of String | Image ID. Array length limit: 100 |
Names.N | No | Array of String | Image name. Array length limit: 20 |
Tags.N | No | Array of String | Image 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 | Number of eligible entries. |
PersonSet | Array of AiSamplePerson | Image 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://mps.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",
"FaceInfoSet": [
{
"FaceId": "10024",
"Url": "http://1256768367.vod2.myqcloud.com/8b0dd2b5vodcq1256768367/4d27b39f5285890783754292994/face.jpeg"
}
],
"UsageSet": [
"Recognition"
],
"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.InvalidMpsUser | Operation failed: unauthorized MPS user. |
InternalError | Internal error. |
InvalidParameterValue | Incorrect parameter value. |
Was this page helpful?