'1.0',
'info' => [
'style' => 'RPC',
'product' => 'Linkvisual',
'version' => '2023-06-30',
],
'directories' => [
[
'id' => 352715,
'title' => null,
'type' => 'directory',
'children' => [
'BindStorageOrder',
'CheckFreeStorageValid',
'ConsumeFreeStorage',
'CreateAndPayStorageOrder',
'EnableFreeStorage',
'EnableStorageOrder',
'FreezeFreeStorage',
'GenerateDevice',
'FreezeStorageOrder',
'GenerateDeviceByBatchId',
'QueryBatchStatus',
'QueryDeviceDetail',
'QueryFreeStorage',
'QueryDevicesDownloadUrl',
'QueryGenerateDevicesInfoList',
'QueryGenerateDevicesRecord',
'QueryStorageCommodityList',
'QueryStorageOrder',
'QueryStorageOrderList',
'TransferStorageOrder',
'UploadDeviceNameList',
'GetThingEventSnapshot',
'BatchBindDevice',
'GetAccountById',
'GetDeviceStatus',
'GetSubDeviceList',
'GetThingPropertySnapshot',
'InvokeThingService',
'ListBindingAccountByDevice',
'ListBindingDeviceByAccount',
'SetThingProperty',
'UnbindAllUserByDevice',
'UnbindDevice',
],
],
],
'components' => [
'schemas' => [],
],
'apis' => [
'BindStorageOrder' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [],
'parameters' => [
[
'name' => 'EventRecordDuration',
'in' => 'query',
'schema' => [
'type' => 'integer',
'format' => 'int32',
'required' => false,
'maximum' => '30',
'minimum' => '0',
'default' => '10',
],
],
[
'name' => 'OrderId',
'in' => 'query',
'schema' => [
'type' => 'string',
'required' => true,
],
],
[
'name' => 'ProductKey',
'in' => 'query',
'schema' => [
'type' => 'string',
'required' => false,
],
],
[
'name' => 'DeviceName',
'in' => 'query',
'schema' => [
'type' => 'string',
'required' => false,
],
],
[
'name' => 'EventRecordProlong',
'in' => 'query',
'schema' => [
'type' => 'boolean',
'required' => false,
'default' => 'false',
],
],
[
'name' => 'UserName',
'in' => 'query',
'schema' => [
'type' => 'string',
'required' => false,
],
],
[
'name' => 'UserId',
'in' => 'query',
'schema' => [
'type' => 'string',
'required' => false,
],
],
[
'name' => 'MaxRecordFileDuration',
'in' => 'query',
'schema' => [
'type' => 'integer',
'format' => 'int32',
'required' => false,
'maximum' => '3600',
'minimum' => '600',
'default' => '1800',
],
],
[
'name' => 'IotId',
'in' => 'query',
'schema' => [
'type' => 'string',
'required' => false,
],
],
[
'name' => 'EnableDefaultPlan',
'in' => 'query',
'schema' => [
'type' => 'boolean',
'required' => false,
'default' => 'false',
],
],
[
'name' => 'PreRecordDuration',
'in' => 'query',
'schema' => [
'type' => 'integer',
'format' => 'int32',
'required' => false,
'maximum' => '5',
'minimum' => '0',
'default' => '0',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => [
'type' => 'string',
],
'ErrorMessage' => [
'type' => 'string',
],
'RequestId' => [
'type' => 'string',
],
'Success' => [
'type' => 'boolean',
],
'Data' => [
'type' => 'object',
'properties' => [
'Status' => [
'type' => 'integer',
'format' => 'int32',
],
'Copies' => [
'type' => 'integer',
'format' => 'int32',
],
'Specification' => [
'type' => 'string',
],
'RecordType' => [
'type' => 'integer',
'format' => 'int32',
],
'CommodityCode' => [
'type' => 'string',
],
'PreConsume' => [
'type' => 'integer',
'format' => 'int32',
],
'EndTimeUTC' => [
'type' => 'string',
],
'UserId' => [
'type' => 'string',
],
'IdentityId' => [
'type' => 'string',
],
'StartTimeUTC' => [
'type' => 'string',
],
'EndTime' => [
'type' => 'string',
],
'StartTime' => [
'type' => 'string',
],
'OutOrderNo' => [
'type' => 'string',
],
'Price' => [
'type' => 'string',
],
'OrderType' => [
'type' => 'integer',
'format' => 'int32',
],
'PaymentStatus' => [
'type' => 'integer',
'format' => 'int32',
],
'UserName' => [
'type' => 'string',
],
'OrderId' => [
'type' => 'string',
],
'IotId' => [
'type' => 'string',
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'iot.vision.RequestParamError',
'errorMessage' => 'Request parameter error.',
],
[
'errorCode' => 'iot.vision.RequestFailed',
'errorMessage' => 'Request failed.',
],
[
'errorCode' => 'iot.vision.UnexpectedInternalError',
'errorMessage' => 'Unexpected internal error.',
],
[
'errorCode' => 'iot.vision.DeviceNoOwner',
'errorMessage' => 'Device has no owner.',
],
[
'errorCode' => 'iot.vision.InvalidStorageOrder',
'errorMessage' => 'Invalid storage order.',
],
[
'errorCode' => 'iot.vision.DeviceOwnerChanged',
'errorMessage' => 'Device owner changed.',
],
[
'errorCode' => 'iot.vision.StorageOrderGetLockFailed',
'errorMessage' => 'Get storage order lock failed try again later.',
],
[
'errorCode' => 'iot.vision.GetOwnerIdentityInfoFailed',
'errorMessage' => 'Get owner identity info failed.',
],
[
'errorCode' => 'iot.vision.SetDefaultRecordPlanFailed',
'errorMessage' => 'Set default record plan failed.',
],
[
'errorCode' => 'iot.vision.DeviceNotExist',
'errorMessage' => 'Device not exist.',
],
],
403 => [
[
'errorCode' => 'iot.vision.RequestAuthFailed',
'errorMessage' => 'Request auth failed.',
],
[
'errorCode' => 'iot.vision.RequestForbidden',
'errorMessage' => 'Request forbidden.',
],
],
429 => [
[
'errorCode' => 'iot.vision.RequestTrafficControl',
'errorMessage' => 'Request traffic control.',
],
],
],
],
'CheckFreeStorageValid' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [],
'parameters' => [
[
'name' => 'ProductKey',
'in' => 'query',
'schema' => [
'type' => 'string',
'required' => false,
],
],
[
'name' => 'DeviceName',
'in' => 'query',
'schema' => [
'type' => 'string',
'required' => false,
],
],
[
'name' => 'IotId',
'in' => 'query',
'schema' => [
'type' => 'string',
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => [
'type' => 'string',
],
'ErrorMessage' => [
'type' => 'string',
],
'RequestId' => [
'type' => 'string',
],
'Success' => [
'type' => 'boolean',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'iot.vision.RequestParamError',
'errorMessage' => 'Request parameter error.',
],
[
'errorCode' => 'iot.vision.RequestFailed',
'errorMessage' => 'Request failed.',
],
[
'errorCode' => 'iot.vision.UnexpectedInternalError',
'errorMessage' => 'Unexpected internal error.',
],
[
'errorCode' => 'iot.vision.DeviceNoOwner',
'errorMessage' => 'Device has no owner.',
],
[
'errorCode' => 'iot.vision.FreeStorageQuotaLimit',
'errorMessage' => 'No enough free storage quota or exceed limit.',
],
[
'errorCode' => 'iot.vision.InvalidStorageCommodity',
'errorMessage' => 'Invalid storage commodity.',
],
[
'errorCode' => 'iot.vision.DeviceNotExist',
'errorMessage' => 'Device not exist.',
],
[
'errorCode' => 'iot.vision.GetDeviceInfoFailed',
'errorMessage' => 'Get device info failed.',
],
],
403 => [
[
'errorCode' => 'iot.vision.RequestAuthFailed',
'errorMessage' => 'Request auth failed.',
],
[
'errorCode' => 'iot.vision.RequestForbidden',
'errorMessage' => 'Request forbidden.',
],
],
429 => [
[
'errorCode' => 'iot.vision.RequestTrafficControl',
'errorMessage' => 'Request traffic control.',
],
],
],
],
'ConsumeFreeStorage' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [],
'parameters' => [
[
'name' => 'EventRecordProlong',
'in' => 'query',
'schema' => [
'type' => 'boolean',
'required' => false,
'default' => 'false',
],
],
[
'name' => 'EventRecordDuration',
'in' => 'query',
'schema' => [
'type' => 'integer',
'format' => 'int32',
'required' => false,
'maximum' => '30',
'minimum' => '0',
'default' => '10',
],
],
[
'name' => 'ImmediateUse',
'in' => 'query',
'schema' => [
'type' => 'boolean',
'required' => false,
'default' => 'false',
],
],
[
'name' => 'ProductKey',
'in' => 'query',
'schema' => [
'type' => 'string',
'required' => false,
],
],
[
'name' => 'DeviceName',
'in' => 'query',
'schema' => [
'type' => 'string',
'required' => false,
],
],
[
'name' => 'IotId',
'in' => 'query',
'schema' => [
'type' => 'string',
'required' => false,
],
],
[
'name' => 'EnableDefaultPlan',
'in' => 'query',
'schema' => [
'type' => 'boolean',
'required' => false,
'default' => 'false',
],
],
[
'name' => 'PreRecordDuration',
'in' => 'query',
'schema' => [
'type' => 'integer',
'format' => 'int32',
'required' => false,
'maximum' => '5',
'minimum' => '0',
'default' => '0',
],
],
[
'name' => 'Quota',
'in' => 'query',
'schema' => [
'type' => 'integer',
'format' => 'int32',
'required' => false,
'maximum' => '100',
'minimum' => '1',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => [
'type' => 'string',
],
'ErrorMessage' => [
'type' => 'string',
],
'RequestId' => [
'type' => 'string',
],
'Success' => [
'type' => 'boolean',
],
'Data' => [
'type' => 'object',
'properties' => [
'EndTime' => [
'type' => 'string',
],
'Type' => [
'type' => 'integer',
'format' => 'int32',
],
'StartTime' => [
'type' => 'string',
],
'EndTimeUTC' => [
'type' => 'string',
],
'Months' => [
'type' => 'integer',
'format' => 'int32',
],
'Expired' => [
'type' => 'integer',
'format' => 'int32',
],
'RemainQuota' => [
'type' => 'integer',
'format' => 'int32',
],
'StartTimeUTC' => [
'type' => 'string',
],
'Consumed' => [
'type' => 'integer',
'format' => 'int32',
],
'Lifecycle' => [
'type' => 'integer',
'format' => 'int32',
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'iot.vision.RequestParamError',
'errorMessage' => 'Request parameter error.',
],
[
'errorCode' => 'iot.vision.RequestFailed',
'errorMessage' => 'Request failed.',
],
[
'errorCode' => 'iot.vision.UnexpectedInternalError',
'errorMessage' => 'Unexpected internal error.',
],
[
'errorCode' => 'iot.vision.DeviceNoOwner',
'errorMessage' => 'Device has no owner.',
],
[
'errorCode' => 'iot.vision.FreeStorageQuotaLimit',
'errorMessage' => 'No enough free storage quota or exceed limit.',
],
[
'errorCode' => 'iot.vision.GetOwnerIdentityInfoFailed',
'errorMessage' => 'Get owner identity info failed.',
],
[
'errorCode' => 'iot.vision.GetDeviceInfoFailed',
'errorMessage' => 'Get device info failed.',
],
[
'errorCode' => 'iot.vision.StorageOrderGetLockFailed',
'errorMessage' => 'Get storage order lock failed try again later.',
],
[
'errorCode' => 'iot.vision.SetDefaultRecordPlanFailed',
'errorMessage' => 'Set default record plan failed.',
],
[
'errorCode' => 'iot.vision.DeviceNotExist',
'errorMessage' => 'Device not exist.',
],
],
403 => [
[
'errorCode' => 'iot.vision.RequestAuthFailed',
'errorMessage' => 'Request auth failed.',
],
[
'errorCode' => 'iot.vision.RequestForbidden',
'errorMessage' => 'Request forbidden.',
],
],
429 => [
[
'errorCode' => 'iot.vision.RequestTrafficControl',
'errorMessage' => 'Request traffic control.',
],
],
],
],
'CreateAndPayStorageOrder' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [],
'parameters' => [
[
'name' => 'DeviceNoOwner',
'in' => 'query',
'schema' => [
'type' => 'boolean',
'required' => false,
'default' => 'false',
],
],
[
'name' => 'EventRecordDuration',
'in' => 'query',
'schema' => [
'type' => 'integer',
'format' => 'int32',
'required' => false,
'maximum' => '30',
'minimum' => '0',
'default' => '10',
],
],
[
'name' => 'ProductKey',
'in' => 'query',
'schema' => [
'type' => 'string',
'required' => false,
],
],
[
'name' => 'DeviceName',
'in' => 'query',
'schema' => [
'type' => 'string',
'required' => false,
],
],
[
'name' => 'Copies',
'in' => 'query',
'schema' => [
'type' => 'integer',
'format' => 'int32',
'required' => true,
'maximum' => '100',
'minimum' => '1',
],
],
[
'name' => 'CommodityCode',
'in' => 'query',
'schema' => [
'type' => 'string',
'required' => true,
],
],
[
'name' => 'EventRecordProlong',
'in' => 'query',
'schema' => [
'type' => 'boolean',
'required' => false,
'default' => 'false',
],
],
[
'name' => 'Specification',
'in' => 'query',
'schema' => [
'type' => 'string',
'required' => true,
],
],
[
'name' => 'ImmediateUse',
'in' => 'query',
'schema' => [
'type' => 'boolean',
'required' => false,
'default' => 'false',
],
],
[
'name' => 'UserName',
'in' => 'query',
'schema' => [
'type' => 'string',
'required' => false,
],
],
[
'name' => 'UserId',
'in' => 'query',
'schema' => [
'type' => 'string',
'required' => false,
],
],
[
'name' => 'MaxRecordFileDuration',
'in' => 'query',
'schema' => [
'type' => 'integer',
'format' => 'int32',
'required' => false,
'maximum' => '3600',
'minimum' => '600',
'default' => '1800',
],
],
[
'name' => 'IotId',
'in' => 'query',
'schema' => [
'type' => 'string',
'required' => false,
],
],
[
'name' => 'EnableDefaultPlan',
'in' => 'query',
'schema' => [
'type' => 'boolean',
'required' => false,
'default' => 'false',
],
],
[
'name' => 'PreRecordDuration',
'in' => 'query',
'schema' => [
'type' => 'integer',
'format' => 'int32',
'required' => false,
'maximum' => '5',
'minimum' => '0',
'default' => '0',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => [
'type' => 'string',
],
'ErrorMessage' => [
'type' => 'string',
],
'RequestId' => [
'type' => 'string',
],
'Success' => [
'type' => 'boolean',
],
'Data' => [
'type' => 'object',
'properties' => [
'Status' => [
'type' => 'integer',
'format' => 'int32',
],
'Copies' => [
'type' => 'integer',
'format' => 'int32',
],
'Specification' => [
'type' => 'string',
],
'RecordType' => [
'type' => 'integer',
'format' => 'int32',
],
'CommodityCode' => [
'type' => 'string',
],
'PreConsume' => [
'type' => 'integer',
'format' => 'int32',
],
'EndTimeUTC' => [
'type' => 'string',
],
'UserId' => [
'type' => 'string',
],
'IdentityId' => [
'type' => 'string',
],
'StartTimeUTC' => [
'type' => 'string',
],
'EndTime' => [
'type' => 'string',
],
'StartTime' => [
'type' => 'string',
],
'OutOrderNo' => [
'type' => 'string',
],
'Price' => [
'type' => 'string',
],
'OrderType' => [
'type' => 'integer',
'format' => 'int32',
],
'PaymentStatus' => [
'type' => 'integer',
'format' => 'int32',
],
'UserName' => [
'type' => 'string',
],
'OrderId' => [
'type' => 'string',
],
'IotId' => [
'type' => 'string',
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'iot.vision.RequestParamError',
'errorMessage' => 'Request parameter error.',
],
[
'errorCode' => 'iot.vision.RequestFailed',
'errorMessage' => 'Request failed.',
],
[
'errorCode' => 'iot.vision.UnexpectedInternalError',
'errorMessage' => 'Unexpected internal error.',
],
[
'errorCode' => 'iot.vision.DeviceNoOwner',
'errorMessage' => 'Device has no owner.',
],
[
'errorCode' => 'iot.vision.CreateStorageOrderFailed',
'errorMessage' => 'Create storage order failed.',
],
[
'errorCode' => 'iot.vision.GetDeviceInfoFailed',
'errorMessage' => 'Get device info failed.',
],
[
'errorCode' => 'iot.vision.InvalidStorageCommodity',
'errorMessage' => 'Invalid storage commodity.',
],
[
'errorCode' => 'iot.vision.StorageCommodityUnavailable',
'errorMessage' => 'Storage commodity unavailable.',
],
[
'errorCode' => 'iot.vision.GetOwnerIdentityInfoFailed',
'errorMessage' => 'Get owner identity info failed.',
],
[
'errorCode' => 'iot.vision.SetDefaultRecordPlanFailed',
'errorMessage' => 'Set default record plan failed.',
],
[
'errorCode' => 'iot.vision.QueryCommodityPriceFailed',
'errorMessage' => 'Query commodity price failed.',
],
[
'errorCode' => 'iot.vision.StorageOrderGetLockFailed',
'errorMessage' => 'Get storage order lock failed try again later.',
],
[
'errorCode' => 'iot.vision.InvalidStorageOrder',
'errorMessage' => 'Invalid storage order.',
],
[
'errorCode' => 'iot.vision.StorageOrderAlreadyPaid',
'errorMessage' => 'Storage order had been paid.',
],
[
'errorCode' => 'iot.vision.StorageOrderPayFailed',
'errorMessage' => 'Storage order pay failed.',
],
[
'errorCode' => 'iot.vision.DeviceNotExist',
'errorMessage' => 'Device not exist.',
],
],
403 => [
[
'errorCode' => 'iot.vision.RequestAuthFailed',
'errorMessage' => 'Request auth failed.',
],
[
'errorCode' => 'iot.vision.RequestForbidden',
'errorMessage' => 'Request forbidden.',
],
],
429 => [
[
'errorCode' => 'iot.vision.RequestTrafficControl',
'errorMessage' => 'Request traffic control.',
],
],
],
],
'EnableFreeStorage' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [],
'parameters' => [
[
'name' => 'ProductKey',
'in' => 'query',
'schema' => [
'type' => 'string',
'required' => false,
],
],
[
'name' => 'DeviceName',
'in' => 'query',
'schema' => [
'type' => 'string',
'required' => false,
],
],
[
'name' => 'IotId',
'in' => 'query',
'schema' => [
'type' => 'string',
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => [
'type' => 'string',
],
'ErrorMessage' => [
'type' => 'string',
],
'RequestId' => [
'type' => 'string',
],
'Success' => [
'type' => 'boolean',
],
'Data' => [
'type' => 'object',
'properties' => [
'EndTime' => [
'type' => 'string',
],
'Type' => [
'type' => 'integer',
'format' => 'int32',
],
'StartTime' => [
'type' => 'string',
],
'EndTimeUTC' => [
'type' => 'string',
],
'Months' => [
'type' => 'integer',
'format' => 'int32',
],
'Expired' => [
'type' => 'integer',
'format' => 'int32',
],
'RemainQuota' => [
'type' => 'integer',
'format' => 'int32',
],
'StartTimeUTC' => [
'type' => 'string',
],
'Consumed' => [
'type' => 'integer',
'format' => 'int32',
],
'Lifecycle' => [
'type' => 'integer',
'format' => 'int32',
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'iot.vision.RequestParamError',
'errorMessage' => 'Request parameter error.',
],
[
'errorCode' => 'iot.vision.RequestFailed',
'errorMessage' => 'Request failed.',
],
[
'errorCode' => 'iot.vision.UnexpectedInternalError',
'errorMessage' => 'Unexpected internal error.',
],
[
'errorCode' => 'iot.vision.DeviceNoOwner',
'errorMessage' => 'Device has no owner.',
],
[
'errorCode' => 'iot.vision.FreeStorageQuotaLimit',
'errorMessage' => 'No enough free storage quota or exceed limit.',
],
[
'errorCode' => 'iot.vision.StorageOrderGetLockFailed',
'errorMessage' => 'Get storage order lock failed try again later.',
],
[
'errorCode' => 'iot.vision.InvalidStorageOrder',
'errorMessage' => 'Invalid storage order.',
],
[
'errorCode' => 'iot.vision.DeviceNotExist',
'errorMessage' => 'Device not exist.',
],
],
403 => [
[
'errorCode' => 'iot.vision.RequestAuthFailed',
'errorMessage' => 'Request auth failed.',
],
[
'errorCode' => 'iot.vision.RequestForbidden',
'errorMessage' => 'Request forbidden.',
],
],
429 => [
[
'errorCode' => 'iot.vision.RequestTrafficControl',
'errorMessage' => 'Request traffic control.',
],
],
],
],
'EnableStorageOrder' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [],
'parameters' => [
[
'name' => 'OrderId',
'in' => 'query',
'schema' => [
'type' => 'string',
'required' => true,
],
],
[
'name' => 'ProductKey',
'in' => 'query',
'schema' => [
'type' => 'string',
'required' => false,
],
],
[
'name' => 'DeviceName',
'in' => 'query',
'schema' => [
'type' => 'string',
'required' => false,
],
],
[
'name' => 'IotId',
'in' => 'query',
'schema' => [
'type' => 'string',
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => [
'type' => 'string',
],
'ErrorMessage' => [
'type' => 'string',
],
'RequestId' => [
'type' => 'string',
],
'Success' => [
'type' => 'boolean',
],
'Data' => [
'type' => 'object',
'properties' => [
'Status' => [
'type' => 'integer',
'format' => 'int32',
],
'Copies' => [
'type' => 'integer',
'format' => 'int32',
],
'Specification' => [
'type' => 'string',
],
'RecordType' => [
'type' => 'integer',
'format' => 'int32',
],
'CommodityCode' => [
'type' => 'string',
],
'PreConsume' => [
'type' => 'integer',
'format' => 'int32',
],
'EndTimeUTC' => [
'type' => 'string',
],
'UserId' => [
'type' => 'string',
],
'IdentityId' => [
'type' => 'string',
],
'StartTimeUTC' => [
'type' => 'string',
],
'EndTime' => [
'type' => 'string',
],
'StartTime' => [
'type' => 'string',
],
'OutOrderNo' => [
'type' => 'string',
],
'Price' => [
'type' => 'string',
],
'OrderType' => [
'type' => 'integer',
'format' => 'int32',
],
'PaymentStatus' => [
'type' => 'integer',
'format' => 'int32',
],
'UserName' => [
'type' => 'string',
],
'OrderId' => [
'type' => 'string',
],
'IotId' => [
'type' => 'string',
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'iot.vision.RequestParamError',
'errorMessage' => 'Request parameter error.',
],
[
'errorCode' => 'iot.vision.RequestFailed',
'errorMessage' => 'Request failed.',
],
[
'errorCode' => 'iot.vision.UnexpectedInternalError',
'errorMessage' => 'Unexpected internal error.',
],
[
'errorCode' => 'iot.vision.DeviceNoOwner',
'errorMessage' => 'Device has no owner.',
],
[
'errorCode' => 'iot.vision.InvalidStorageOrder',
'errorMessage' => 'Invalid storage order.',
],
[
'errorCode' => 'iot.vision.DeviceOwnerChanged',
'errorMessage' => 'Device owner changed.',
],
[
'errorCode' => 'iot.vision.StorageOrderGetLockFailed',
'errorMessage' => 'Get storage order lock failed try again later.',
],
[
'errorCode' => 'iot.vision.StorageOrderStatusInvalid',
'errorMessage' => 'Storage order status invalid.',
],
[
'errorCode' => 'iot.vision.DeviceNotExist',
'errorMessage' => 'Device not exist.',
],
],
403 => [
[
'errorCode' => 'iot.vision.RequestAuthFailed',
'errorMessage' => 'Request auth failed.',
],
[
'errorCode' => 'iot.vision.RequestForbidden',
'errorMessage' => 'Request forbidden.',
],
],
429 => [
[
'errorCode' => 'iot.vision.RequestTrafficControl',
'errorMessage' => 'Request traffic control.',
],
],
],
],
'FreezeFreeStorage' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [],
'parameters' => [
[
'name' => 'ProductKey',
'in' => 'query',
'schema' => [
'type' => 'string',
'required' => false,
],
],
[
'name' => 'DeviceName',
'in' => 'query',
'schema' => [
'type' => 'string',
'required' => false,
],
],
[
'name' => 'IotId',
'in' => 'query',
'schema' => [
'type' => 'string',
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => [
'type' => 'string',
],
'ErrorMessage' => [
'type' => 'string',
],
'RequestId' => [
'type' => 'string',
],
'Success' => [
'type' => 'boolean',
],
'Data' => [
'type' => 'object',
'properties' => [
'EndTime' => [
'type' => 'string',
],
'Type' => [
'type' => 'integer',
'format' => 'int32',
],
'StartTime' => [
'type' => 'string',
],
'EndTimeUTC' => [
'type' => 'string',
],
'Months' => [
'type' => 'integer',
'format' => 'int32',
],
'Expired' => [
'type' => 'integer',
'format' => 'int32',
],
'RemainQuota' => [
'type' => 'integer',
'format' => 'int32',
],
'StartTimeUTC' => [
'type' => 'string',
],
'Consumed' => [
'type' => 'integer',
'format' => 'int32',
],
'Lifecycle' => [
'type' => 'integer',
'format' => 'int32',
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'iot.vision.RequestParamError',
'errorMessage' => 'Request parameter error.',
],
[
'errorCode' => 'iot.vision.RequestFailed',
'errorMessage' => 'Request failed.',
],
[
'errorCode' => 'iot.vision.UnexpectedInternalError',
'errorMessage' => 'Unexpected internal error.',
],
[
'errorCode' => 'iot.vision.DeviceNoOwner',
'errorMessage' => 'Device has no owner.',
],
[
'errorCode' => 'iot.vision.FreeStorageQuotaLimit',
'errorMessage' => 'No enough free storage quota or exceed limit.',
],
[
'errorCode' => 'iot.vision.StorageOrderGetLockFailed',
'errorMessage' => 'Get storage order lock failed try again later.',
],
[
'errorCode' => 'iot.vision.InvalidStorageOrder',
'errorMessage' => 'Invalid storage order.',
],
[
'errorCode' => 'iot.vision.DeviceNotExist',
'errorMessage' => 'Device not exist.',
],
],
403 => [
[
'errorCode' => 'iot.vision.RequestAuthFailed',
'errorMessage' => 'Request auth failed.',
],
[
'errorCode' => 'iot.vision.RequestForbidden',
'errorMessage' => 'Request forbidden.',
],
],
429 => [
[
'errorCode' => 'iot.vision.RequestTrafficControl',
'errorMessage' => 'Request traffic control.',
],
],
],
],
'GenerateDevice' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [],
'parameters' => [
[
'name' => 'Amount',
'in' => 'query',
'schema' => [
'type' => 'integer',
'format' => 'int64',
'required' => true,
'maximum' => '10000',
'minimum' => '1',
],
],
[
'name' => 'ProductKey',
'in' => 'query',
'schema' => [
'type' => 'string',
'required' => true,
],
],
[
'name' => 'ProjectId',
'in' => 'query',
'schema' => [
'type' => 'string',
'required' => true,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => [
'type' => 'string',
],
'ErrorMessage' => [
'type' => 'string',
],
'RequestId' => [
'type' => 'string',
],
'Success' => [
'type' => 'boolean',
],
'Data' => [
'type' => 'object',
'properties' => [
'BatchId' => [
'type' => 'string',
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'iot.vision.RequestParamError',
'errorMessage' => 'Request parameter error.',
],
[
'errorCode' => 'iot.vision.UnexpectedInternalError',
'errorMessage' => 'Unexpected internal error.',
],
[
'errorCode' => 'iot.vision.ActiveCodeInsufficient',
'errorMessage' => 'Active code quota is insufficient.',
],
[
'errorCode' => 'iot.vision.DevicesCountExceedLimit',
'errorMessage' => 'The devices count exceed the limit.',
],
[
'errorCode' => 'iot.vision.DevicesExceedUnreleasedProductLimit',
'errorMessage' => 'Devices count exceed the limit of unreleased product.',
],
],
403 => [
[
'errorCode' => 'iot.vision.RequestAuthFailed',
'errorMessage' => 'Request auth failed.',
],
[
'errorCode' => 'iot.vision.RequestForbidden',
'errorMessage' => 'Request forbidden.',
],
],
429 => [
[
'errorCode' => 'iot.vision.RequestTrafficControl',
'errorMessage' => 'Request traffic control.',
],
],
],
],
'FreezeStorageOrder' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [],
'parameters' => [
[
'name' => 'DeviceNoOwner',
'in' => 'query',
'schema' => [
'type' => 'boolean',
'required' => false,
'default' => 'false',
],
],
[
'name' => 'OrderId',
'in' => 'query',
'schema' => [
'type' => 'string',
'required' => true,
],
],
[
'name' => 'ProductKey',
'in' => 'query',
'schema' => [
'type' => 'string',
'required' => false,
],
],
[
'name' => 'DeviceName',
'in' => 'query',
'schema' => [
'type' => 'string',
'required' => false,
],
],
[
'name' => 'IotId',
'in' => 'query',
'schema' => [
'type' => 'string',
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => [
'type' => 'string',
],
'ErrorMessage' => [
'type' => 'string',
],
'RequestId' => [
'type' => 'string',
],
'Success' => [
'type' => 'boolean',
],
'Data' => [
'type' => 'object',
'properties' => [
'Status' => [
'type' => 'integer',
'format' => 'int32',
],
'Copies' => [
'type' => 'integer',
'format' => 'int32',
],
'Specification' => [
'type' => 'string',
],
'RecordType' => [
'type' => 'integer',
'format' => 'int32',
],
'CommodityCode' => [
'type' => 'string',
],
'PreConsume' => [
'type' => 'integer',
'format' => 'int32',
],
'EndTimeUTC' => [
'type' => 'string',
],
'UserId' => [
'type' => 'string',
],
'IdentityId' => [
'type' => 'string',
],
'StartTimeUTC' => [
'type' => 'string',
],
'EndTime' => [
'type' => 'string',
],
'StartTime' => [
'type' => 'string',
],
'OutOrderNo' => [
'type' => 'string',
],
'Price' => [
'type' => 'string',
],
'OrderType' => [
'type' => 'integer',
'format' => 'int32',
],
'PaymentStatus' => [
'type' => 'integer',
'format' => 'int32',
],
'UserName' => [
'type' => 'string',
],
'OrderId' => [
'type' => 'string',
],
'IotId' => [
'type' => 'string',
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'iot.vision.RequestParamError',
'errorMessage' => 'Request parameter error.',
],
[
'errorCode' => 'iot.vision.RequestFailed',
'errorMessage' => 'Request failed.',
],
[
'errorCode' => 'iot.vision.UnexpectedInternalError',
'errorMessage' => 'Unexpected internal error.',
],
[
'errorCode' => 'iot.vision.DeviceNoOwner',
'errorMessage' => 'Device has no owner.',
],
[
'errorCode' => 'iot.vision.DeviceOwnerChanged',
'errorMessage' => 'Device owner changed.',
],
[
'errorCode' => 'iot.vision.InvalidStorageOrder',
'errorMessage' => 'Invalid storage order.',
],
[
'errorCode' => 'iot.vision.StorageOrderGetLockFailed',
'errorMessage' => 'Get storage order lock failed try again later.',
],
[
'errorCode' => 'iot.vision.DeviceNotExist',
'errorMessage' => 'Device not exist.',
],
],
403 => [
[
'errorCode' => 'iot.vision.RequestAuthFailed',
'errorMessage' => 'Request auth failed.',
],
[
'errorCode' => 'iot.vision.RequestForbidden',
'errorMessage' => 'Request forbidden.',
],
],
429 => [
[
'errorCode' => 'iot.vision.RequestTrafficControl',
'errorMessage' => 'Request traffic control.',
],
],
],
],
'GenerateDeviceByBatchId' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [],
'parameters' => [
[
'name' => 'BatchId',
'in' => 'query',
'schema' => [
'type' => 'string',
'required' => true,
],
],
[
'name' => 'ProductKey',
'in' => 'query',
'schema' => [
'type' => 'string',
'required' => true,
],
],
[
'name' => 'ProjectId',
'in' => 'query',
'schema' => [
'type' => 'string',
'required' => true,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => [
'type' => 'string',
],
'ErrorMessage' => [
'type' => 'string',
],
'RequestId' => [
'type' => 'string',
],
'Success' => [
'type' => 'boolean',
],
'Data' => [
'type' => 'object',
'properties' => [
'BatchId' => [
'type' => 'string',
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'iot.vision.RequestParamError',
'errorMessage' => 'Request parameter error.',
],
[
'errorCode' => 'iot.vision.UnexpectedInternalError',
'errorMessage' => 'Unexpected internal error.',
],
[
'errorCode' => 'iot.vision.ParamBatchIdInvalid',
'errorMessage' => 'Parameter batchId is invalid.',
],
[
'errorCode' => 'iot.vision.BatchHasCreated',
'errorMessage' => 'This batch task has been created.',
],
[
'errorCode' => 'iot.vision.DeviceNameChecking',
'errorMessage' => 'Device names are checking.',
],
[
'errorCode' => 'iot.vision.DeviceNameCheckFailed',
'errorMessage' => 'Device names check failed.',
],
[
'errorCode' => 'iot.vision.ActiveCodeInsufficient',
'errorMessage' => 'Active code quota is insufficient.',
],
[
'errorCode' => 'iot.vision.DevicesCountExceedLimit',
'errorMessage' => 'The devices count exceed the limit.',
],
[
'errorCode' => 'iot.vision.DevicesExceedUnreleasedProductLimit',
'errorMessage' => 'Devices count exceed the limit of unreleased product.',
],
],
403 => [
[
'errorCode' => 'iot.vision.RequestAuthFailed',
'errorMessage' => 'Request auth failed.',
],
[
'errorCode' => 'iot.vision.RequestForbidden',
'errorMessage' => 'Request forbidden.',
],
],
429 => [
[
'errorCode' => 'iot.vision.RequestTrafficControl',
'errorMessage' => 'Request traffic control.',
],
],
],
],
'QueryBatchStatus' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [],
'parameters' => [
[
'name' => 'BatchId',
'in' => 'query',
'schema' => [
'type' => 'string',
'required' => true,
],
],
[
'name' => 'ProductKey',
'in' => 'query',
'schema' => [
'type' => 'string',
'required' => true,
],
],
[
'name' => 'ProjectId',
'in' => 'query',
'schema' => [
'type' => 'string',
'required' => true,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => [
'type' => 'string',
],
'ErrorMessage' => [
'type' => 'string',
],
'RequestId' => [
'type' => 'string',
],
'Success' => [
'type' => 'boolean',
],
'Data' => [
'type' => 'object',
'properties' => [
'Status' => [
'type' => 'string',
],
'InvalidDetailList' => [
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'DeviceName' => [
'type' => 'string',
],
'ErrorMsg' => [
'type' => 'string',
],
],
],
],
'InvalidList' => [
'type' => 'array',
'items' => [
'type' => 'string',
],
],
'ValidList' => [
'type' => 'array',
'items' => [
'type' => 'string',
],
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'iot.vision.RequestParamError',
'errorMessage' => 'Request parameter error.',
],
[
'errorCode' => 'iot.vision.UnexpectedInternalError',
'errorMessage' => 'Unexpected internal error.',
],
],
403 => [
[
'errorCode' => 'iot.vision.RequestAuthFailed',
'errorMessage' => 'Request auth failed.',
],
[
'errorCode' => 'iot.vision.RequestForbidden',
'errorMessage' => 'Request forbidden.',
],
],
429 => [
[
'errorCode' => 'iot.vision.RequestTrafficControl',
'errorMessage' => 'Request traffic control.',
],
],
],
],
'QueryDeviceDetail' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [],
'parameters' => [
[
'name' => 'ProductKey',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'a1Bw******',
],
],
[
'name' => 'DeviceName',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'Device01',
],
],
[
'name' => 'IotId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'C47T6xwp6ms4bNlkHRWCg4****',
],
],
[
'name' => 'ProjectId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'a123qs*****sy4QU',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => [
'description' => '',
'type' => 'string',
'example' => '400',
],
'ErrorMessage' => [
'description' => '',
'type' => 'string',
'example' => 'Request parameter error.',
],
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => 'E55***B7-4***-4***-8***-D3******F565',
],
'Success' => [
'description' => '',
'type' => 'boolean',
'example' => 'true',
],
'Data' => [
'description' => '',
'type' => 'object',
'properties' => [
'Status' => [
'description' => '',
'type' => 'string',
'example' => 'ONLINE',
],
'ProductName' => [
'description' => '',
'type' => 'string',
'example' => 'test',
],
'DeviceName' => [
'description' => '',
'type' => 'string',
'example' => 'Device01',
],
'CreateTime' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '1834500000000',
],
'FirmwareVersion' => [
'description' => '',
'type' => 'string',
'example' => 'V1.0.0.0',
],
'OnlineTime' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '2298700000000',
],
'ActiveTime' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '1934500000000',
],
'ProductKey' => [
'description' => '',
'type' => 'string',
'example' => 'a1Bw******',
],
'IpAddress' => [
'description' => '',
'type' => 'string',
'example' => '10.***.***.***',
],
'NodeType' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '0',
],
'Region' => [
'description' => '',
'type' => 'string',
'example' => 'cn-shanghai',
],
'DeviceSecret' => [
'description' => '',
'type' => 'string',
'example' => 'mz2Canp4GB7qRVf1OYPNtRqB2anu****',
],
'Nickname' => [
'description' => '',
'type' => 'string',
'example' => 'detectors_in_beijing',
],
'IotId' => [
'description' => '',
'type' => 'string',
'example' => 'C47T6xwp6ms4bNlkHRWCg4****',
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'iot.vision.RequestParamError',
'errorMessage' => 'Request parameter error.',
],
[
'errorCode' => 'iot.vision.UnexpectedInternalError',
'errorMessage' => 'Unexpected internal error.',
],
[
'errorCode' => 'iot.vision.RequestFailed',
'errorMessage' => 'Request failed.',
],
[
'errorCode' => 'iot.vision.InvalidIotInstance',
'errorMessage' => 'Invalid iot instance.',
],
[
'errorCode' => 'iot.vision.DeviceNotExist',
'errorMessage' => 'Device not exist.',
],
[
'errorCode' => 'iot.vision.ProductNotExist',
'errorMessage' => 'Product not exist.',
],
[
'errorCode' => 'iot.vision.DeviceNameFormatInvalid',
'errorMessage' => 'Device name format invalid.',
],
[
'errorCode' => 'iot.vision.InstanceArrearage',
'errorMessage' => 'Instance arrearage.',
],
[
'errorCode' => 'iot.vision.ProductKeyFormatInvalid',
'errorMessage' => 'Product key format invalid.',
],
],
403 => [
[
'errorCode' => 'iot.vision.RequestAuthFailed',
'errorMessage' => 'Request auth failed.',
],
[
'errorCode' => 'iot.vision.RequestForbidden',
'errorMessage' => 'Request forbidden.',
],
[
'errorCode' => 'iot.vision.HasNoAccessPermission',
'errorMessage' => 'Has no access permission.',
],
],
429 => [
[
'errorCode' => 'iot.vision.RequestTrafficControl',
'errorMessage' => 'Request traffic control.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"400\\",\\n \\"ErrorMessage\\": \\"Request parameter error.\\",\\n \\"RequestId\\": \\"E55***B7-4***-4***-8***-D3******F565\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"Status\\": \\"ONLINE\\",\\n \\"ProductName\\": \\"test\\",\\n \\"DeviceName\\": \\"Device01\\",\\n \\"CreateTime\\": 1834500000000,\\n \\"FirmwareVersion\\": \\"V1.0.0.0\\",\\n \\"OnlineTime\\": 2298700000000,\\n \\"ActiveTime\\": 1934500000000,\\n \\"ProductKey\\": \\"a1Bw******\\",\\n \\"IpAddress\\": \\"10.***.***.***\\",\\n \\"NodeType\\": 0,\\n \\"Region\\": \\"cn-shanghai\\",\\n \\"DeviceSecret\\": \\"mz2Canp4GB7qRVf1OYPNtRqB2anu****\\",\\n \\"Nickname\\": \\"detectors_in_beijing\\",\\n \\"IotId\\": \\"C47T6xwp6ms4bNlkHRWCg4****\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\nE55***B7-4***-4***-8***-D3******F565\\n\\n ONLINE\\n test\\n mz2Canp4GB7qRVf1OYPNtRqB2anu****\\n 1834500000000\\n 2298700000000\\n V1.0.0.0\\n C47T6xwp6ms4bNlkHRWCg4****\\n 1934500000000\\n 0\\n cn-shanghai\\n 10.***.***.***\\n a1Bw******\\n detectors_in_beijing\\n Device01\\n\\ntrue\\n","errorExample":""}]',
'title' => 'QueryDeviceDetail',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'QueryFreeStorage' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [],
'parameters' => [
[
'name' => 'ProductKey',
'in' => 'query',
'schema' => [
'type' => 'string',
'required' => false,
],
],
[
'name' => 'DeviceName',
'in' => 'query',
'schema' => [
'type' => 'string',
'required' => false,
],
],
[
'name' => 'IotId',
'in' => 'query',
'schema' => [
'type' => 'string',
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => [
'type' => 'string',
],
'ErrorMessage' => [
'type' => 'string',
],
'RequestId' => [
'type' => 'string',
],
'Success' => [
'type' => 'boolean',
],
'Data' => [
'type' => 'object',
'properties' => [
'EndTime' => [
'type' => 'string',
],
'Type' => [
'type' => 'integer',
'format' => 'int32',
],
'StartTime' => [
'type' => 'string',
],
'EndTimeUTC' => [
'type' => 'string',
],
'Months' => [
'type' => 'integer',
'format' => 'int32',
],
'Expired' => [
'type' => 'integer',
'format' => 'int32',
],
'RemainQuota' => [
'type' => 'integer',
'format' => 'int32',
],
'StartTimeUTC' => [
'type' => 'string',
],
'Consumed' => [
'type' => 'integer',
'format' => 'int32',
],
'Lifecycle' => [
'type' => 'integer',
'format' => 'int32',
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'iot.vision.RequestParamError',
'errorMessage' => 'Request parameter error.',
],
[
'errorCode' => 'iot.vision.RequestFailed',
'errorMessage' => 'Request failed.',
],
[
'errorCode' => 'iot.vision.UnexpectedInternalError',
'errorMessage' => 'Unexpected internal error.',
],
[
'errorCode' => 'iot.vision.DeviceNoOwner',
'errorMessage' => 'Device has no owner.',
],
[
'errorCode' => 'iot.vision.FreeStorageQuotaLimit',
'errorMessage' => 'No enough free storage quota or exceed limit.',
],
[
'errorCode' => 'iot.vision.GetDeviceInfoFailed',
'errorMessage' => 'Get device info failed.',
],
[
'errorCode' => 'iot.vision.StorageOrderGetLockFailed',
'errorMessage' => 'Get storage order lock failed try again later.',
],
[
'errorCode' => 'iot.vision.DeviceNotExist',
'errorMessage' => 'Device not exist.',
],
],
403 => [
[
'errorCode' => 'iot.vision.RequestAuthFailed',
'errorMessage' => 'Request auth failed.',
],
[
'errorCode' => 'iot.vision.RequestForbidden',
'errorMessage' => 'Request forbidden.',
],
],
429 => [
[
'errorCode' => 'iot.vision.RequestTrafficControl',
'errorMessage' => 'Request traffic control.',
],
],
],
],
'QueryDevicesDownloadUrl' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [],
'parameters' => [
[
'name' => 'ProductKey',
'in' => 'query',
'schema' => [
'type' => 'string',
'required' => true,
],
],
[
'name' => 'BatchId',
'in' => 'query',
'schema' => [
'type' => 'string',
'required' => true,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => [
'type' => 'string',
],
'ErrorMessage' => [
'type' => 'string',
],
'RequestId' => [
'type' => 'string',
],
'Success' => [
'type' => 'boolean',
],
'Data' => [
'type' => 'object',
'properties' => [
'OssDownloadUrl' => [
'type' => 'string',
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'iot.system.SystemException',
'errorMessage' => 'An internal error occurred. Try again later.',
],
[
'errorCode' => 'iot.common.AuthActionPermissionDeny',
'errorMessage' => 'The authorization fails.',
],
],
403 => [
[
'errorCode' => 'iot.lv.requestAuthError',
'errorMessage' => 'Request auth error.',
],
[
'errorCode' => 'iot.lv.requestParamError',
'errorMessage' => 'Request parameter error.',
],
],
],
],
'QueryGenerateDevicesInfoList' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [],
'parameters' => [
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'type' => 'integer',
'format' => 'int32',
'required' => true,
'maximum' => '50',
'minimum' => '1',
],
],
[
'name' => 'BatchId',
'in' => 'query',
'schema' => [
'type' => 'string',
'required' => true,
],
],
[
'name' => 'PageNo',
'in' => 'query',
'schema' => [
'type' => 'integer',
'format' => 'int32',
'required' => true,
'maximum' => '1000',
'minimum' => '1',
],
],
[
'name' => 'ProjectId',
'in' => 'query',
'schema' => [
'type' => 'string',
'required' => true,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => [
'type' => 'string',
],
'ErrorMessage' => [
'type' => 'string',
],
'RequestId' => [
'type' => 'string',
],
'Success' => [
'type' => 'boolean',
],
'Data' => [
'type' => 'object',
'properties' => [
'PageNo' => [
'type' => 'integer',
'format' => 'int32',
],
'PageSize' => [
'type' => 'integer',
'format' => 'int32',
],
'Total' => [
'type' => 'integer',
'format' => 'int32',
],
'ListData' => [
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'DeviceName' => [
'type' => 'string',
],
'IotId' => [
'type' => 'string',
],
'DeviceSecret' => [
'type' => 'string',
],
],
],
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'iot.vision.RequestParamError',
'errorMessage' => 'Request parameter error.',
],
[
'errorCode' => 'iot.vision.UnexpectedInternalError',
'errorMessage' => 'Unexpected internal error.',
],
[
'errorCode' => 'iot.common.RamActionPermissionDeny',
'errorMessage' => 'You do not have the RAM permission.',
],
[
'errorCode' => 'iot.vision.ProductNotExist',
'errorMessage' => 'Product not exist.',
],
],
403 => [
[
'errorCode' => 'iot.vision.RequestAuthFailed',
'errorMessage' => 'Request auth failed.',
],
[
'errorCode' => 'iot.vision.RequestForbidden',
'errorMessage' => 'Request forbidden.',
],
],
429 => [
[
'errorCode' => 'iot.vision.RequestTrafficControl',
'errorMessage' => 'Request traffic control.',
],
],
],
],
'QueryGenerateDevicesRecord' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [],
'parameters' => [
[
'name' => 'PageSize',
'in' => 'formData',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'maximum' => '100',
'minimum' => '1',
'example' => '1',
],
],
[
'name' => 'PageNo',
'in' => 'formData',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'maximum' => '1000',
'minimum' => '1',
'example' => '1',
],
],
[
'name' => 'StartTime',
'in' => 'formData',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'maximum' => '9999999999999',
'minimum' => '1',
'example' => '1690819200000',
],
],
[
'name' => 'EndTime',
'in' => 'formData',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'maximum' => '9999999999999',
'minimum' => '1',
'example' => '1659283200000',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => [
'description' => '',
'type' => 'string',
'example' => '400',
],
'ErrorMessage' => [
'description' => '',
'type' => 'string',
'example' => 'Request parameter error.',
],
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => 'E5******-4***-***B-8**E-D3********65',
],
'Success' => [
'description' => '',
'type' => 'boolean',
'example' => 'true',
],
'Data' => [
'description' => '',
'type' => 'object',
'properties' => [
'PageNo' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'PageSize' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'Total' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '5',
],
'ListData' => [
'description' => '',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'ApplyDeviceCount' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '133',
],
'SpecCode' => [
'description' => '',
'type' => 'string',
'example' => 'Consumer_IPC_512Kbps',
],
'ProductKey' => [
'description' => '',
'type' => 'string',
'example' => 'a3w******',
],
'ProductName' => [
'description' => '',
'type' => 'string',
'example' => '',
],
'CreateTime' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '1690819200000',
],
'BatchStatus' => [
'description' => '',
'type' => 'string',
'example' => 'CREATE',
],
'NetworkType' => [
'description' => '',
'type' => 'string',
'example' => 'WIFI',
],
'OperateUid' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '110000000000',
],
'SuccessCount' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '5',
],
'BatchId' => [
'description' => '',
'type' => 'string',
'example' => '1508******195',
],
],
],
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'iot.vision.RequestParamError',
'errorMessage' => 'Request parameter error.',
],
[
'errorCode' => 'iot.vision.UnexpectedInternalError',
'errorMessage' => 'Unexpected internal error.',
],
],
403 => [
[
'errorCode' => 'iot.vision.RequestAuthFailed',
'errorMessage' => 'Request auth failed.',
],
[
'errorCode' => 'iot.vision.RequestForbidden',
'errorMessage' => 'Request forbidden.',
],
],
429 => [
[
'errorCode' => 'iot.vision.RequestTrafficControl',
'errorMessage' => 'Request traffic control.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"400\\",\\n \\"ErrorMessage\\": \\"Request parameter error.\\",\\n \\"RequestId\\": \\"E5******-4***-***B-8**E-D3********65\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"PageNo\\": 1,\\n \\"PageSize\\": 1,\\n \\"Total\\": 5,\\n \\"ListData\\": [\\n {\\n \\"ApplyDeviceCount\\": 133,\\n \\"SpecCode\\": \\"Consumer_IPC_512Kbps\\",\\n \\"ProductKey\\": \\"a3w******\\",\\n \\"ProductName\\": \\"电é¥ç…²\\",\\n \\"CreateTime\\": 1690819200000,\\n \\"BatchStatus\\": \\"CREATE\\",\\n \\"NetworkType\\": \\"WIFI\\",\\n \\"OperateUid\\": 110000000000,\\n \\"SuccessCount\\": 5,\\n \\"BatchId\\": \\"1508******195\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\nE5******-4***-***B-8**E-D3********65\\n\\n 1\\n 5\\n 1\\n \\n Consumer_IPC_512Kbps\\n 110000000000\\n 电é¥ç…²\\n WIFI\\n CREATE\\n 1690819200000\\n 1508******195\\n 5\\n a3w******\\n 133\\n \\n\\n200\\ntrue\\n","errorExample":""}]',
'title' => 'QueryGenerateDevicesRecord',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'QueryStorageCommodityList' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [],
'parameters' => [],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => [
'type' => 'string',
],
'ErrorMessage' => [
'type' => 'string',
],
'RequestId' => [
'type' => 'string',
],
'Success' => [
'type' => 'boolean',
],
'Data' => [
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Specification' => [
'type' => 'string',
],
'CommodityCode' => [
'type' => 'string',
],
'RecordType' => [
'type' => 'integer',
'format' => 'int32',
],
'Price' => [
'type' => 'string',
],
'Months' => [
'type' => 'integer',
'format' => 'int32',
],
'CommodityName' => [
'type' => 'string',
],
'Lifecycle' => [
'type' => 'integer',
'format' => 'int32',
],
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'iot.vision.RequestParamError',
'errorMessage' => 'Request parameter error.',
],
[
'errorCode' => 'iot.vision.RequestFailed',
'errorMessage' => 'Request failed.',
],
[
'errorCode' => 'iot.vision.UnexpectedInternalError',
'errorMessage' => 'Unexpected internal error.',
],
],
403 => [
[
'errorCode' => 'iot.vision.RequestAuthFailed',
'errorMessage' => 'Request auth failed.',
],
[
'errorCode' => 'iot.vision.RequestForbidden',
'errorMessage' => 'Request forbidden.',
],
],
429 => [
[
'errorCode' => 'iot.vision.RequestTrafficControl',
'errorMessage' => 'Request traffic control.',
],
],
],
],
'QueryStorageOrder' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [],
'parameters' => [
[
'name' => 'DeviceNoOwner',
'in' => 'query',
'schema' => [
'type' => 'boolean',
'required' => false,
'default' => 'false',
],
],
[
'name' => 'OrderId',
'in' => 'query',
'schema' => [
'type' => 'string',
'required' => true,
],
],
[
'name' => 'ProductKey',
'in' => 'query',
'schema' => [
'type' => 'string',
'required' => false,
],
],
[
'name' => 'DeviceName',
'in' => 'query',
'schema' => [
'type' => 'string',
'required' => false,
],
],
[
'name' => 'IotId',
'in' => 'query',
'schema' => [
'type' => 'string',
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => [
'type' => 'string',
],
'ErrorMessage' => [
'type' => 'string',
],
'RequestId' => [
'type' => 'string',
],
'Success' => [
'type' => 'boolean',
],
'Data' => [
'type' => 'object',
'properties' => [
'Status' => [
'type' => 'integer',
'format' => 'int32',
],
'Copies' => [
'type' => 'integer',
'format' => 'int32',
],
'Specification' => [
'type' => 'string',
],
'RecordType' => [
'type' => 'integer',
'format' => 'int32',
],
'CommodityCode' => [
'type' => 'string',
],
'PreConsume' => [
'type' => 'integer',
'format' => 'int32',
],
'EndTimeUTC' => [
'type' => 'string',
],
'UserId' => [
'type' => 'string',
],
'IdentityId' => [
'type' => 'string',
],
'StartTimeUTC' => [
'type' => 'string',
],
'EndTime' => [
'type' => 'string',
],
'StartTime' => [
'type' => 'string',
],
'OutOrderNo' => [
'type' => 'string',
],
'Price' => [
'type' => 'string',
],
'OrderType' => [
'type' => 'integer',
'format' => 'int32',
],
'PaymentStatus' => [
'type' => 'integer',
'format' => 'int32',
],
'UserName' => [
'type' => 'string',
],
'OrderId' => [
'type' => 'string',
],
'IotId' => [
'type' => 'string',
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'iot.vision.RequestParamError',
'errorMessage' => 'Request parameter error.',
],
[
'errorCode' => 'iot.vision.RequestFailed',
'errorMessage' => 'Request failed.',
],
[
'errorCode' => 'iot.vision.UnexpectedInternalError',
'errorMessage' => 'Unexpected internal error.',
],
[
'errorCode' => 'iot.vision.DeviceNoOwner',
'errorMessage' => 'Device has no owner.',
],
[
'errorCode' => 'iot.vision.InvalidStorageOrder',
'errorMessage' => 'Invalid storage order.',
],
[
'errorCode' => 'iot.vision.DeviceOwnerChanged',
'errorMessage' => 'Device owner changed.',
],
[
'errorCode' => 'iot.vision.StorageOrderGetLockFailed',
'errorMessage' => 'Get storage order lock failed try again later.',
],
[
'errorCode' => 'iot.vision.DeviceNotExist',
'errorMessage' => 'Device not exist.',
],
],
403 => [
[
'errorCode' => 'iot.vision.RequestAuthFailed',
'errorMessage' => 'Request auth failed.',
],
[
'errorCode' => 'iot.vision.RequestForbidden',
'errorMessage' => 'Request forbidden.',
],
],
429 => [
[
'errorCode' => 'iot.vision.RequestTrafficControl',
'errorMessage' => 'Request traffic control.',
],
],
],
],
'QueryStorageOrderList' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [],
'parameters' => [
[
'name' => 'DeviceNoOwner',
'in' => 'query',
'schema' => [
'type' => 'boolean',
'required' => false,
'default' => 'false',
],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'type' => 'integer',
'format' => 'int32',
'required' => true,
'maximum' => '200',
'minimum' => '1',
],
],
[
'name' => 'ProductKey',
'in' => 'query',
'schema' => [
'type' => 'string',
'required' => false,
],
],
[
'name' => 'DeviceName',
'in' => 'query',
'schema' => [
'type' => 'string',
'required' => false,
],
],
[
'name' => 'IotId',
'in' => 'query',
'schema' => [
'type' => 'string',
'required' => false,
],
],
[
'name' => 'PageNo',
'in' => 'query',
'schema' => [
'type' => 'integer',
'format' => 'int32',
'required' => true,
'maximum' => '1000',
'minimum' => '1',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => [
'type' => 'string',
],
'ErrorMessage' => [
'type' => 'string',
],
'RequestId' => [
'type' => 'string',
],
'Success' => [
'type' => 'boolean',
],
'Data' => [
'type' => 'object',
'properties' => [
'PageNo' => [
'type' => 'integer',
'format' => 'int32',
],
'PageSize' => [
'type' => 'integer',
'format' => 'int32',
],
'Total' => [
'type' => 'integer',
'format' => 'int32',
],
'PageCount' => [
'type' => 'integer',
'format' => 'int32',
],
'StorageOrderList' => [
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Status' => [
'type' => 'integer',
'format' => 'int32',
],
'Copies' => [
'type' => 'integer',
'format' => 'int32',
],
'Specification' => [
'type' => 'string',
],
'RecordType' => [
'type' => 'integer',
'format' => 'int32',
],
'CommodityCode' => [
'type' => 'string',
],
'PreConsume' => [
'type' => 'integer',
'format' => 'int32',
],
'EndTimeUTC' => [
'type' => 'string',
],
'UserId' => [
'type' => 'string',
],
'IdentityId' => [
'type' => 'string',
],
'StartTimeUTC' => [
'type' => 'string',
],
'EndTime' => [
'type' => 'string',
],
'StartTime' => [
'type' => 'string',
],
'OutOrderNo' => [
'type' => 'string',
],
'Price' => [
'type' => 'string',
],
'OrderType' => [
'type' => 'integer',
'format' => 'int32',
],
'PaymentStatus' => [
'type' => 'integer',
'format' => 'int32',
],
'UserName' => [
'type' => 'string',
],
'OrderId' => [
'type' => 'string',
],
'IotId' => [
'type' => 'string',
],
],
],
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'iot.vision.RequestParamError',
'errorMessage' => 'Request parameter error.',
],
[
'errorCode' => 'iot.vision.RequestFailed',
'errorMessage' => 'Request failed.',
],
[
'errorCode' => 'iot.vision.UnexpectedInternalError',
'errorMessage' => 'Unexpected internal error.',
],
[
'errorCode' => 'iot.vision.DeviceNoOwner',
'errorMessage' => 'Device has no owner.',
],
[
'errorCode' => 'iot.vision.DeviceOwnerChanged',
'errorMessage' => 'Device owner changed.',
],
[
'errorCode' => 'iot.vision.StorageOrderGetLockFailed',
'errorMessage' => 'Get storage order lock failed try again later.',
],
[
'errorCode' => 'iot.vision.DeviceNotExist',
'errorMessage' => 'Device not exist.',
],
],
403 => [
[
'errorCode' => 'iot.vision.RequestAuthFailed',
'errorMessage' => 'Request auth failed.',
],
[
'errorCode' => 'iot.vision.RequestForbidden',
'errorMessage' => 'Request forbidden.',
],
],
429 => [
[
'errorCode' => 'iot.vision.RequestTrafficControl',
'errorMessage' => 'Request traffic control.',
],
],
],
],
'TransferStorageOrder' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [],
'parameters' => [
[
'name' => 'EventRecordDuration',
'in' => 'query',
'schema' => [
'type' => 'integer',
'format' => 'int32',
'required' => false,
'maximum' => '30',
'minimum' => '0',
'default' => '10',
],
],
[
'name' => 'DstIotId',
'in' => 'query',
'schema' => [
'type' => 'string',
'required' => true,
],
],
[
'name' => 'SupportCrossIdentityTransfer',
'in' => 'query',
'schema' => [
'type' => 'boolean',
'required' => false,
'default' => 'false',
],
],
[
'name' => 'SrcIotId',
'in' => 'query',
'schema' => [
'type' => 'string',
'required' => true,
],
],
[
'name' => 'SrcOrderId',
'in' => 'query',
'schema' => [
'type' => 'string',
'required' => true,
],
],
[
'name' => 'EventRecordProlong',
'in' => 'query',
'schema' => [
'type' => 'boolean',
'required' => false,
'default' => 'false',
],
],
[
'name' => 'ImmediateUse',
'in' => 'query',
'schema' => [
'type' => 'boolean',
'required' => false,
'default' => 'false',
],
],
[
'name' => 'UserName',
'in' => 'query',
'schema' => [
'type' => 'string',
'required' => false,
],
],
[
'name' => 'UserId',
'in' => 'query',
'schema' => [
'type' => 'string',
'required' => false,
],
],
[
'name' => 'EnableDefaultPlan',
'in' => 'query',
'schema' => [
'type' => 'boolean',
'required' => false,
'default' => 'false',
],
],
[
'name' => 'PreRecordDuration',
'in' => 'query',
'schema' => [
'type' => 'integer',
'format' => 'int32',
'required' => false,
'maximum' => '5',
'minimum' => '0',
'default' => '0',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => [
'type' => 'string',
],
'ErrorMessage' => [
'type' => 'string',
],
'RequestId' => [
'type' => 'string',
],
'Success' => [
'type' => 'boolean',
],
'Data' => [
'type' => 'object',
'properties' => [
'Status' => [
'type' => 'integer',
'format' => 'int32',
],
'Copies' => [
'type' => 'integer',
'format' => 'int32',
],
'Specification' => [
'type' => 'string',
],
'RecordType' => [
'type' => 'integer',
'format' => 'int32',
],
'CommodityCode' => [
'type' => 'string',
],
'PreConsume' => [
'type' => 'integer',
'format' => 'int32',
],
'EndTimeUTC' => [
'type' => 'string',
],
'UserId' => [
'type' => 'string',
],
'IdentityId' => [
'type' => 'string',
],
'StartTimeUTC' => [
'type' => 'string',
],
'EndTime' => [
'type' => 'string',
],
'StartTime' => [
'type' => 'string',
],
'OutOrderNo' => [
'type' => 'string',
],
'Price' => [
'type' => 'string',
],
'OrderType' => [
'type' => 'integer',
'format' => 'int32',
],
'PaymentStatus' => [
'type' => 'integer',
'format' => 'int32',
],
'UserName' => [
'type' => 'string',
],
'OrderId' => [
'type' => 'string',
],
'IotId' => [
'type' => 'string',
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'iot.vision.RequestParamError',
'errorMessage' => 'Request parameter error.',
],
[
'errorCode' => 'iot.vision.RequestFailed',
'errorMessage' => 'Request failed.',
],
[
'errorCode' => 'iot.vision.UnexpectedInternalError',
'errorMessage' => 'Unexpected internal error.',
],
[
'errorCode' => 'iot.vision.DeviceNoOwner',
'errorMessage' => 'Device has no owner.',
],
[
'errorCode' => 'iot.vision.DeviceOwnerChanged',
'errorMessage' => 'Device owner changed.',
],
[
'errorCode' => 'iot.vision.InvalidStorageOrder',
'errorMessage' => 'Invalid storage order.',
],
[
'errorCode' => 'iot.vision.StorageOrderGetLockFailed',
'errorMessage' => 'Get storage order lock failed try again later.',
],
[
'errorCode' => 'iot.vision.StorageOrderStatusInvalid',
'errorMessage' => 'Storage order status invalid.',
],
[
'errorCode' => 'iot.vision.TargetDeviceOwnerDifferent',
'errorMessage' => 'Target device owner is different.',
],
],
403 => [
[
'errorCode' => 'iot.vision.RequestAuthFailed',
'errorMessage' => 'Request auth failed.',
],
[
'errorCode' => 'iot.vision.RequestForbidden',
'errorMessage' => 'Request forbidden.',
],
],
429 => [
[
'errorCode' => 'iot.vision.RequestTrafficControl',
'errorMessage' => 'Request traffic control.',
],
],
],
],
'UploadDeviceNameList' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [],
'parameters' => [
[
'name' => 'DeviceNames',
'in' => 'formData',
'style' => 'repeatList',
'schema' => [
'type' => 'array',
'items' => [
'type' => 'string',
],
'required' => true,
'maxItems' => 10000,
],
],
[
'name' => 'ProductKey',
'in' => 'query',
'schema' => [
'type' => 'string',
'required' => true,
],
],
[
'name' => 'ProjectId',
'in' => 'query',
'schema' => [
'type' => 'string',
'required' => true,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => [
'type' => 'string',
],
'ErrorMessage' => [
'type' => 'string',
],
'RequestId' => [
'type' => 'string',
],
'Success' => [
'type' => 'boolean',
],
'Data' => [
'type' => 'object',
'properties' => [
'BatchId' => [
'type' => 'string',
],
'InvalidDetailList' => [
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'DeviceName' => [
'type' => 'string',
],
'ErrorMsg' => [
'type' => 'string',
],
],
],
],
'RepeatedDeviceNameList' => [
'type' => 'array',
'items' => [
'type' => 'string',
],
],
'InvalidDeviceNameList' => [
'type' => 'array',
'items' => [
'type' => 'string',
],
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'iot.vision.RequestParamError',
'errorMessage' => 'Request parameter error.',
],
[
'errorCode' => 'iot.vision.UnexpectedInternalError',
'errorMessage' => 'Unexpected internal error.',
],
[
'errorCode' => 'iot.vision.ActiveCodeInsufficient',
'errorMessage' => 'Active code quota is insufficient.',
],
[
'errorCode' => 'iot.vision.DevicesCountExceedLimit',
'errorMessage' => 'The devices count exceed the limit.',
],
[
'errorCode' => 'iot.vision.DevicesExceedUnreleasedProductLimit',
'errorMessage' => 'Devices count exceed the limit of unreleased product.',
],
],
403 => [
[
'errorCode' => 'iot.vision.RequestAuthFailed',
'errorMessage' => 'Request auth failed.',
],
[
'errorCode' => 'iot.vision.RequestForbidden',
'errorMessage' => 'Request forbidden.',
],
],
429 => [
[
'errorCode' => 'iot.vision.RequestTrafficControl',
'errorMessage' => 'Request traffic control.',
],
],
],
],
'GetThingEventSnapshot' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [],
'parameters' => [
[
'name' => 'Identifier',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'AlarmType',
],
],
[
'name' => 'ProductKey',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'a1Bw******',
],
],
[
'name' => 'DeviceName',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'Device01',
],
],
[
'name' => 'IotId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'C47T6xwp6ms4bNlkHRWCg4****',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => [
'description' => '',
'type' => 'string',
'example' => '400',
],
'ErrorMessage' => [
'description' => '',
'type' => 'string',
'example' => 'Unexpected internal error.',
],
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => 'E55***B7-4***-4***-8***-D3******F565',
],
'Success' => [
'description' => '',
'type' => 'boolean',
'example' => 'true',
],
'Data' => [
'description' => '',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'EventType' => [
'description' => '',
'type' => 'string',
'example' => 'alert',
],
'EventCode' => [
'description' => '',
'type' => 'string',
'example' => 'IntelligentAlarm',
],
'Identifier' => [
'description' => '',
'type' => 'string',
'example' => 'IntelligentAlarm',
],
'Timestamp' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '1700010288668',
],
'EventBody' => [
'description' => '',
'type' => 'string',
'example' => '{\\"EventList \\":[{\\"AlarmPicID \\":\\"\\",\\"EventTime \\":\\"1700010288542 \\",\\"AlarmType \\":1,\\"AlarmPicSize \\":1,\\"Data \\":\\"test \\"}]}',
],
'IotId' => [
'description' => '',
'type' => 'string',
'example' => 'C47T6xwp6ms4bNlkHRWCg4****',
],
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'iot.vision.UnexpectedInternalError',
'errorMessage' => 'Unexpected internal error.',
],
[
'errorCode' => 'iot.vision.RequestParamError',
'errorMessage' => 'Request parameter error.',
],
[
'errorCode' => 'iot.vision.RequestFailed',
'errorMessage' => 'Request failed.',
],
[
'errorCode' => 'iot.vision.InvalidIotInstance',
'errorMessage' => 'Invalid iot instance.',
],
[
'errorCode' => 'iot.vision.ProductNotExist',
'errorMessage' => 'Product not exist.',
],
[
'errorCode' => 'iot.vision.ThingModelNotExist',
'errorMessage' => 'Thing model not exist.',
],
[
'errorCode' => 'iot.vision.ThingModelIdentifierNotExist',
'errorMessage' => 'Thing model identifier not exist.',
],
[
'errorCode' => 'iot.vision.DeviceNotExist',
'errorMessage' => 'Device not exist.',
],
[
'errorCode' => 'iot.vision.InstanceArrearage',
'errorMessage' => 'Instance arrearage.',
],
[
'errorCode' => 'iot.vision.GetThingEventSnapshotFailed',
'errorMessage' => 'Get thing event snapshot failed.',
],
[
'errorCode' => 'iot.vision.ThingEventNotFound',
'errorMessage' => 'Thing event not found.',
],
],
403 => [
[
'errorCode' => 'iot.vision.RequestAuthFailed',
'errorMessage' => 'Request auth failed.',
],
[
'errorCode' => 'iot.vision.RequestForbidden',
'errorMessage' => 'Request forbidden.',
],
[
'errorCode' => 'iot.vision.HasNoAccessPermission',
'errorMessage' => 'Has no access permission.',
],
],
429 => [
[
'errorCode' => 'iot.vision.RequestTrafficControl',
'errorMessage' => 'Request traffic control.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"400\\",\\n \\"ErrorMessage\\": \\"Unexpected internal error.\\",\\n \\"RequestId\\": \\"E55***B7-4***-4***-8***-D3******F565\\",\\n \\"Success\\": true,\\n \\"Data\\": [\\n {\\n \\"EventType\\": \\"alert\\",\\n \\"EventCode\\": \\"IntelligentAlarm\\",\\n \\"Identifier\\": \\"IntelligentAlarm\\",\\n \\"Timestamp\\": 1700010288668,\\n \\"EventBody\\": \\"{\\\\\\\\\\\\\\"EventList \\\\\\\\\\\\\\":[{\\\\\\\\\\\\\\"AlarmPicID \\\\\\\\\\\\\\":\\\\\\\\\\\\\\"\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"EventTime \\\\\\\\\\\\\\":\\\\\\\\\\\\\\"1700010288542 \\\\\\\\\\\\\\",\\\\\\\\\\\\\\"AlarmType \\\\\\\\\\\\\\":1,\\\\\\\\\\\\\\"AlarmPicSize \\\\\\\\\\\\\\":1,\\\\\\\\\\\\\\"Data \\\\\\\\\\\\\\":\\\\\\\\\\\\\\"test \\\\\\\\\\\\\\"}]}\\",\\n \\"IotId\\": \\"C47T6xwp6ms4bNlkHRWCg4****\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\nE55***B7-4***-4***-8***-D3******F565\\n\\n C47T6xwp6ms4bNlkHRWCg4****\\n IntelligentAlarm\\n {\\"EventList \\":[{\\"AlarmPicID \\":\\"\\",\\"EventTime \\":\\"1700010288542 \\",\\"AlarmType \\":1,\\"AlarmPicSize \\":1,\\"Data \\":\\"test \\"}]}\\n alert\\n 1700010288668\\n IntelligentAlarm\\n\\ntrue\\n","errorExample":""}]',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'BatchBindDevice' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [],
'parameters' => [
[
'name' => 'OpenId',
'in' => 'query',
'schema' => [
'type' => 'string',
'required' => false,
],
],
[
'name' => 'OpenIdAppKey',
'in' => 'query',
'schema' => [
'type' => 'string',
'required' => false,
],
],
[
'name' => 'IdentityId',
'in' => 'query',
'schema' => [
'type' => 'string',
'required' => false,
],
],
[
'name' => 'DeviceList',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'ProductKey' => [
'type' => 'string',
'required' => false,
],
'DeviceName' => [
'type' => 'string',
'required' => false,
],
'IotId' => [
'type' => 'string',
'required' => false,
],
],
],
'required' => true,
'maxItems' => 20,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => [
'type' => 'string',
],
'ErrorMessage' => [
'type' => 'string',
],
'RequestId' => [
'type' => 'string',
],
'Success' => [
'type' => 'boolean',
],
'Data' => [
'type' => 'object',
'properties' => [
'BindDeviceList' => [
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'BindResultMessage' => [
'type' => 'string',
],
'ProductKey' => [
'type' => 'string',
],
'BindResultCode' => [
'type' => 'integer',
'format' => 'int32',
],
'DeviceName' => [
'type' => 'string',
],
'IotId' => [
'type' => 'string',
],
],
],
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'iot.vision.UnexpectedInternalError',
'errorMessage' => 'Unexpected internal error.',
],
[
'errorCode' => 'iot.vision.RequestParamError',
'errorMessage' => 'Request parameter error.',
],
[
'errorCode' => 'iot.vision.RequestFailed',
'errorMessage' => 'Request failed.',
],
[
'errorCode' => 'iot.vision.GetAccountInfoFailed',
'errorMessage' => 'Get account info failed.',
],
[
'errorCode' => 'iot.vision.AccountNotFound',
'errorMessage' => 'Account not found.',
],
[
'errorCode' => 'iot.vision.TenantMismatch',
'errorMessage' => 'Caller tenant and account belong tenant mismatch.',
],
[
'errorCode' => 'iot.vision.IdentityAppKeyProductNotBind',
'errorMessage' => 'The app associated with the identityId does not have permission to access the product.',
],
[
'errorCode' => 'iot.vision.BindFailed',
'errorMessage' => 'Bind account and device failed.',
],
],
403 => [
[
'errorCode' => 'iot.vision.RequestAuthFailed',
'errorMessage' => 'Request auth failed.',
],
[
'errorCode' => 'iot.vision.RequestForbidden',
'errorMessage' => 'Request forbidden.',
],
],
429 => [
[
'errorCode' => 'iot.vision.RequestTrafficControl',
'errorMessage' => 'Request traffic control.',
],
],
],
],
'GetAccountById' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [],
'parameters' => [
[
'name' => 'OpenId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '60yqjd1**************************561da00851',
],
],
[
'name' => 'OpenIdAppKey',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '76****57',
],
],
[
'name' => 'IdentityId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '5035op97******************a63994',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => [
'description' => '',
'type' => 'string',
'example' => '400',
],
'ErrorMessage' => [
'description' => '',
'type' => 'string',
'example' => 'Unexpected internal error.',
],
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => 'E55***B7-4***-4***-8***-D3******F565',
],
'Success' => [
'description' => '',
'type' => 'boolean',
'example' => 'true',
],
'Data' => [
'description' => '',
'type' => 'object',
'properties' => [
'LoginName' => [
'description' => '',
'type' => 'string',
'example' => '18*******20',
],
'Email' => [
'description' => '',
'type' => 'string',
'example' => '******',
],
'IdentityId' => [
'description' => '',
'type' => 'string',
'example' => '5035op97******************a63994',
],
'LastLoginTime' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '1700209499000',
],
'GmtCreate' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '1700189358000',
],
'NickName' => [
'description' => '',
'type' => 'string',
'example' => '18*******20',
],
'GmtModified' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '1700209499000',
],
'Phone' => [
'description' => '',
'type' => 'string',
'example' => '18*******20',
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'iot.vision.UnexpectedInternalError',
'errorMessage' => 'Unexpected internal error.',
],
[
'errorCode' => 'iot.vision.RequestParamError',
'errorMessage' => 'Request parameter error.',
],
[
'errorCode' => 'iot.vision.RequestFailed',
'errorMessage' => 'Request failed.',
],
[
'errorCode' => 'iot.vision.GetAccountInfoFailed',
'errorMessage' => 'Get account info failed.',
],
[
'errorCode' => 'iot.vision.AccountNotFound',
'errorMessage' => 'Account not found.',
],
[
'errorCode' => 'iot.vision.TenantMismatch',
'errorMessage' => 'Caller tenant and account belong tenant mismatch.',
],
],
403 => [
[
'errorCode' => 'iot.vision.RequestAuthFailed',
'errorMessage' => 'Request auth failed.',
],
[
'errorCode' => 'iot.vision.RequestForbidden',
'errorMessage' => 'Request forbidden.',
],
],
429 => [
[
'errorCode' => 'iot.vision.RequestTrafficControl',
'errorMessage' => 'Request traffic control.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"400\\",\\n \\"ErrorMessage\\": \\"Unexpected internal error.\\",\\n \\"RequestId\\": \\"E55***B7-4***-4***-8***-D3******F565\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"LoginName\\": \\"18*******20\\",\\n \\"Email\\": \\"******\\",\\n \\"IdentityId\\": \\"5035op97******************a63994\\",\\n \\"LastLoginTime\\": 1700209499000,\\n \\"GmtCreate\\": 1700189358000,\\n \\"NickName\\": \\"18*******20\\",\\n \\"GmtModified\\": 1700209499000,\\n \\"Phone\\": \\"18*******20\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\nE55***B7-4***-4***-8***-D3******F565\\n\\n 1700209499000\\n 18*******20\\n 1700189358000\\n ******\\n 18*******20\\n 1700209499000\\n 5035op97******************a63994\\n 18*******20\\n\\ntrue\\n","errorExample":""}]',
'title' => 'GetAccountById',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'GetDeviceStatus' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [],
'parameters' => [
[
'name' => 'ProductKey',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'a1Bw******',
],
],
[
'name' => 'DeviceName',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'Device01',
],
],
[
'name' => 'IotId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'C47T6xwp6ms4bNlkHRWCg4****',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => [
'description' => '',
'type' => 'string',
'example' => '400',
],
'ErrorMessage' => [
'description' => '',
'type' => 'string',
'example' => 'Unexpected internal error.',
],
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => 'E55***B7-4***-4***-8***-D3******F565',
],
'Success' => [
'description' => '',
'type' => 'boolean',
'example' => 'true',
],
'Data' => [
'description' => '',
'type' => 'object',
'properties' => [
'Status' => [
'description' => '',
'type' => 'string',
'example' => 'ONLINE',
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'iot.vision.UnexpectedInternalError',
'errorMessage' => 'Unexpected internal error.',
],
[
'errorCode' => 'iot.vision.RequestParamError',
'errorMessage' => 'Request parameter error.',
],
[
'errorCode' => 'iot.vision.RequestFailed',
'errorMessage' => 'Request failed.',
],
[
'errorCode' => 'iot.vision.InvalidIotInstance',
'errorMessage' => 'Invalid iot instance.',
],
[
'errorCode' => 'iot.vision.ProductNotExist',
'errorMessage' => 'Product not exist.',
],
[
'errorCode' => 'iot.vision.DeviceNotExist',
'errorMessage' => 'Device not exist.',
],
[
'errorCode' => 'iot.vision.InstanceArrearage',
'errorMessage' => 'Instance arrearage.',
],
],
403 => [
[
'errorCode' => 'iot.vision.RequestAuthFailed',
'errorMessage' => 'Request auth failed.',
],
[
'errorCode' => 'iot.vision.RequestForbidden',
'errorMessage' => 'Request forbidden.',
],
[
'errorCode' => 'iot.vision.HasNoAccessPermission',
'errorMessage' => 'Has no access permission.',
],
],
429 => [
[
'errorCode' => 'iot.vision.RequestTrafficControl',
'errorMessage' => 'Request traffic control.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"400\\",\\n \\"ErrorMessage\\": \\"Unexpected internal error.\\",\\n \\"RequestId\\": \\"E55***B7-4***-4***-8***-D3******F565\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"Status\\": \\"ONLINE\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\nE55***B7-4***-4***-8***-D3******F565\\n\\n ONLINE\\n\\ntrue\\n","errorExample":""}]',
'title' => 'GetDeviceStatus',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'GetSubDeviceList' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [],
'parameters' => [
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'maximum' => '50',
'minimum' => '1',
'example' => '5',
],
],
[
'name' => 'ProductKey',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'a1Bw******',
],
],
[
'name' => 'DeviceName',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'Device01',
],
],
[
'name' => 'IotId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'C47T6xwp6ms4bNlkHRWCg4****',
],
],
[
'name' => 'PageNo',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'maximum' => '100',
'minimum' => '1',
'example' => '1',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => [
'description' => '',
'type' => 'string',
'example' => '400',
],
'ErrorMessage' => [
'description' => '',
'type' => 'string',
'example' => 'Request parameter error.',
],
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => 'E55***B7-4***-4***-8***-D3******F565',
],
'Success' => [
'description' => '',
'type' => 'boolean',
'example' => 'true',
],
'Data' => [
'description' => '',
'type' => 'object',
'properties' => [
'PageNo' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'PageSize' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'Total' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '1',
],
'SubDeviceList' => [
'description' => '',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'ProductKey' => [
'description' => '',
'type' => 'string',
'example' => 'wse5******',
],
'DeviceName' => [
'description' => '',
'type' => 'string',
'example' => 'device-test',
],
'IotId' => [
'description' => '',
'type' => 'string',
'example' => 'qswdfrttgg*********',
],
],
],
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'iot.vision.UnexpectedInternalError',
'errorMessage' => 'Unexpected internal error.',
],
[
'errorCode' => 'iot.vision.RequestParamError',
'errorMessage' => 'Request parameter error.',
],
[
'errorCode' => 'iot.vision.RequestFailed',
'errorMessage' => 'Request failed.',
],
[
'errorCode' => 'iot.vision.InvalidIotInstance',
'errorMessage' => 'Invalid iot instance.',
],
[
'errorCode' => 'iot.vision.ProductNotExist',
'errorMessage' => 'Product not exist.',
],
[
'errorCode' => 'iot.vision.DeviceNotExist',
'errorMessage' => 'Device not exist.',
],
[
'errorCode' => 'iot.vision.InstanceArrearage',
'errorMessage' => 'Instance arrearage.',
],
],
403 => [
[
'errorCode' => 'iot.vision.RequestAuthFailed',
'errorMessage' => 'Request auth failed.',
],
[
'errorCode' => 'iot.vision.RequestForbidden',
'errorMessage' => 'Request forbidden.',
],
[
'errorCode' => 'iot.vision.HasNoAccessPermission',
'errorMessage' => 'Has no access permission.',
],
],
429 => [
[
'errorCode' => 'iot.vision.RequestTrafficControl',
'errorMessage' => 'Request traffic control.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"400\\",\\n \\"ErrorMessage\\": \\"Request parameter error.\\",\\n \\"RequestId\\": \\"E55***B7-4***-4***-8***-D3******F565\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"PageNo\\": 1,\\n \\"PageSize\\": 1,\\n \\"Total\\": 1,\\n \\"SubDeviceList\\": [\\n {\\n \\"ProductKey\\": \\"wse5******\\",\\n \\"DeviceName\\": \\"device-test\\",\\n \\"IotId\\": \\"qswdfrttgg*********\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\nE55***B7-4***-4***-8***-D3******F565\\n\\n \\n 1\\n \\n \\n qswdfrttgg*********\\n wse5******\\n device-test\\n \\n\\ntrue\\n","errorExample":""}]',
'title' => 'GetSubDeviceList',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'GetThingPropertySnapshot' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [],
'parameters' => [
[
'name' => 'ProductKey',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'a1Bw******',
],
],
[
'name' => 'DeviceName',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'Device01',
],
],
[
'name' => 'IotId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'C47T6xwp6ms4bNlkHRWCg4****',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => [
'description' => '',
'type' => 'string',
'example' => '400',
],
'Data' => [
'description' => '',
'type' => 'string',
'example' => '{\\"StreamVideoQuality\\":{\\"time\\":1699951400324,\\"value\\":\\"0\\"},\\"MotionDetectSensitivity\\":{\\"time\\":1699951400324,\\"value\\":\\"0\\"},\\"ImageFlipState\\":{\\"time\\":1699951400324,\\"value\\":\\"0\\"},\\"SubStreamVideoQuality\\":{\\"time\\":1699951400324,\\"value\\":\\"0\\"},\\"AlarmSwitch\\":{\\"time\\":1699951400324,\\"value\\":\\"0\\"},\\"AlarmFrequencyLevel\\":{\\"time\\":1700009930921,\\"value\\":\\"10\\"}}',
],
'ErrorMessage' => [
'description' => '',
'type' => 'string',
'example' => 'Request parameter error.',
],
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => 'E55***B7-4***-4***-8***-D3******F565',
],
'Success' => [
'description' => '',
'type' => 'boolean',
'example' => 'true',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'iot.vision.RequestParamError',
'errorMessage' => 'Request parameter error.',
],
[
'errorCode' => 'iot.vision.RequestFailed',
'errorMessage' => 'Request failed.',
],
[
'errorCode' => 'iot.vision.UnexpectedInternalError',
'errorMessage' => 'Unexpected internal error.',
],
[
'errorCode' => 'iot.vision.InvalidIotInstance',
'errorMessage' => 'Invalid iot instance.',
],
[
'errorCode' => 'iot.vision.ProductNotExist',
'errorMessage' => 'Product not exist.',
],
[
'errorCode' => 'iot.vision.ThingModelNotExist',
'errorMessage' => 'Thing model not exist.',
],
[
'errorCode' => 'iot.vision.DeviceNotExist',
'errorMessage' => 'Device not exist.',
],
[
'errorCode' => 'iot.vision.InstanceArrearage',
'errorMessage' => 'Instance arrearage.',
],
],
403 => [
[
'errorCode' => 'iot.vision.RequestAuthFailed',
'errorMessage' => 'Request auth failed.',
],
[
'errorCode' => 'iot.vision.RequestForbidden',
'errorMessage' => 'Request forbidden.',
],
[
'errorCode' => 'iot.vision.HasNoAccessPermission',
'errorMessage' => 'Has no access permission.',
],
],
429 => [
[
'errorCode' => 'iot.vision.RequestTrafficControl',
'errorMessage' => 'Request traffic control.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"400\\",\\n \\"Data\\": \\"{\\\\\\\\\\\\\\"StreamVideoQuality\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"time\\\\\\\\\\\\\\":1699951400324,\\\\\\\\\\\\\\"value\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"0\\\\\\\\\\\\\\"},\\\\\\\\\\\\\\"MotionDetectSensitivity\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"time\\\\\\\\\\\\\\":1699951400324,\\\\\\\\\\\\\\"value\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"0\\\\\\\\\\\\\\"},\\\\\\\\\\\\\\"ImageFlipState\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"time\\\\\\\\\\\\\\":1699951400324,\\\\\\\\\\\\\\"value\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"0\\\\\\\\\\\\\\"},\\\\\\\\\\\\\\"SubStreamVideoQuality\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"time\\\\\\\\\\\\\\":1699951400324,\\\\\\\\\\\\\\"value\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"0\\\\\\\\\\\\\\"},\\\\\\\\\\\\\\"AlarmSwitch\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"time\\\\\\\\\\\\\\":1699951400324,\\\\\\\\\\\\\\"value\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"0\\\\\\\\\\\\\\"},\\\\\\\\\\\\\\"AlarmFrequencyLevel\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"time\\\\\\\\\\\\\\":1700009930921,\\\\\\\\\\\\\\"value\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"10\\\\\\\\\\\\\\"}}\\",\\n \\"ErrorMessage\\": \\"Request parameter error.\\",\\n \\"RequestId\\": \\"E55***B7-4***-4***-8***-D3******F565\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\nE55***B7-4***-4***-8***-D3******F565\\n{\\"StreamVideoQuality\\":{\\"time\\":1699951400324,\\"value\\":\\"0\\"},\\"MotionDetectSensitivity\\":{\\"time\\":1699951400324,\\"value\\":\\"0\\"},\\"ImageFlipState\\":{\\"time\\":1699951400324,\\"value\\":\\"0\\"},\\"SubStreamVideoQuality\\":{\\"time\\":1699951400324,\\"value\\":\\"0\\"},\\"AlarmSwitch\\":{\\"time\\":1699951400324,\\"value\\":\\"0\\"},\\"AlarmFrequencyLevel\\":{\\"time\\":1700009930921,\\"value\\":\\"10\\"}}\\ntrue\\n","errorExample":""}]',
'title' => 'GetThingPropertySnapshot',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'InvokeThingService' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [],
'parameters' => [
[
'name' => 'Identifier',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'SetNum',
],
],
[
'name' => 'ProductKey',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'a1Bw******',
],
],
[
'name' => 'DeviceName',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'Device01',
],
],
[
'name' => 'Args',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '{"param1":1}',
],
],
[
'name' => 'IotId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'C47T6xwp6ms4bNlkHRWCg4****',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => [
'description' => '',
'type' => 'string',
'example' => '400',
],
'ErrorMessage' => [
'description' => '',
'type' => 'string',
'example' => 'Request parameter error.',
],
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => 'E55***B7-4***-4***-8***-D3******F565',
],
'Success' => [
'description' => '',
'type' => 'boolean',
'example' => 'true',
],
'Data' => [
'description' => '',
'type' => 'object',
'properties' => [
'Data' => [
'description' => '',
'type' => 'string',
'example' => '{"param1":1}',
],
'MessageId' => [
'description' => '',
'type' => 'string',
'example' => 'abcabcabc1234****',
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'iot.vision.RequestParamError',
'errorMessage' => 'Request parameter error.',
],
[
'errorCode' => 'iot.vision.RequestFailed',
'errorMessage' => 'Request failed.',
],
[
'errorCode' => 'iot.vision.UnexpectedInternalError',
'errorMessage' => 'Unexpected internal error.',
],
[
'errorCode' => 'iot.vision.InvalidIotInstance',
'errorMessage' => 'Invalid iot instance.',
],
[
'errorCode' => 'iot.vision.ProductNotExist',
'errorMessage' => 'Product not exist.',
],
[
'errorCode' => 'iot.vision.ThingModelNotExist',
'errorMessage' => 'Thing model not exist.',
],
[
'errorCode' => 'iot.vision.ThingModelIdentifierNotExist',
'errorMessage' => 'Thing model identifier not exist.',
],
[
'errorCode' => 'iot.vision.DeviceNotExist',
'errorMessage' => 'Device not exist.',
],
[
'errorCode' => 'iot.vision.InstanceArrearage',
'errorMessage' => 'Instance arrearage.',
],
[
'errorCode' => 'iot.vision.ServiceParamNotExist',
'errorMessage' => 'Invoke service failed as service param not exist.',
],
[
'errorCode' => 'iot.vision.ServiceNotFound',
'errorMessage' => 'Invoke service failed as service not found.',
],
[
'errorCode' => 'iot.vision.DeviceInactive',
'errorMessage' => 'Device inactive.',
],
[
'errorCode' => 'iot.vision.DevcieOffline',
'errorMessage' => 'Device offline.',
],
[
'errorCode' => 'iot.vision.ServiceEnumSpecError',
'errorMessage' => 'Service enum spec error.',
],
[
'errorCode' => 'iot.vision.ServiceResponseTimeout',
'errorMessage' => 'Invoke service response timeout.',
],
[
'errorCode' => 'iot.vision.InvokeServiceFailed',
'errorMessage' => 'Invoke service failed:%s',
],
],
403 => [
[
'errorCode' => 'iot.vision.RequestAuthFailed',
'errorMessage' => 'Request auth failed.',
],
[
'errorCode' => 'iot.vision.RequestForbidden',
'errorMessage' => 'Request forbidden.',
],
[
'errorCode' => 'iot.vision.HasNoAccessPermission',
'errorMessage' => 'Has no access permission.',
],
],
429 => [
[
'errorCode' => 'iot.vision.RequestTrafficControl',
'errorMessage' => 'Request traffic control.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"400\\",\\n \\"ErrorMessage\\": \\"Request parameter error.\\",\\n \\"RequestId\\": \\"E55***B7-4***-4***-8***-D3******F565\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"Data\\": \\"{\\\\\\"param1\\\\\\":1}\\",\\n \\"MessageId\\": \\"abcabcabc1234****\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\nE55***B7-4***-4***-8***-D3******F565\\n\\n {\\"param1\\":1}\\n abcabcabc1234****\\n\\ntrue\\n","errorExample":""}]',
'title' => 'InvokeThingService',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'ListBindingAccountByDevice' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [],
'parameters' => [
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'maximum' => '50',
'minimum' => '1',
'example' => '5',
],
],
[
'name' => 'ProductKey',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'a1Bw******',
],
],
[
'name' => 'DeviceName',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'Device01',
],
],
[
'name' => 'IotId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'C47T6xwp6ms4bNlkHRWCg4****',
],
],
[
'name' => 'PageNo',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'maximum' => '100',
'minimum' => '1',
'example' => '1',
],
],
[
'name' => 'Owned',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'maximum' => '1',
'minimum' => '0',
'example' => '0',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => [
'description' => '',
'type' => 'string',
'example' => '400',
],
'ErrorMessage' => [
'description' => '',
'type' => 'string',
'example' => 'Unexpected internal error.',
],
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => 'E55***B7-4***-4***-8***-D3******F565',
],
'Success' => [
'description' => '',
'type' => 'boolean',
'example' => 'true',
],
'Data' => [
'description' => '',
'type' => 'object',
'properties' => [
'PageNo' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'PageSize' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'Total' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'AccountList' => [
'description' => '',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'IdentityAlias' => [
'description' => '',
'type' => 'string',
'example' => '18*******20',
],
'IdentityId' => [
'description' => '',
'type' => 'string',
'example' => '5035op97******************a63994',
],
'BindTime' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '2222220000000',
],
],
],
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'iot.vision.UnexpectedInternalError',
'errorMessage' => 'Unexpected internal error.',
],
[
'errorCode' => 'iot.vision.RequestParamError',
'errorMessage' => 'Request parameter error.',
],
[
'errorCode' => 'iot.vision.RequestFailed',
'errorMessage' => 'Request failed.',
],
[
'errorCode' => 'iot.vision.TenantMismatch',
'errorMessage' => 'Caller tenant and account belong tenant mismatch.',
],
[
'errorCode' => 'iot.vision.QueryBindingAccountFailed',
'errorMessage' => 'Query binding account failed.',
],
],
403 => [
[
'errorCode' => 'iot.vision.RequestAuthFailed',
'errorMessage' => 'Request auth failed.',
],
[
'errorCode' => 'iot.vision.RequestForbidden',
'errorMessage' => 'Request forbidden.',
],
],
429 => [
[
'errorCode' => 'iot.vision.RequestTrafficControl',
'errorMessage' => 'Request traffic control.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"400\\",\\n \\"ErrorMessage\\": \\"Unexpected internal error.\\",\\n \\"RequestId\\": \\"E55***B7-4***-4***-8***-D3******F565\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"PageNo\\": 1,\\n \\"PageSize\\": 1,\\n \\"Total\\": 1,\\n \\"AccountList\\": [\\n {\\n \\"IdentityAlias\\": \\"18*******20\\",\\n \\"IdentityId\\": \\"5035op97******************a63994\\",\\n \\"BindTime\\": 2222220000000\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\nE55***B7-4***-4***-8***-D3******F565\\n\\n 1\\n 1\\n 1\\n \\n 1700209801000\\n 5035op97******************a63994\\n 18*******20\\n \\n\\ntrue\\n","errorExample":""}]',
'title' => 'ListBindingAccountByDevice',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'ListBindingDeviceByAccount' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [],
'parameters' => [
[
'name' => 'OpenId',
'in' => 'query',
'schema' => [
'type' => 'string',
'required' => false,
],
],
[
'name' => 'OpenIdAppKey',
'in' => 'query',
'schema' => [
'type' => 'string',
'required' => false,
],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'type' => 'integer',
'format' => 'int32',
'required' => true,
'maximum' => '50',
'minimum' => '1',
],
],
[
'name' => 'IdentityId',
'in' => 'query',
'schema' => [
'type' => 'string',
'required' => false,
],
],
[
'name' => 'PageNo',
'in' => 'query',
'schema' => [
'type' => 'integer',
'format' => 'int32',
'required' => true,
'maximum' => '100',
'minimum' => '1',
],
],
[
'name' => 'SubDevice',
'in' => 'query',
'schema' => [
'type' => 'boolean',
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => [
'type' => 'string',
],
'ErrorMessage' => [
'type' => 'string',
],
'RequestId' => [
'type' => 'string',
],
'Success' => [
'type' => 'boolean',
],
'Data' => [
'type' => 'object',
'properties' => [
'PageNo' => [
'type' => 'integer',
'format' => 'int32',
],
'PageSize' => [
'type' => 'integer',
'format' => 'int32',
],
'Total' => [
'type' => 'integer',
'format' => 'int64',
],
'PageCount' => [
'type' => 'integer',
'format' => 'int32',
],
'DeviceList' => [
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'ProductKey' => [
'type' => 'string',
],
'Owned' => [
'type' => 'integer',
'format' => 'int32',
],
'DeviceName' => [
'type' => 'string',
],
'NodeType' => [
'type' => 'string',
],
'BindTime' => [
'type' => 'integer',
'format' => 'int64',
],
'IotId' => [
'type' => 'string',
],
],
],
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'iot.vision.UnexpectedInternalError',
'errorMessage' => 'Unexpected internal error.',
],
[
'errorCode' => 'iot.vision.RequestParamError',
'errorMessage' => 'Request parameter error.',
],
[
'errorCode' => 'iot.vision.RequestFailed',
'errorMessage' => 'Request failed.',
],
[
'errorCode' => 'iot.vision.QueryBindingDeviceFailed',
'errorMessage' => 'Query binding device failed.',
],
[
'errorCode' => 'iot.vision.GetAccountInfoFailed',
'errorMessage' => 'Get account info failed.',
],
[
'errorCode' => 'iot.vision.AccountNotFound',
'errorMessage' => 'Account not found.',
],
[
'errorCode' => 'iot.vision.TenantMismatch',
'errorMessage' => 'Caller tenant and account belong tenant mismatch.',
],
],
403 => [
[
'errorCode' => 'iot.vision.RequestAuthFailed',
'errorMessage' => 'Request auth failed.',
],
[
'errorCode' => 'iot.vision.RequestForbidden',
'errorMessage' => 'Request forbidden.',
],
],
429 => [
[
'errorCode' => 'iot.vision.RequestTrafficControl',
'errorMessage' => 'Request traffic control.',
],
],
],
],
'SetThingProperty' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [],
'parameters' => [
[
'name' => 'ProductKey',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'a1Bw******',
],
],
[
'name' => 'DeviceName',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'Device01',
],
],
[
'name' => 'Args',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => '{"Switch":1,"Color":"blue"}',
],
],
[
'name' => 'IotId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'C47T6xwp6ms4bNlkHRWCg4****',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => [
'description' => '',
'type' => 'string',
'example' => '400',
],
'ErrorMessage' => [
'description' => '',
'type' => 'string',
'example' => 'Request parameter error.',
],
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => 'E55***B7-4***-4***-8***-D3******F565',
],
'Success' => [
'description' => '',
'type' => 'boolean',
'example' => 'true',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'iot.vision.UnexpectedInternalError',
'errorMessage' => 'Unexpected internal error.',
],
[
'errorCode' => 'iot.vision.RequestParamError',
'errorMessage' => 'Request parameter error.',
],
[
'errorCode' => 'iot.vision.RequestFailed',
'errorMessage' => 'Request failed.',
],
[
'errorCode' => 'iot.vision.InvalidIotInstance',
'errorMessage' => 'Invalid iot instance.',
],
[
'errorCode' => 'iot.vision.ProductNotExist',
'errorMessage' => 'Product not exist.',
],
[
'errorCode' => 'iot.vision.ThingModelNotExist',
'errorMessage' => 'Thing model not exist.',
],
[
'errorCode' => 'iot.vision.ThingModelIdentifierNotExist',
'errorMessage' => 'Thing model identifier not exist.',
],
[
'errorCode' => 'iot.vision.DeviceNotExist',
'errorMessage' => 'Device not exist.',
],
[
'errorCode' => 'iot.vision.InstanceArrearage',
'errorMessage' => 'Instance arrearage.',
],
[
'errorCode' => 'iot.vision.SetPropertyFailed',
'errorMessage' => 'Set property failed.',
],
[
'errorCode' => 'iot.vision.PropertyNotFound',
'errorMessage' => 'Property not found.',
],
[
'errorCode' => 'iot.vision.PropertyReadOnly',
'errorMessage' => 'Property is read only.',
],
],
403 => [
[
'errorCode' => 'iot.vision.RequestAuthFailed',
'errorMessage' => 'Request auth failed.',
],
[
'errorCode' => 'iot.vision.RequestForbidden',
'errorMessage' => 'Request forbidden.',
],
[
'errorCode' => 'iot.vision.HasNoAccessPermission',
'errorMessage' => 'Has no access permission.',
],
],
429 => [
[
'errorCode' => 'iot.vision.RequestTrafficControl',
'errorMessage' => 'Request traffic control.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"400\\",\\n \\"ErrorMessage\\": \\"Request parameter error.\\",\\n \\"RequestId\\": \\"E55***B7-4***-4***-8***-D3******F565\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\nE55***B7-4***-4***-8***-D3******F565\\ntrue\\n","errorExample":""}]',
'title' => 'SetThingProperty',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'UnbindAllUserByDevice' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [],
'parameters' => [
[
'name' => 'ProductKey',
'in' => 'query',
'schema' => [
'type' => 'string',
'required' => false,
],
],
[
'name' => 'DeviceName',
'in' => 'query',
'schema' => [
'type' => 'string',
'required' => false,
],
],
[
'name' => 'IotId',
'in' => 'query',
'schema' => [
'type' => 'string',
'required' => false,
],
],
[
'name' => 'UnbindSubDevice',
'in' => 'query',
'schema' => [
'type' => 'boolean',
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => [
'type' => 'string',
],
'ErrorMessage' => [
'type' => 'string',
],
'RequestId' => [
'type' => 'string',
],
'Success' => [
'type' => 'boolean',
],
'Data' => [
'type' => 'object',
'properties' => [
'SubDeviceUnbindResult' => [
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'UnbindResultMessage' => [
'type' => 'string',
],
'ProductKey' => [
'type' => 'string',
],
'DeviceName' => [
'type' => 'string',
],
'UnbindResultCode' => [
'type' => 'integer',
'format' => 'int32',
],
'IotId' => [
'type' => 'string',
],
],
],
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'iot.vision.UnexpectedInternalError',
'errorMessage' => 'Unexpected internal error.',
],
[
'errorCode' => 'iot.vision.RequestParamError',
'errorMessage' => 'Request parameter error.',
],
[
'errorCode' => 'iot.vision.RequestFailed',
'errorMessage' => 'Request failed.',
],
[
'errorCode' => 'iot.vision.GetAccountInfoFailed',
'errorMessage' => 'Get account info failed.',
],
[
'errorCode' => 'iot.vision.AccountNotFound',
'errorMessage' => 'Account not found.',
],
[
'errorCode' => 'iot.vision.TenantMismatch',
'errorMessage' => 'Caller tenant and account belong tenant mismatch.',
],
[
'errorCode' => 'iot.vision.UnbindFailed',
'errorMessage' => 'Unbind account and device failed.',
],
[
'errorCode' => 'iot.vision.BindingRelationNotFound',
'errorMessage' => 'Account and device binding relation not found.',
],
[
'errorCode' => 'iot.vision.QueryBindingAccountFailed',
'errorMessage' => 'Query binding account failed.',
],
],
403 => [
[
'errorCode' => 'iot.vision.RequestAuthFailed',
'errorMessage' => 'Request auth failed.',
],
[
'errorCode' => 'iot.vision.RequestForbidden',
'errorMessage' => 'Request forbidden.',
],
],
429 => [
[
'errorCode' => 'iot.vision.RequestTrafficControl',
'errorMessage' => 'Request traffic control.',
],
],
],
],
'UnbindDevice' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [],
'parameters' => [
[
'name' => 'OpenId',
'in' => 'query',
'schema' => [
'type' => 'string',
'required' => false,
],
],
[
'name' => 'OpenIdAppKey',
'in' => 'query',
'schema' => [
'type' => 'string',
'required' => false,
],
],
[
'name' => 'ProductKey',
'in' => 'query',
'schema' => [
'type' => 'string',
'required' => false,
],
],
[
'name' => 'DeviceName',
'in' => 'query',
'schema' => [
'type' => 'string',
'required' => false,
],
],
[
'name' => 'IotId',
'in' => 'query',
'schema' => [
'type' => 'string',
'required' => false,
],
],
[
'name' => 'IdentityId',
'in' => 'query',
'schema' => [
'type' => 'string',
'required' => false,
],
],
[
'name' => 'UnbindSubDevice',
'in' => 'query',
'schema' => [
'type' => 'boolean',
'required' => false,
'default' => 'true',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => [
'type' => 'string',
],
'ErrorMessage' => [
'type' => 'string',
],
'RequestId' => [
'type' => 'string',
],
'Success' => [
'type' => 'boolean',
],
'Data' => [
'type' => 'object',
'properties' => [
'SubDeviceUnbindResult' => [
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'UnbindResultMessage' => [
'type' => 'string',
],
'ProductKey' => [
'type' => 'string',
],
'DeviceName' => [
'type' => 'string',
],
'UnbindResultCode' => [
'type' => 'integer',
'format' => 'int32',
],
'IotId' => [
'type' => 'string',
],
],
],
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'iot.vision.UnexpectedInternalError',
'errorMessage' => 'Unexpected internal error.',
],
[
'errorCode' => 'iot.vision.RequestParamError',
'errorMessage' => 'Request parameter error.',
],
[
'errorCode' => 'iot.vision.RequestFailed',
'errorMessage' => 'Request failed.',
],
[
'errorCode' => 'iot.vision.GetAccountInfoFailed',
'errorMessage' => 'Get account info failed.',
],
[
'errorCode' => 'iot.vision.AccountNotFound',
'errorMessage' => 'Account not found.',
],
[
'errorCode' => 'iot.vision.TenantMismatch',
'errorMessage' => 'Caller tenant and account belong tenant mismatch.',
],
[
'errorCode' => 'iot.vision.BindingRelationNotFound',
'errorMessage' => 'Account and device binding relation not found.',
],
[
'errorCode' => 'iot.vision.UnbindFailed',
'errorMessage' => 'Unbind account and device failed.',
],
],
403 => [
[
'errorCode' => 'iot.vision.RequestAuthFailed',
'errorMessage' => 'Request auth failed.',
],
[
'errorCode' => 'iot.vision.RequestForbidden',
'errorMessage' => 'Request forbidden.',
],
],
429 => [
[
'errorCode' => 'iot.vision.RequestTrafficControl',
'errorMessage' => 'Request traffic control.',
],
],
],
],
],
'endpoints' => [
[
'regionId' => 'cn-qingdao',
'endpoint' => 'linkvisual.aliyuncs.com',
],
[
'regionId' => 'cn-beijing',
'endpoint' => 'linkvisual.aliyuncs.com',
],
[
'regionId' => 'cn-zhangjiakou',
'endpoint' => 'linkvisual.aliyuncs.com',
],
[
'regionId' => 'cn-huhehaote',
'endpoint' => 'linkvisual.aliyuncs.com',
],
[
'regionId' => 'cn-hangzhou',
'endpoint' => 'linkvisual.cn-hangzhou.aliyuncs.com',
],
[
'regionId' => 'cn-shanghai',
'endpoint' => 'linkvisual.cn-shanghai.aliyuncs.com',
],
[
'regionId' => 'cn-shenzhen',
'endpoint' => 'linkvisual.aliyuncs.com',
],
[
'regionId' => 'cn-hongkong',
'endpoint' => 'linkvisual.aliyuncs.com',
],
[
'regionId' => 'ap-northeast-1',
'endpoint' => 'linkvisual.ap-northeast-1.aliyuncs.com',
],
[
'regionId' => 'ap-southeast-1',
'endpoint' => 'linkvisual.aliyuncs.com',
],
[
'regionId' => 'ap-southeast-2',
'endpoint' => 'linkvisual.aliyuncs.com',
],
[
'regionId' => 'ap-southeast-3',
'endpoint' => 'linkvisual.aliyuncs.com',
],
[
'regionId' => 'ap-southeast-5',
'endpoint' => 'linkvisual.aliyuncs.com',
],
[
'regionId' => 'us-east-1',
'endpoint' => 'linkvisual.aliyuncs.com',
],
[
'regionId' => 'us-west-1',
'endpoint' => 'linkvisual.aliyuncs.com',
],
[
'regionId' => 'eu-west-1',
'endpoint' => 'linkvisual.aliyuncs.com',
],
[
'regionId' => 'eu-central-1',
'endpoint' => 'linkvisual.aliyuncs.com',
],
[
'regionId' => 'ap-south-1',
'endpoint' => 'linkvisual.aliyuncs.com',
],
[
'regionId' => 'me-east-1',
'endpoint' => 'linkvisual.aliyuncs.com',
],
],
];