デバイスのプロパティの目標値を削除します。
使用方法
- この操作を呼び出すたびに、Identifies パラメーターに、目標値を削除するプロパティの識別子を指定する必要があります。Identifies パラメーターを設定しない場合、呼び出しは失敗します。
- 1 回の呼び出しで、Identifies パラメーターに最大 10 個のプロパティ識別子を指定できます。
- この操作を呼び出してデバイスのプロパティの目標値を削除した後、QueryDeviceDesiredProperty 操作を呼び出して、デバイスのプロパティの目標値を照会できます。この場合、QueryDeviceDesiredProperty 操作は、Value パラメーターではなく、Identifier パラメーターを返します。
QPS 制限
この API 操作は、アカウントごとに 1 秒あたり最大 50 回呼び出すことができます。
説明 Alibaba Cloud アカウントの RAM ユーザーは、アカウントのクォータを共有します。
デバッグ
リクエストパラメーター
| パラメーター | タイプ | 必須 | 例 | 説明 |
| Action | String | いいえ | ClearDeviceDesiredProperty | 実行する操作。値を ClearDeviceDesiredProperty に設定します。 |
| IotInstanceId | String | いいえ | iot-2w**** | インスタンスの ID。 IoT Platform コンソール の [概要] ページでインスタンスの ID を確認できます。 重要
詳細については、「概要」をご参照ください。 |
| ProductKey | String | いいえ | a1BwAGV**** | デバイスが属するプロダクトの ProductKey。 説明 このパラメーターに値を指定する場合は、DeviceName パラメーターを設定する必要があります。 |
| DeviceName | String | いいえ | light | デバイスの DeviceName。 説明 このパラメーターに値を指定する場合は、ProductKey パラメーターを設定する必要があります。 |
| Identifies.N | RepeatList | いいえ | temperature | 目標値を削除するプロパティの識別子。最大 10 個のプロパティ識別子を指定できます。 |
| IotId | String | いいえ | Q7uOhVRdZRRlDnTLv****00100 | デバイスの ID。ID は、IoT Platform がデバイスに発行する一意の識別子です。 説明 IotId パラメーターは、デバイスのグローバル一意識別子 (GUID) を指定します。IotId パラメーターの値は、ProductKey パラメーターと DeviceName パラメーターの値の組み合わせと同じです。 IotId パラメーターに値を指定する場合は、ProductKey パラメーターまたは DeviceName パラメーターを設定する必要はありません。IotId パラメーター、ProductKey パラメーター、および DeviceName パラメーターに値を指定した場合、IotId パラメーターの値が優先されます。 |
上記の操作固有のリクエストパラメーターに加えて、この操作を呼び出すときは、共通のリクエストパラメーターを設定する必要があります。共通リクエストパラメーターの詳細については、「共通パラメーター」をご参照ください。
レスポンスパラメーター
| パラメーター | タイプ | 例 | 説明 |
| Code | String | iot.system.SystemException | 呼び出しが失敗した場合に返されるエラーコード。詳細については、このトピックの「エラーコード」セクションをご参照ください。 |
| Data | Struct | 呼び出しが成功した場合に返されるデータ。 |
|
| Versions | String | {\"temperature\":0} | この操作を呼び出して指定された目標プロパティ値を削除した後の、プロパティの目標値の最新バージョン。 |
| ErrorMessage | String | A system exception occurred. | 呼び出しが失敗した場合に返されるエラーメッセージ。 |
| RequestId | String | E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565 | リクエストの ID。 |
| Success | Boolean | true | 呼び出しが成功したかどうかを示します。有効な値:
|
例
リクエストの例
https://iot.cn-shanghai.aliyuncs.com/?Action=ClearDeviceDesiredProperty
&ProductKey=a1BwAGV****
&DeviceName=device1
&Identifies.1=temperature
&<Common request parameters>
成功レスポンスの例
XML 形式
<ClearDeviceDesiredPropertyResponse>
<RequestId>E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565</RequestId>
<Data>
<Versions>{"temperature":0}</Versions>
</Data>
<Code></Code>
<Success>true</Success>
</ClearDeviceDesiredPropertyResponse>
JSON 形式
{
"RequestId": "E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565",
"Data": {
"Versions": "{\"temperature\":0}"
},
"Code": "",
"Success": true
}
エラーコード
| HttpCode | エラーコード | エラーメッセージ | 説明 |
| 400 | iot.device.InvalidFormattedDeviceName | The DeviceName format is invalid. | DeviceName の形式が無効なために返されるエラーメッセージ。 |
| 400 | iot.device.NotSupportExemptionValidateType | The feature does not support the specified verification type. | この機能が検証不要タイプの TSL モデルをサポートしていないために返されるエラーメッセージ。 |
| 400 | iot.prod.NotExistedProduct | The specified product does not exist. | 指定されたプロダクトが存在しないために返されるエラーメッセージ。 |
| 400 | iot.prod.QueryProductPropertyFailed | An error occurred while querying the product property. | プロダクトプロパティの照会に失敗したために返されるエラーメッセージ。 |
| 400 | iot.check.InvalidFormattedParameter | The parameter format is invalid. | パラメーター値の形式が無効なために返されるエラーメッセージ。 |
| 400 | Iot.digitaltwin.DTInstanceInvalidThingType | The digital twin operation is not supported. | この操作はツインタイプのデータをサポートしていないために返されるエラーメッセージ。 |
| 400 | iot.check.NullParameter | Specify parameter is null. | パラメーターに値が指定されていないために返されるエラーメッセージ。 |
| 400 | iot.device.CanNotSetReadOnlyProperty | Cannot set read only property. | 読み取り専用プロパティの目標値は照会できないために返されるエラーメッセージ。 |
| 400 | iot.device.DeviceIsDisable | The specified device has been disabled. | デバイスが無効になっているために返されるエラーメッセージ。 |
| 400 | iot.device.InvalidIoTId | The specified device ID is invalid. | デバイス ID が無効なために返されるエラーメッセージ。 |
| 400 | iot.device.NullDeviceName | The DeviceName parameter cannot be empty. | デバイスの DeviceName が指定されていないために返されるエラーメッセージ。 |
| 400 | iot.prod.NullProductKey | The ProductKey parameter cannot be empty. | ProductKey パラメーターに値が指定されていないために返されるエラーメッセージ。 |
| 400 | iot.prod.InvalidFormattedProductkey | The ProductKey format is invalid. | ProductKey パラメーター値の形式が無効なために返されるエラーメッセージ。 |
| 400 | iot.common.InvalidTenant | The Invalid tenant. | テナントが無効であるか、作成に失敗したために返されるエラーメッセージ。 |
| 400 | iot.prod.QueryPropertyNotFound | Query property not found. | 照会されたプロパティが存在しないために返されるエラーメッセージ。 |
| 400 | iot.device.ClearPropertyDesiredFailed | Failed to clear desired value of property. | 目標プロパティ値の削除に失敗したために返されるエラーメッセージ。 |
| 400 | iot.prod.QueryProductAbilitiesNotFound | query product abilities not found. | 照会されたプロダクト機能が存在しないために返されるエラーメッセージ。 |
| 400 | iot.Device.NotExistedDevice | This device does not exist. | デバイスが存在しないか、アクティブ化されていないために返されるエラーメッセージ。 |
| 400 | iot.prod.NullAbilityIdentifier | You must specify a feature identifier. | 機能の識別子が指定されていないために返されるエラーメッセージ。 |
| 400 | iot.system.IllegalRequest | The request parameter is invalid. | リクエストパラメーター値が無効なために返されるエラーメッセージ。 |
エラーコードのリストについては、「サービスエラーコード」をご参照ください。