Deletes specified images from the specified IP camera.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameter

Parameter Type Required Example Description
Action String Yes DeletePicture

The operation that you want to perform. Set the value to DeletePicture.

PictureIdList.N RepeatList Yes cFc5MzZ****npYT1***TDFzX1hrVzA0Z****

The IDs of the images. An image ID is generated when the TriggerCapturePicture operation is called.

Note You can specify a maximum of 50 image IDs in a single call.
ProductKey String No a1BwAGV****

The ProductKey of the product to which the IP camera belongs.

You can view the information about all products within the current account on the Products page of the IoT Platform console or by calling the QueryProductList operation.

Important If you configure this parameter, you must also specify a value for the DeviceName parameter.
DeviceName String No camera1

The DeviceName of the IP camera.

You can view the DeviceName of the IP camera on the Devices page of the IoT Platform console.

Important If you specify this parameter, you must also specify the ProductKey parameter.
IotId String No 1CJ0****e7qiq8VkQi1000000

The ID of the IP camera. IoT Platform allocates an ID to each IP camera to uniquely identify the IP camera. You can call the QueryDeviceDetail operation of IoT Platform to query the ID of the IP camera.

Important If you specify this parameter, you do not need to specify the ProductKey or DeviceName parameter. The IotId parameter specifies a GUID of the IP camera, which corresponds to a combination of the ProductKey and DeviceName parameters. If you specify both the IotId parameter and the combination of the ProductKey and DeviceName parameters, the IotId parameter takes precedence.
IotInstanceId String No iot-cn-n6w1y******

The ID of the instance. You can view the ID of the instance on the Overview page in the IoT Platform console.

Important
  • If your instance has an ID, you must specify this parameter. Otherwise, the call fails.
  • If the Overview page or an instance ID is not displayed in the IoT Platform console, ignore this parameter.

For more information, see Instance overview.

In addition to the preceding operation-specific request parameters, you must specify common request parameters when you call this operation. For more information, see Common request parameters.

Response parameters

Parameter Type Example Description
Code String 200

The response code. Valid values:

  • 200: The call was successful.
  • Other codes: The call failed. For more information about error codes, see the "Error codes" section of this topic.
Data Struct

The response data.

DeletedCount Integer 3

The number of images that are successfully deleted.

ErrorMessage String request forbidden

The error message returned if the call fails.

RequestId String 06DC77A0-4622-42DB-9EE0-25FIOHS82JK1

The ID of the request.

Success Boolean true

Indicates whether the operation is successful. Valid values:

  • true
  • false

Examples

Sample requests

http(s)://linkvisual.cn-shanghai.aliyuncs.com/?Action=DeletePicture
&PictureIdList.1=cFc5MzZ****npYT1***TDFzX1hrVzA0Z****
&IotInstanceId=iot-cn-n6w1y******
&<Common request parameters>

Sample success responses

XML format

<DeletePictureResponse>
      <RequestId>06DC77A0-4622-42DB-9EE0-25FIOHS82JK1</RequestId>
      <Data>
            <DeletedCount>3</DeletedCount>
      </Data>
      <Code>200</Code>
      <Success>true</Success>
</DeletePictureResponse>

JSON format

{
    "RequestId": "06DC77A0-4622-42DB-9EE0-25FIOHS82JK1",
    "Data": {
        "DeletedCount": 3
    },
    "Code": 200,
    "Success": true
}

Error codes

HttpCode Error code Error message Description
403 iot.lv.requestParamError Request parameter error. The error message returned because the specified request parameters are invalid.
403 iot.lv.requestAuthError Request auth error. The error message returned because an error occurred during authentication.
400 iot.lv.requestError Request error The error message returned because a request error occurred.

For a list of error codes, see Service error codes.