diff options
Diffstat (limited to 'data/en_us/iovcc/2018-05-01/api-docs.php')
| -rw-r--r-- | data/en_us/iovcc/2018-05-01/api-docs.php | 24767 |
1 files changed, 11437 insertions, 13330 deletions
diff --git a/data/en_us/iovcc/2018-05-01/api-docs.php b/data/en_us/iovcc/2018-05-01/api-docs.php index c1822a8..35b9f39 100644 --- a/data/en_us/iovcc/2018-05-01/api-docs.php +++ b/data/en_us/iovcc/2018-05-01/api-docs.php @@ -1,374 +1,129 @@ <?php return [ 'version' => '1.0', - 'info' => [ - 'style' => 'RPC', - 'product' => 'iovcc', - 'version' => '2018-05-01', - ], + 'info' => ['style' => 'RPC', 'product' => 'iovcc', 'version' => '2018-05-01'], 'directories' => [ [ - 'id' => 64847, - 'title' => null, + 'children' => ['CreateVersionPrepublish', 'CreateVersionTest', 'DeleteVersionTest', 'ListClientPluginVersions', 'FindPrepublishesByVersionId', 'FindVersionTests'], 'type' => 'directory', - 'children' => [ - 'CreateVersionPrepublish', - 'CreateVersionTest', - 'DeleteVersionTest', - 'ListClientPluginVersions', - 'FindPrepublishesByVersionId', - 'FindVersionTests', - ], + 'title' => 'Version', ], [ - 'id' => 64854, - 'title' => null, + 'children' => ['DescribeAssistReport', 'ListAssistActionDetails', 'ListAssistHistories', 'ListAssistHistoryDetails', 'DescribeAssistRTMPServerAddress', 'SubmitAssistReport'], 'type' => 'directory', - 'children' => [ - 'DescribeAssistReport', - 'ListAssistActionDetails', - 'ListAssistHistories', - 'ListAssistHistoryDetails', - 'DescribeAssistRTMPServerAddress', - 'SubmitAssistReport', - ], + 'title' => 'Diagnostics', ], [ - 'id' => 64862, - 'title' => null, + 'children' => ['CreateCustomizedProperty', 'DeleteCustomizedProperty', 'FindCustomizedProperties'], 'type' => 'directory', - 'children' => [ - 'CreateCustomizedProperty', - 'DeleteCustomizedProperty', - 'FindCustomizedProperties', - ], + 'title' => 'Property', ], [ - 'id' => 64866, - 'title' => null, + 'children' => ['CreateCustomizedFilter', 'DeleteAllCustomizedFilters', 'DeleteCustomizedFilter', 'UpdateCustomizedFilter', 'DescribeCustomizedFilter', 'FindCustomizedFilters'], 'type' => 'directory', - 'children' => [ - 'CreateCustomizedFilter', - 'DeleteAllCustomizedFilters', - 'DeleteCustomizedFilter', - 'UpdateCustomizedFilter', - 'DescribeCustomizedFilter', - 'FindCustomizedFilters', - ], + 'title' => 'Filter', ], [ - 'id' => 64873, - 'title' => null, + 'children' => ['ListClientSdks', 'GenerateSdkDownloadInfo'], 'type' => 'directory', - 'children' => [ - 'ListClientSdks', - 'GenerateSdkDownloadInfo', - ], + 'title' => 'SDK', ], [ - 'id' => 64876, - 'title' => null, + 'children' => ['CreateSchemaSubscribe', 'DeleteSchemaSubscribe', 'UpdateSchemaSubscribe', 'ListSchemaSubscribes'], 'type' => 'directory', - 'children' => [ - 'CreateSchemaSubscribe', - 'DeleteSchemaSubscribe', - 'UpdateSchemaSubscribe', - 'ListSchemaSubscribes', - ], + 'title' => 'Subscription', ], [ - 'id' => 64883, - 'title' => null, + 'children' => ['UpdateNamespaceData', 'GetNamespaceData', 'GetNamespaceStatisticsData'], 'type' => 'directory', - 'children' => [ - 'CreateNamespace', - 'DeleteNamespace', - 'UpdateNamespaceData', - 'GetNamespaceData', - 'GetNamespaceStatisticsData', - 'ListNamespaces', - ], + 'title' => 'Namespace', ], [ - 'id' => 64890, - 'title' => null, + 'children' => ['DeleteOpenAccount', 'ListOpenAccountLinks', 'ListOpenAccounts', 'DescribeOpenAccount'], 'type' => 'directory', - 'children' => [ - 'DeleteOpenAccount', - 'ListOpenAccountLinks', - 'ListOpenAccounts', - 'DescribeOpenAccount', - ], + 'title' => 'Account', ], [ - 'id' => 64895, - 'title' => null, + 'children' => ['CreateUpstreamAppKeyRelation', 'CreateUpstreamAppServer', 'DeleteUpstreamAppKeyRelation', 'DeleteUpstreamAppServer', 'UpdateUpstreamAppServer', 'ListMessageAcks', 'ListOfflineMessages', 'DescribeMessage', 'PushVersionMessage', 'FindVersionMessages', 'FindVersionMessageSendRecords'], 'type' => 'directory', - 'children' => [ - 'CreateUpstreamAppKeyRelation', - 'CreateUpstreamAppServer', - 'DeleteUpstreamAppKeyRelation', - 'DeleteUpstreamAppServer', - 'UpdateUpstreamAppServer', - 'ListMessageAcks', - 'ListOfflineMessages', - 'DescribeMessage', - 'PushVersionMessage', - 'FindVersionMessages', - 'FindVersionMessageSendRecords', - ], + 'title' => 'Message', ], [ - 'id' => 64910, - 'title' => null, + 'children' => ['UpdateAppBlackWhiteVersions', 'UpdateAppVersionReleaseNote', 'UpdateAppVersionStatus', 'UpdateAppVersion', 'UpdateAppVersionRemark', 'GetDeviceAppUpdateFunnelEvents', 'PublishAppVersion', 'FindAppVersions'], 'type' => 'directory', - 'children' => [ - 'CreateAppVersion', - 'UpdateAppBlackWhiteVersions', - 'UpdateAppVersionReleaseNote', - 'UpdateAppVersionStatus', - 'UpdateAppVersion', - 'UpdateAppVersionRemark', - 'GetDeviceAppUpdateFunnelEvents', - 'PublishAppVersion', - 'FindAppVersions', - ], + 'title' => 'Application version', ], [ - 'id' => 64920, - 'title' => null, + 'children' => ['AddVersionBlackDevices', 'CreateOsVersion', 'DeleteVersionBlackDevices', 'DeleteVersionBlackDevicesById', 'DeleteVersionWhiteDevices', 'DeleteVersionWhiteDevicesById', 'UpdateOsBlackWhiteVersions', 'UpdateOsVersion', 'UpdateOsVersionReleaseNote', 'UpdateOsVersionRemark', 'UpdateOsVersionStatus', 'DescribeAppVersion', 'DescribeOsVersion', 'GetDeviceSystemUpdateFunnelEvents', 'DelayPublishOsVersion', 'FindOsVersions', 'FindVersionWhiteDevices', 'PublishOsVersion'], 'type' => 'directory', - 'children' => [ - 'AddVersionBlackDevices', - 'CreateOsVersion', - 'DeleteVersionBlackDevices', - 'DeleteVersionBlackDevicesById', - 'DeleteVersionWhiteDevices', - 'DeleteVersionWhiteDevicesById', - 'UpdateOsBlackWhiteVersions', - 'UpdateOsVersion', - 'UpdateOsVersionReleaseNote', - 'UpdateOsVersionRemark', - 'UpdateOsVersionStatus', - 'DescribeAppVersion', - 'DescribeOsVersion', - 'GetDeviceSystemUpdateFunnelEvents', - 'DelayPublishOsVersion', - 'FindOsVersions', - 'FindVersionWhiteDevices', - 'PublishOsVersion', - ], + 'title' => 'System version', ], [ - 'id' => 64944, - 'title' => null, + 'children' => ['CreateShadowSchema', 'DeleteShadowSchema', 'UpdateShadowSchema', 'ListShadowSchemaDeviceModels', 'ListShadowSchemas', 'DescribeDefaultSchema', 'DescribeDeviceValiditySchema', 'DescribeShadowSchema'], 'type' => 'directory', - 'children' => [ - 'CreateShadowSchema', - 'DeleteShadowSchema', - 'UpdateShadowSchema', - 'ListShadowSchemaDeviceModels', - 'ListShadowSchemas', - 'DescribeDefaultSchema', - 'DescribeDeviceValiditySchema', - 'DescribeShadowSchema', - ], + 'title' => 'Schema', ], [ - 'id' => 64953, - 'title' => null, + 'children' => ['AddUploadedFunctionFileInfo', 'DeleteFunctionFile', 'ListDeployedFunctions', 'ListFunctionExecuteLog', 'ListFunctionFiles', 'ListFunctionFilesByProjectId', 'GenerateFunctionFileUploadMeta', 'InvokeFunction', 'DeployFunctionFile'], 'type' => 'directory', - 'children' => [ - 'AddUploadedFunctionFileInfo', - 'DeleteFunctionFile', - 'ListDeployedFunctions', - 'ListFunctionExecuteLog', - 'ListFunctionFiles', - 'ListFunctionFilesByProjectId', - 'GenerateFunctionFileUploadMeta', - 'InvokeFunction', - 'DeployFunctionFile', - ], + 'title' => 'Function', ], [ - 'id' => 64963, - 'title' => null, + 'children' => ['UpdateTrigger', 'ListTriggers'], 'type' => 'directory', - 'children' => [ - 'CreateTrigger', - 'DeleteTrigger', - 'UpdateTrigger', - 'ListTriggers', - ], + 'title' => 'Trigger', ], [ - 'id' => 64968, - 'title' => null, - 'type' => 'directory', 'children' => [ - 'AddVersionGroupDevices', - 'AddVersionWhiteDevices', - 'AddVersionWhiteDevicesByDeviceGroups', - 'CreateDeviceBrand', - 'CreateDeviceModel', - 'CreateVersionDeviceGroup', - 'DeleteAllVersionGroupDevices', - 'DeleteDevice', - 'DeleteVersionAllBlackDevices', - 'DeleteVersionAllWhiteDevices', - 'DeleteVersionDeviceGroup', - 'DeleteVersionGroupDevice', - 'DeleteVersionGroupDeviceById', - 'UpdateDeviceModel', - 'UpdateVersionDeviceGroup', - 'UpdateApiGatewayAppStatus', - 'UpdateProject', - 'DescribeDeviceModel', - 'DescribeDeviceOnlineInfo', - 'DescribeDeviceShadow', - 'DescribeVersionDeviceGroup', - 'QueryPrepublishPassedDeviceCount', - 'ListVersionDeviceGroups', - 'ListAssistDevices', - 'ListConnectLogs', - 'ListDeviceModels', - 'ListDevices', - 'ListDeviceTypes', - 'ListMessageReceivers', - 'DescribeDeviceBrand', - 'DescribeDeviceIdByOuterInfo', - 'DescribeDeviceInfo', - 'ConnectAssistDevice', - 'CountActivatedOrNewRegistrationDevice', - 'CountDeviceBrands', - 'CountDeviceModels', - 'CountDevices', - 'CountYunIdInfo', - 'DiagnosisVersion', - 'FindPrepublishPassedDevices', - 'FindVersionBlackDevices', - 'PushMessage', - 'FindVersionDeviceGroups', - 'FindVersionGroupDevices', + 'AddVersionGroupDevices', 'AddVersionWhiteDevices', 'AddVersionWhiteDevicesByDeviceGroups', 'CreateDeviceBrand', 'CreateDeviceModel', 'CreateVersionDeviceGroup', 'DeleteAllVersionGroupDevices', 'DeleteDevice', 'DeleteVersionAllBlackDevices', 'DeleteVersionAllWhiteDevices', 'DeleteVersionDeviceGroup', 'DeleteVersionGroupDevice', 'DeleteVersionGroupDeviceById', 'UpdateDeviceModel', 'UpdateVersionDeviceGroup', 'UpdateApiGatewayAppStatus', 'DescribeDeviceModel', 'DescribeDeviceOnlineInfo', 'DescribeDeviceShadow', 'DescribeVersionDeviceGroup', + 'QueryPrepublishPassedDeviceCount', 'ListVersionDeviceGroups', 'ListAssistDevices', 'ListConnectLogs', 'ListDeviceModels', 'ListDevices', 'ListDeviceTypes', 'ListMessageReceivers', 'DescribeDeviceBrand', 'DescribeDeviceIdByOuterInfo', 'DescribeDeviceInfo', 'ConnectAssistDevice', 'CountActivatedOrNewRegistrationDevice', 'CountDeviceBrands', 'CountDeviceModels', 'CountDevices', 'CountYunIdInfo', 'DiagnosisVersion', 'FindPrepublishPassedDevices', 'FindVersionBlackDevices', + 'PushMessage', 'FindVersionDeviceGroups', 'FindVersionGroupDevices', ], + 'type' => 'directory', + 'title' => 'Device', ], [ - 'id' => 65016, - 'title' => null, + 'children' => ['CreateProjectApp', 'ListProjectApps', 'DescribeProjectAppSecurity'], 'type' => 'directory', - 'children' => [ - 'CreateProjectApp', - 'ListProjectApps', - 'ListProjects', - 'DescribeProjectAppSecurity', - ], + 'title' => 'Project', ], [ - 'id' => 0, - 'title' => '其它', - 'type' => 'directory', 'children' => [ - 'CreateRpcService', - 'DeleteProjectApp', - 'DeleteRpcService', - 'DescribeAssistWSServerAddress', - 'FindPrepublishesByParentId', - 'GenerateOssUploadMeta', - 'GenerateSysAppDownloadInfo', - 'GetOssUploadMeta', - 'ListApiGatewayApps', - 'ListApps', - 'ListClientPlugins', - 'ListDeviceBrands', - 'ListPreChecks', - 'ListRpcServices', - 'ListSupportFeatures', - 'ListUpstreamAppKeyRelations', - 'ListUpstreamAppServers', - 'UpdateVersionPrepublishActiveStatus', + 'CreateAppVersion', 'CreateNamespace', 'CreateRpcService', 'CreateTrigger', 'DeleteNamespace', 'DeleteProjectApp', 'DeleteRpcService', 'DeleteTrigger', 'DescribeAssistWSServerAddress', 'FindPrepublishesByParentId', 'GenerateOssUploadMeta', 'GenerateSysAppDownloadInfo', 'GetOssUploadMeta', 'ListApiGatewayApps', 'ListApps', 'ListClientPlugins', 'ListDeviceBrands', 'ListNamespaces', 'ListPreChecks', 'ListProjects', + 'ListRpcServices', 'ListSupportFeatures', 'ListUpstreamAppKeyRelations', 'ListUpstreamAppServers', 'UpdateProject', 'UpdateVersionPrepublishActiveStatus', ], + 'title' => 'Others', + 'type' => 'directory', ], ], 'components' => [ 'schemas' => [], ], 'apis' => [ - 'CreateVersionPrepublish' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'https', - ], + 'AddUploadedFunctionFileInfo' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', - 'systemTags' => [ - 'operationType' => 'create', - ], + 'systemTags' => ['operationType' => 'create'], 'parameters' => [ [ - 'name' => 'IsTotalPrepublish', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'N', - ], - ], - [ - 'name' => 'VersionId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '1', - ], - ], - [ - 'name' => 'VersionType', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'FOTA', - ], - ], - [ - 'name' => 'Name', + 'name' => 'ProjectId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '', - ], + 'schema' => ['description' => 'The project ID.', 'type' => 'string', 'required' => true, 'example' => 'PE9FQC48', 'title' => ''], ], [ - 'name' => 'ProjectId', + 'name' => 'ObjectKey', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'P0VFCREU', - ], + 'schema' => ['description' => 'The identifier of the uploaded file.', 'type' => 'string', 'required' => true, 'example' => 'function/file/1288127240930711/PE9FQC48/B1226EA3-2518-4164-8D2D-82B91A077020/hello.zip', 'title' => ''], ], [ - 'name' => 'BarrierCount', + 'name' => 'FileName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '1000', - ], + 'schema' => ['description' => 'The file name.', 'type' => 'string', 'required' => true, 'example' => 'hello.zip', 'title' => ''], ], ], 'responses' => [ @@ -376,103 +131,83 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '6F25F67C-F411-499F-BCE2-67CA563CB064', - ], - 'PrepublishId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '1', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '629586FE-CB2E-4742-995E-121F952CEB72', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"PrepublishId\\": \\"1\\",\\n \\"RequestId\\": \\"6F25F67C-F411-499F-BCE2-67CA563CB064\\"\\n}","errorExample":"{\\n \\"RequestId\\": \\"6F25F67C-F411-499F-BCE2-67CA563CB064\\",\\n \\"HostId\\": \\"iovcc.cn-shanghai.aliyuncs.com\\",\\n \\"Code\\": \\"NoPermission.NotOwner\\",\\n \\"Message\\": \\"You have no permission because you are not the owner of the data\\"\\n}"},{"type":"xml","example":"<CreateVersionPrepublishResponse>\\r\\n\\t<RequestId>6F25F67C-F411-499F-BCE2-67CA563CB064</RequestId>\\r\\n\\t<PrepublishId>1</PrepublishId>\\r\\n</CreateVersionPrepublishResponse>","errorExample":""}]', - 'title' => 'CreateVersionPrepublish', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"629586FE-CB2E-4742-995E-121F952CEB72\\"\\n}","type":"json"}]', + 'title' => 'Add an uploaded function file', + 'summary' => 'Adds a function file that has already been uploaded by calling GenerateFunctionFileUploadMeta.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'CreateVersionTest' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [ + ['createdAt' => '2024-06-18T02:20:37.000Z', 'description' => 'Error codes changed'], ], - 'schemes' => [ - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'iovcc:AddUploadedFunctionFileInfo', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + ], + 'AddVersionBlackDevices' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', - 'systemTags' => [ - 'operationType' => 'create', - ], + 'systemTags' => ['operationType' => 'create'], 'parameters' => [ [ - 'name' => 'DeviceGroupId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '1', - ], - ], - [ - 'name' => 'Description', + 'name' => 'DeviceIds', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '', - ], + 'schema' => ['description' => 'The list of device IDs, separated by commas (,). The type of device ID used is determined by DeviceIdType.', 'type' => 'string', 'required' => true, 'example' => '11,22,33', 'title' => ''], ], [ - 'name' => 'VersionId', + 'name' => 'ProjectId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '1', - ], + 'schema' => ['description' => 'The project ID.', 'type' => 'string', 'required' => true, 'example' => 'P0VFCREU', 'title' => ''], ], [ 'name' => 'VersionType', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'FOTA', - ], + 'schema' => ['description' => 'The version type. Valid values:'."\n" + ."\n" + .'- FOTA: system upgrade'."\n" + .'- APP: application upgrade.', 'type' => 'string', 'required' => true, 'example' => 'FOTA', 'title' => ''], ], [ - 'name' => 'Name', + 'name' => 'DeviceIdType', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '', - ], + 'schema' => ['description' => 'The device ID type. Valid values:'."\n" + ."\n" + .'- device_id: hardware ID'."\n" + .'- sn: serial number'."\n" + .'- vin: vehicle identification number'."\n" + .'- hardware_id: hardware ID.', 'type' => 'string', 'required' => true, 'example' => 'hardware_id', 'title' => ''], ], [ - 'name' => 'ProjectId', + 'name' => 'VersionId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'P0VFCREU', - ], + 'schema' => ['description' => 'The version ID.', 'type' => 'string', 'required' => true, 'example' => '12345', 'title' => ''], ], ], 'responses' => [ @@ -480,63 +215,76 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'TestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '1', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '6F25F67C-F411-499F-BCE2-67CA563CB064', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '6F25F67C-F411-499F-BCE2-67CA563CB064', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"TestId\\": \\"1\\",\\n \\"RequestId\\": \\"6F25F67C-F411-499F-BCE2-67CA563CB064\\"\\n}","errorExample":"{\\n \\"RequestId\\": \\"6F25F67C-F411-499F-BCE2-67CA563CB064\\",\\n \\"HostId\\": \\"iovcc.cn-shanghai.aliyuncs.com\\",\\n \\"Code\\": \\"NoPermission.NotOwner\\",\\n \\"Message\\": \\"You have no permission because you are not the owner of the data\\"\\n}"},{"type":"xml","example":"<CreateVersionTestResponse>\\r\\n\\t<RequestId>6F25F67C-F411-499F-BCE2-67CA563CB064</RequestId>\\r\\n\\t<TestId>1</TestId>\\r\\n</CreateVersionTestResponse>","errorExample":""}]', - 'title' => 'CreateVersionTest', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6F25F67C-F411-499F-BCE2-67CA563CB064\\"\\n}","type":"json"}]', + 'title' => 'Add devices to the blacklist for a system version or application version', + 'summary' => 'Calls AddVersionBlackDevices to add devices to the blacklist for a system version or application version.', + 'description' => '> During a system upgrade or application upgrade, if you want to prevent specific devices from being upgraded, call this operation to add devices to the version blacklist.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'DeleteVersionTest' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [ + ['createdAt' => '2024-06-18T02:20:37.000Z', 'description' => 'Error codes changed'], + ], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'iovcc:AddVersionBlackDevices', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'AddVersionGroupDevices' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'delete', - ], + 'operationType' => 'write', + 'systemTags' => ['operationType' => 'create'], 'parameters' => [ [ + 'name' => 'DeviceIdType', + 'in' => 'query', + 'schema' => ['description' => 'The device ID type. Valid values:'."\n" + ."\n" + .'- **device_id**: hardware ID'."\n" + .'- **sn**: serial number'."\n" + .'- **vin**: vehicle identification number'."\n" + .'- **hardware_id**: hardware ID.', 'type' => 'string', 'required' => true, 'example' => 'sn', 'title' => ''], + ], + [ 'name' => 'ProjectId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'P0VFCREU', - ], + 'schema' => ['description' => 'The ID of the project.', 'type' => 'string', 'required' => true, 'example' => 'P0VFCREU', 'title' => ''], ], [ - 'name' => 'Id', + 'name' => 'DeviceIds', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '1', - ], + 'schema' => ['description' => 'The list of cloud device IDs.', 'type' => 'string', 'required' => true, 'example' => '"b8fe2e24ff2b48e0a3aa4e49809fc1b3","b8f12e24ff2b48e0a3aa4e49809fc1b3"', 'title' => ''], + ], + [ + 'name' => 'DeviceGroupId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the test device group.', 'type' => 'string', 'required' => true, 'example' => '1', 'title' => ''], ], ], 'responses' => [ @@ -544,59 +292,83 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '6F25F67C-F411-499F-BCE2-67CA563CB064', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '6F25F67C-F411-499F-BCE2-67CA563CB064', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"6F25F67C-F411-499F-BCE2-67CA563CB064\\"\\n}","errorExample":"{\\n \\"RequestId\\": \\"6F25F67C-F411-499F-BCE2-67CA563CB064\\",\\n \\"HostId\\": \\"iovcc.cn-shanghai.aliyuncs.com\\",\\n \\"Code\\": \\"NoPermission.NotOwner\\",\\n \\"Message\\": \\"You have no permission because you are not the owner of the data\\"\\n}"},{"type":"xml","example":"<DeleteVersionTestResponse>\\r\\n\\t<RequestId>6F25F67C-F411-499F-BCE2-67CA563CB064</RequestId>\\r\\n</DeleteVersionTestResponse>","errorExample":""}]', - 'title' => 'DeleteVersionTest', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6F25F67C-F411-499F-BCE2-67CA563CB064\\"\\n}","type":"json"}]', + 'title' => 'Add devices to a test device group in batches', + 'summary' => 'Adds one or more devices to a test device group by cloud device ID.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'ListClientPluginVersions' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [ + ['createdAt' => '2024-06-18T02:20:37.000Z', 'description' => 'Error codes changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'iovcc:AddVersionGroupDevices', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + ], + 'AddVersionWhiteDevices' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - ], + 'operationType' => 'write', + 'systemTags' => ['operationType' => 'create'], 'parameters' => [ [ - 'name' => 'OsType', + 'name' => 'DeviceIds', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '1', - ], + 'schema' => ['description' => 'The list of device IDs, separated by commas (,).', 'type' => 'string', 'required' => true, 'example' => '11,22,33', 'title' => ''], ], [ - 'name' => 'PkgName', + 'name' => 'ProjectId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'com.aliyun.aicc.yundevice', - ], + 'schema' => ['description' => 'The project ID.', 'type' => 'string', 'required' => true, 'example' => 'P0VFCREU', 'title' => ''], + ], + [ + 'name' => 'VersionType', + 'in' => 'query', + 'schema' => ['description' => 'The version type. Valid values:'."\n" + ."\n" + .'- **FOTA**: system upgrade.'."\n" + .'- **APP**: application upgrade.', 'type' => 'string', 'required' => true, 'example' => 'FOTA', 'title' => ''], + ], + [ + 'name' => 'DeviceIdType', + 'in' => 'query', + 'schema' => ['description' => 'The device ID type. Valid values:'."\n" + ."\n" + .'- **device_id**: hardware ID.'."\n" + .'- **sn**: serial number.'."\n" + .'- **vin**: vehicle identification number.'."\n" + .'- **hardware_id**: hardware ID.', 'type' => 'string', 'required' => true, 'example' => 'hardware_id', 'title' => ''], + ], + [ + 'name' => 'VersionId', + 'in' => 'query', + 'schema' => ['description' => 'The version ID.', 'type' => 'string', 'required' => true, 'example' => '12345', 'title' => ''], ], ], 'responses' => [ @@ -604,111 +376,71 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'ClientPluginVersions' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Version' => [ - 'description' => '', - 'type' => 'string', - 'example' => '1.1.1.20180103102554-3', - ], - 'DownloadUrl' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'http://xxxxx.oss-cn-shanghai.aliyuncs.com/1046834015363116/xxx/2019-09-17/1568704641998-com.aliyun.aicc-1.2-36-g4e4b62e.apk?spm=5176.11279587.0.0.f7944f48XVfS6a&Expires=1568708242&OSSAccessKeyId=xxxx&Signature=xxx%3D&response-content-disposition=attachment%3Bfilename%3Dcom.aliyun.aicc-1.2-36-g4e4b62e.apk%3Bfilename%2A%3DUTF-8%27%27com.aliyun.aicc-1.2-36-g4e4b62e.apk', - ], - 'Size' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '743503', - ], - 'PkgName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'com.aliyun.aicc.yundevice', - ], - 'VersionCode' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '201', - ], - 'Id' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '40', - ], - ], - ], - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '647D4B28-7646-424E-88DD-61B7969E5C1E', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '6F25F67C-F411-499F-BCE2-67CA563CB064', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"647D4B28-7646-424E-88DD-61B7969E5C1E\\",\\n \\"ClientPluginVersions\\": [\\n {\\n \\"Version\\": \\"1.1.1.20180103102554-3\\",\\n \\"DownloadUrl\\": \\"http://xxxxx.oss-cn-shanghai.aliyuncs.com/1046834015363116/xxx/2019-09-17/1568704641998-com.aliyun.aicc-1.2-36-g4e4b62e.apk?spm=5176.11279587.0.0.f7944f48XVfS6a&Expires=1568708242&OSSAccessKeyId=xxxx&Signature=xxx%3D&response-content-disposition=attachment%3Bfilename%3Dcom.aliyun.aicc-1.2-36-g4e4b62e.apk%3Bfilename%2A%3DUTF-8%27%27com.aliyun.aicc-1.2-36-g4e4b62e.apk\\",\\n \\"Size\\": 743503,\\n \\"PkgName\\": \\"com.aliyun.aicc.yundevice\\",\\n \\"VersionCode\\": 201,\\n \\"Id\\": 40\\n }\\n ]\\n}","errorExample":"{\\n \\"RequestId\\": \\"6F25F67C-F411-499F-BCE2-67CA563CB064\\",\\n \\"HostId\\": \\"iovcc.cn-shanghai.aliyuncs.com\\",\\n \\"Code\\": \\"InvalidTenant\\",\\n \\"Message\\": \\"User is not a valid tenant\\"\\n}"},{"type":"xml","example":"<ListClientPluginVersionsResponse>\\r\\n\\t<RequestId>7257DEDE-3558-4AE5-BA9B-2AD7A4FFB61E</RequestId>\\r\\n\\t<ClientPluginVersions>\\r\\n\\t\\t<VersionCode>201</VersionCode>\\r\\n\\t\\t<Id>40</Id>\\r\\n\\t\\t<PkgName>com.aliyun.aicc.yundevice</PkgName>\\r\\n\\t\\t<Version>1.1.1.20180103102554-3</Version>\\r\\n\\t\\t<Size>743503</Size>\\r\\n\\t</ClientPluginVersions>\\r\\n</ListClientPluginVersionsResponse>","errorExample":""}]', - 'title' => 'ListClientPluginVersions', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6F25F67C-F411-499F-BCE2-67CA563CB064\\"\\n}","type":"json"}]', + 'title' => 'Add device whitelist for a system version or application version', + 'summary' => 'Adds devices to the whitelist of a system version or application version by calling AddVersionWhiteDevices.', + 'description' => '> Call this operation to add devices to the whitelist of a version.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'FindPrepublishesByVersionId' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [ + ['createdAt' => '2024-06-18T02:20:37.000Z', 'description' => 'Error codes changed'], ], - 'schemes' => [ - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'iovcc:AddVersionWhiteDevices', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + ], + 'AddVersionWhiteDevicesByDeviceGroups' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - ], + 'operationType' => 'write', + 'systemTags' => ['operationType' => 'create'], 'parameters' => [ [ 'name' => 'ProjectId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'P0VFCREU', - ], + 'schema' => ['description' => 'The project ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'UEWE232', 'title' => ''], ], [ - 'name' => 'VersionId', + 'name' => 'VersionType', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '1', - ], + 'schema' => ['description' => 'The version type.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'FOTA', 'title' => ''], ], [ - 'name' => 'VersionType', + 'name' => 'GroupIds', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'FOTA', - ], + 'schema' => ['description' => 'The device group ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '12', 'title' => ''], + ], + [ + 'name' => 'VersionId', + 'in' => 'query', + 'schema' => ['description' => 'The version ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '12323', 'title' => ''], ], ], 'responses' => [ @@ -716,176 +448,86 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '6F25F67C-F411-499F-BCE2-67CA563CB064', - ], - 'PrepublishList' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'GmtCreateTimestamp' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1684530000000', - ], - 'DeviceModelId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '12', - ], - 'GmtModify' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2018-01-01 00:01:00', - ], - 'IsActive' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Y', - ], - 'VersionId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '1', - ], - 'BarrierCount' => [ - 'description' => '', - 'type' => 'string', - 'example' => '1000', - ], - 'DeviceModelName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'DM1', - ], - 'IsTotalPrepublish' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'N', - ], - 'GmtModifyTimestamp' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1684530000000', - ], - 'ParentId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '0', - ], - 'GmtCreate' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2018-01-01 00:00:00', - ], - 'Name' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'Id' => [ - 'description' => 'ID', - 'type' => 'string', - 'example' => '1', - ], - 'VersionType' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'FOTA', - ], - 'PassedCount' => [ - 'description' => '', - 'type' => 'string', - 'example' => '0', - ], - ], - ], - ], + 'RequestId' => ['type' => 'string', 'description' => '', 'example' => '6F25F67C-F411-499F-BCE2-67CA563CB064', 'title' => ''], + 'Data' => ['description' => 'The returned data.', 'type' => 'string', 'example' => 'success', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"6F25F67C-F411-499F-BCE2-67CA563CB064\\",\\n \\"PrepublishList\\": [\\n {\\n \\"GmtCreateTimestamp\\": 1684530000000,\\n \\"DeviceModelId\\": \\"12\\",\\n \\"GmtModify\\": \\"2018-01-01 00:01:00\\",\\n \\"IsActive\\": \\"Y\\",\\n \\"VersionId\\": \\"1\\",\\n \\"BarrierCount\\": \\"1000\\",\\n \\"DeviceModelName\\": \\"DM1\\",\\n \\"GmtModifyTimestamp\\": 1684530000000,\\n \\"IsTotalPrepublish\\": \\"N\\",\\n \\"ParentId\\": \\"0\\",\\n \\"GmtCreate\\": \\"2018-01-01 00:00:00\\",\\n \\"Name\\": \\"第一次预发布\\",\\n \\"Id\\": \\"1\\",\\n \\"VersionType\\": \\"FOTA\\",\\n \\"PassedCount\\": \\"0\\"\\n }\\n ]\\n}","errorExample":"{\\n \\"RequestId\\": \\"6F25F67C-F411-499F-BCE2-67CA563CB064\\",\\n \\"HostId\\": \\"iovcc.cn-shanghai.aliyuncs.com\\",\\n \\"Code\\": \\"NoPermissionToAccessProject\\",\\n \\"Message\\": \\"User is not authorized to access the specified project.\\"\\n}"},{"type":"xml","example":"<FindPrepublishesByVersionIdResponse>\\r\\n\\t<RequestId>6F25F67C-F411-499F-BCE2-67CA563CB064</RequestId>\\r\\n\\t<PrepublishList>\\r\\n\\t\\t<Id>1</Id>\\r\\n\\t\\t<VersionType>1.0,2.0</VersionType>\\r\\n\\t\\t<VersionId>1</VersionId>\\r\\n\\t\\t<ParentId>1</ParentId>\\r\\n\\t\\t<Name>第一次预发布</Name>\\r\\n\\t\\t<DeviceModelId>12</DeviceModelId>\\r\\n\\t\\t<IsTotalPrepublish>N</IsTotalPrepublish>\\r\\n\\t\\t<BarrierCount>1000</BarrierCount>\\r\\n\\t\\t<IsActive>Y</IsActive>\\r\\n\\t\\t<GmtCreate>2018-01-01 00:00:00</GmtCreate>\\r\\n\\t\\t<GmtModify>2018-01-01 00:01:00</GmtModify>\\r\\n\\t</PrepublishList>\\r\\n</FindPrepublishesByVersionIdResponse>","errorExample":""}]', - 'title' => 'FindPrepublishesByVersionId', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6F25F67C-F411-499F-BCE2-67CA563CB064\\",\\n \\"Data\\": \\"success\\"\\n}","type":"json"}]', + 'title' => 'Add devices from a group to the version blacklists and whitelists', + 'summary' => 'Adds devices from a device group to the version blacklists and whitelists.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'FindVersionTests' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [ + ['createdAt' => '2024-06-18T02:20:37.000Z', 'description' => 'Error codes changed'], ], - 'schemes' => [ - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'iovcc:AddVersionWhiteDevicesByDeviceGroups', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + ], + 'ConnectAssistDevice' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'ProjectId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'P0VFCREU', - ], + 'name' => 'HardwareId', + 'in' => 'formData', + 'schema' => ['description' => 'The hardware ID.', 'type' => 'string', 'required' => false, 'example' => 'BALFL8429HI', 'title' => ''], ], [ - 'name' => 'PageIndex', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '1', - ], + 'name' => 'AllowCommandExtension', + 'in' => 'formData', + 'schema' => ['description' => 'Specifies whether to allow the execution of extended commands.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], ], [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '20', - ], + 'name' => 'DeviceId', + 'in' => 'formData', + 'schema' => ['description' => 'The device ID.', 'type' => 'string', 'required' => false, 'example' => '6fde56979c484b93b99fba257e3cbe83', 'title' => ''], ], [ - 'name' => 'VersionId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '1', - ], + 'name' => 'SerialNumber', + 'in' => 'formData', + 'schema' => ['description' => 'The serial number.', 'type' => 'string', 'required' => false, 'example' => 'BALFL8429SN', 'title' => ''], ], [ - 'name' => 'VersionType', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'FOTA', - ], + 'name' => 'VIN', + 'in' => 'formData', + 'schema' => ['description' => 'The Vehicle Identification Number (VIN).', 'type' => 'string', 'required' => false, 'example' => 'LHK000026VFAG7A31', 'title' => ''], + ], + [ + 'name' => 'UUID', + 'in' => 'formData', + 'schema' => ['description' => 'The AliOS device UUID.', 'type' => 'string', 'required' => false, 'example' => '842972B2C0F4C9F030E60769CA65806A', 'title' => ''], + ], + [ + 'name' => 'ProjectId', + 'in' => 'formData', + 'schema' => ['description' => 'The project ID.', 'type' => 'string', 'required' => false, 'example' => 'PZ1HK7JZ', 'title' => ''], ], ], 'responses' => [ @@ -893,235 +535,109 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '6F25F67C-F411-499F-BCE2-67CA563CB064', - ], - 'VersionTestList' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Items' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'GmtCreateTimestamp' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1685450000', - ], - 'GmtModify' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2018-01-01 00:01:00', - ], - 'VersionId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '1', - ], - 'GmtModifyTimestamp' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1685450000', - ], - 'FailedCount' => [ - 'description' => '', - 'type' => 'string', - 'example' => '0', - ], - 'DeviceGroupId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '1', - ], - 'SkippedCount' => [ - 'description' => '', - 'type' => 'string', - 'example' => '0', - ], - 'Description' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'SucceededCount' => [ - 'description' => '', - 'type' => 'string', - 'example' => '100', - ], - 'DeviceGroupName' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'GmtCreate' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2018-01-01 00:00:00', - ], - 'Name' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'Id' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'VersionType' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'FOTA', - ], - ], - ], - ], - 'TotalCount' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '30', - ], - ], - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '9c7a3b09-a69a-43f5-8bf2-84f7119810eb', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"6F25F67C-F411-499F-BCE2-67CA563CB064\\",\\n \\"VersionTestList\\": {\\n \\"TotalCount\\": 30,\\n \\"Items\\": [\\n {\\n \\"GmtCreateTimestamp\\": 1685450000,\\n \\"GmtModify\\": \\"2018-01-01 00:01:00\\",\\n \\"VersionId\\": \\"1\\",\\n \\"GmtModifyTimestamp\\": 1685450000,\\n \\"DeviceGroupId\\": \\"1\\",\\n \\"FailedCount\\": \\"0\\",\\n \\"SkippedCount\\": \\"0\\",\\n \\"Description\\": \\"测试描述\\",\\n \\"DeviceGroupName\\": \\"测试分组\\",\\n \\"SucceededCount\\": \\"100\\",\\n \\"GmtCreate\\": \\"2018-01-01 00:00:00\\",\\n \\"Name\\": \\"第一次测试\\",\\n \\"Id\\": 1,\\n \\"VersionType\\": \\"FOTA\\"\\n }\\n ]\\n }\\n}","errorExample":"{\\n \\"RequestId\\": \\"6F25F67C-F411-499F-BCE2-67CA563CB064\\",\\n \\"HostId\\": \\"iovcc.cn-shanghai.aliyuncs.com\\",\\n \\"Code\\": \\"NoPermission.NotOwner\\",\\n \\"Message\\": \\"You have no permission because you are not the owner of the data\\"\\n}"},{"type":"xml","example":"<FindVersionTestsResponse>\\r\\n\\t<RequestId>6F25F67C-F411-499F-BCE2-67CA563CB064</RequestId>\\r\\n\\t<VersionTestList>\\r\\n\\t\\t<TotalCount>30</TotalCount>\\r\\n\\t\\t<Items>\\r\\n\\t\\t\\t<Id>1</Id>\\r\\n\\t\\t\\t<VersionType>FOTA</VersionType>\\r\\n\\t\\t\\t<VersionId>1</VersionId>\\r\\n\\t\\t\\t<Name>第一次测试</Name>\\r\\n\\t\\t\\t<DeviceGroupId>1</DeviceGroupId>\\r\\n\\t\\t\\t<DeviceGroupName>测试分组</DeviceGroupName>\\r\\n\\t\\t\\t<Description>测试描述</Description>\\r\\n\\t\\t\\t<SucceededCount>100</SucceededCount>\\r\\n\\t\\t\\t<FailedCount>0</FailedCount>\\r\\n\\t\\t\\t<SkippedCount>0</SkippedCount>\\r\\n\\t\\t\\t<GmtCreate>2018-01-01 00:00:00</GmtCreate>\\r\\n\\t\\t\\t<GmtModify>2018-01-01 00:01:00</GmtModify>\\r\\n\\t\\t</Items>\\r\\n\\t</VersionTestList>\\r\\n</FindVersionTestsResponse>","errorExample":""}]', - 'title' => 'FindVersionTests', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9c7a3b09-a69a-43f5-8bf2-84f7119810eb\\"\\n}","type":"json"}]', + 'title' => 'Notify a device to establish a diagnostic connection', + 'summary' => 'Notifies a device to establish a diagnostic WebSocket connection.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'DescribeAssistReport' => [ - 'methods' => [ - 'get', + 'changeSet' => [ + ['createdAt' => '2024-06-18T02:20:37.000Z', 'description' => 'Error codes changed'], + ], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'iovcc:ConnectAssistDevice', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'CountActivatedOrNewRegistrationDevice' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'ProjectId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'PZ1HK7JZ', - ], + 'schema' => ['description' => 'The project ID.', 'type' => 'string', 'required' => false, 'example' => 'projectTest', 'title' => ''], ], [ - 'name' => 'AssistId', + 'name' => 'DeviceType', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '510', - ], + 'schema' => ['description' => 'The device type.', 'type' => 'string', 'required' => false, 'example' => 'car_auto', 'title' => ''], ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '9c7a3b09-a69a-43f5-8bf2-84f7119810eb', - ], - 'AssistResult' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'AssistReason' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'AssistId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '510', - ], - 'AssistDescription' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'AssistTag' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - ], - ], + [ + 'name' => 'DeviceBrandId', + 'in' => 'query', + 'schema' => ['description' => 'The device brand ID.', 'type' => 'string', 'required' => false, 'example' => '15', 'title' => ''], ], - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"9c7a3b09-a69a-43f5-8bf2-84f7119810eb\\",\\n \\"AssistTag\\": \\"系统时间\\",\\n \\"AssistReason\\": \\"没有和时间服务器同步\\",\\n \\"AssistDescription\\": \\"设备时间异常\\",\\n \\"AssistId\\": \\"510\\",\\n \\"AssistResult\\": \\"手动设置正确时间\\"\\n}","errorExample":"{\\n \\"Code\\":\\"NoPermissionToAccessProject\\",\\n \\"HostId\\":\\"iovcc.cn-shanghai.aliyuncs.com\\",\\n \\"Message\\":\\"User is not authorized to access the specified project.\\",\\n \\"RequestId\\":\\"6F25F67C-F411-499F-BCE2-67CA563CB064\\"\\n}"},{"type":"xml","example":"<DescribeAssistReportResponse>\\r\\n\\t<RequestId>6F0A833B-7A86-4D92-A083-C184041E2F2D</RequestId>\\r\\n\\t<AssistId>510</AssistId>\\r\\n\\t<AssistDescription>设备时间异常</AssistDescription>\\r\\n\\t<AssistReason>没有和时间服务器同步</AssistReason>\\r\\n\\t<AssistResult>手动设置正确时间</AssistResult>\\r\\n\\t<AssistTag>time</AssistTag>\\r\\n</DescribeAssistReportResponse>","errorExample":""}]', - 'title' => 'DescribeAssistReport', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'ListAssistActionDetails' => [ - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ [ - 'AK' => [], + 'name' => 'DeviceBrand', + 'in' => 'query', + 'schema' => ['description' => 'The device brand name.', 'type' => 'string', 'required' => false, 'example' => 'ROEWE', 'title' => ''], ], - ], - 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - ], - 'parameters' => [ [ - 'name' => 'ActionTimestamp', + 'name' => 'DeviceModelId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '1524560714502LwoJKfp', - ], + 'schema' => ['description' => 'The device model ID.', 'type' => 'string', 'required' => false, 'example' => '105', 'title' => ''], ], [ - 'name' => 'ProjectId', + 'name' => 'DeviceModel', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'PZ1HK7JZ', - ], + 'schema' => ['description' => 'The device model name.', 'type' => 'string', 'required' => false, 'example' => 'ROEWE RX5', 'title' => ''], + ], + [ + 'name' => 'DeviceCountStatType', + 'in' => 'query', + 'schema' => ['description' => 'The statistical period type. Valid values:'."\n" + .'- byDay: daily statistics.'."\n" + .'- byMonth: monthly statistics.', 'type' => 'string', 'required' => false, 'example' => 'byDay', 'title' => ''], + ], + [ + 'name' => 'IsQueryNewRegistrationDevice', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to query activated devices. Valid values:'."\n" + .'- true: Queries the trend of device activations.'."\n" + .'- false: Queries the trend of active devices.', 'type' => 'string', 'required' => false, 'example' => 'false', 'title' => ''], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => ['description' => 'The start time.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2018-08-15 12:00:00', 'title' => ''], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => ['description' => 'The end time.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2018-08-25 12:00:00', 'title' => ''], + ], + [ + 'name' => 'IsQueryYearlyActivate', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to query the active device trend by year.', 'type' => 'string', 'required' => false, 'example' => 'false', 'title' => ''], ], ], 'responses' => [ @@ -1129,131 +645,103 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '9c7a3b09-a69a-43f5-8bf2-84f7119810eb', - ], - 'Results' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Type' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'event', - ], - 'Action' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'top', - ], - 'Data' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Processes: 331 total, 2 running, 329 sleeping, 1936 threads', - ], - 'DeviceId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '37aac8e7d96c42ea94fd5408e351474e', - ], - 'CreatedAt' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1525767660000', - ], - 'UpdatedAt' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1525767660000', - ], - 'Timestamp' => [ - 'description' => '', - 'type' => 'string', - 'example' => '1525398712826BdAw5KN', - ], - 'ID' => [ + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '6F25F67C-F411-499F-BCE2-67CA563CB064', 'title' => ''], + 'Statistics' => [ + 'description' => 'The statistics result.', + 'type' => 'object', + 'properties' => [ + 'Categories' => [ + 'type' => 'array', + 'items' => ['description' => 'The time dimension of the statistics.', 'type' => 'string', 'example' => '["1568217600000","1568649600000"]', 'title' => ''], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'Series' => [ + 'description' => 'The categorized statistics results.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'type' => 'array', + 'items' => ['description' => 'The data result of the current category.', 'type' => 'string', 'example' => '[3,3]', 'title' => ''], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'Name' => ['description' => 'The statistics category.', 'type' => 'string', 'example' => 'increment', 'title' => ''], + ], 'description' => '', - 'type' => 'string', - 'example' => '40475', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"9c7a3b09-a69a-43f5-8bf2-84f7119810eb\\",\\n \\"Results\\": [\\n {\\n \\"Type\\": \\"event\\",\\n \\"Action\\": \\"top\\",\\n \\"Data\\": \\"Processes: 331 total, 2 running, 329 sleeping, 1936 threads\\",\\n \\"DeviceId\\": \\"37aac8e7d96c42ea94fd5408e351474e\\",\\n \\"CreatedAt\\": 1525767660000,\\n \\"UpdatedAt\\": 1525767660000,\\n \\"Timestamp\\": \\"1525398712826BdAw5KN\\",\\n \\"ID\\": \\"40475\\"\\n }\\n ]\\n}","errorExample":"{\\n \\"Code\\":\\"NoPermissionToAccessProject\\",\\n \\"HostId\\":\\"iovcc.cn-shanghai.aliyuncs.com\\",\\n \\"Message\\":\\"User is not authorized to access the specified project.\\",\\n \\"RequestId\\":\\"6F25F67C-F411-499F-BCE2-67CA563CB064\\"\\n}"},{"type":"xml","example":"<ListAssistActionDetailsResponse>\\r\\n<RequestId>6F0A833B-7A86-4D92-A083-C184041E2F2D</RequestId>\\r\\n\\t<ResultList>\\r\\n\\t\\t<Action>top</Action>\\r\\n\\t\\t<CreatedAt>1525767660000</CreatedAt>\\r\\n\\t\\t<UpdatedAt>1525767660000</UpdatedAt>\\r\\n\\t\\t<Data>Processes: 331 total, 2 running, 329 sleeping, 1936 threads</Data>\\r\\n\\t\\t<DeviceId>37aac8e7d96c42ea94fd5408e351474e</DeviceId>\\r\\n\\t\\t<ID>40475</ID>\\r\\n\\t\\t<Timestamp>1525398712826BdAw5KN</Timestamp>\\r\\n\\t\\t<Type>event</Type>\\r\\n\\t</ResultList>\\r\\n\\t<ResultList>\\r\\n\\t\\t<Action>top</Action>\\r\\n\\t\\t<CreatedAt>2018-04-24 17:05:15</CreatedAt>\\r\\n\\t\\t<UpdatedAt>2018-04-24 17:05:15</UpdatedAt>\\r\\n\\t\\t<Data>Load Avg: 2.38, 2.23, 2.06 CPU usage: 8.52% user, 4.80% sys, 86.67% idle SharedLibs: 142M resident, 42M data, 17M linkedit.</Data>\\r\\n\\t\\t<DeviceId>37aac8e7d96c42ea94fd5408e351474e</DeviceId>\\r\\n\\t\\t<ID>40476</ID>\\r\\n\\t\\t<Timestamp>1525398712826BdAw5KN</Timestamp>\\r\\n\\t\\t<Type>event</Type>\\r\\n\\t</ResultList>\\r\\n</ListAssistActionDetailsResponse>","errorExample":""}]', - 'title' => 'ListAssistActionDetails', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6F25F67C-F411-499F-BCE2-67CA563CB064\\",\\n \\"Statistics\\": {\\n \\"Categories\\": [\\n \\"[\\\\\\"1568217600000\\\\\\",\\\\\\"1568649600000\\\\\\"]\\"\\n ],\\n \\"Series\\": [\\n {\\n \\"Data\\": [\\n \\"[3,3]\\"\\n ],\\n \\"Name\\": \\"increment\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'Query multi-dimensional device activation and activity statistics', + 'summary' => 'Supports daily and monthly statistics.', + 'description' => 'Queries multi-dimensional statistics on device activation and activity, with support for daily and monthly aggregation.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'ListAssistHistories' => [ - 'methods' => [ - 'get', + 'changeSet' => [ + ['createdAt' => '2021-05-26T12:50:16.000Z', 'description' => 'OpenAPI offline'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'iovcc:CountActivatedOrNewRegistrationDevice', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'CountDeviceBrands' => [ + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'PerPage', + 'name' => 'DeviceBrandId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '20', - ], + 'schema' => ['description' => 'The ID of the device brand to query.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''], ], [ - 'name' => 'PageIndex', + 'name' => 'DeviceBrand', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '1', - ], - ], - [ - 'name' => 'Condition', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '{"vin":"LVFAG7A31HK000029"}', - ], + 'schema' => ['description' => 'The name of the device brand to query.', 'type' => 'string', 'required' => false, 'example' => 'Tmall', 'title' => ''], ], [ 'name' => 'ProjectId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'PZ1HK7JZ', - ], + 'schema' => ['description' => 'The project ID.', 'type' => 'string', 'required' => false, 'example' => 'projectTest', 'title' => ''], ], ], 'responses' => [ @@ -1261,142 +749,71 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'TotalCount' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '46', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '9c7a3b09-a69a-43f5-8bf2-84f7119810eb', - ], - 'PerPage' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '20', - ], - 'Histories' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'SerialNumber' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'BALFL8429SN', - ], - 'EndTime' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1525767680000', - ], - 'StartTime' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1525767660000', - ], - 'UNAME' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'admin', - ], - 'HardwareId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'BALFL8429HI', - ], - 'DeviceName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Model S', - ], - 'UUID' => [ - 'description' => '', - 'type' => 'string', - 'example' => '842972B2C0F4C9F030E60769CA65806A', - ], - 'DeviceId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '6fde56979c484b93b99fba257e3cbe83', - ], - 'VIN' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'LHK000026VFAG7A31', - ], - 'UID' => [ - 'description' => '', - 'type' => 'string', - 'example' => '12345', - ], - 'ID' => [ - 'description' => '', - 'type' => 'string', - 'example' => '510', - ], - ], - ], - ], - 'PageIndex' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '9c7a3b09-a69a-43f5-8bf2-84f7119810eb', 'title' => ''], + 'BrandCount' => ['description' => 'The number of brands.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"PageIndex\\": 1,\\n \\"RequestId\\": \\"9c7a3b09-a69a-43f5-8bf2-84f7119810eb\\",\\n \\"TotalCount\\": 46,\\n \\"PerPage\\": 20,\\n \\"Histories\\": [\\n {\\n \\"SerialNumber\\": \\"BALFL8429SN\\",\\n \\"EndTime\\": 1525767680000,\\n \\"StartTime\\": 1525767660000,\\n \\"UNAME\\": \\"admin\\",\\n \\"HardwareId\\": \\"BALFL8429HI\\",\\n \\"DeviceName\\": \\"Model S\\",\\n \\"UUID\\": \\"842972B2C0F4C9F030E60769CA65806A\\",\\n \\"DeviceId\\": \\"6fde56979c484b93b99fba257e3cbe83\\",\\n \\"VIN\\": \\"LHK000026VFAG7A31\\",\\n \\"UID\\": \\"12345\\",\\n \\"ID\\": \\"510\\"\\n }\\n ]\\n}","errorExample":"{\\n \\"Code\\":\\"NoPermissionToAccessProject\\",\\n \\"HostId\\":\\"iovcc.cn-shanghai.aliyuncs.com\\",\\n \\"Message\\":\\"User is not authorized to access the specified project.\\",\\n \\"RequestId\\":\\"6F25F67C-F411-499F-BCE2-67CA563CB064\\"\\n}"},{"type":"xml","example":"<ListAssistHistoriesResponse>\\r\\n<RequestId>6F0A833B-7A86-4D92-A083-C184041E2F2D</RequestId>\\r\\n\\t<PageIndex>1</PageIndex>\\r\\n\\t<PerPage>20</PerPage>\\r\\n\\t<TotalCount>2</TotalCount>\\r\\n\\t<Histories>\\r\\n\\t\\t<ID>510</ID>\\r\\n\\t\\t<DeviceId>37aac8e7d96c42ea94fd5408e351474e</DeviceId>\\r\\n\\t\\t<DeviceName>phone</DeviceName>\\r\\n\\t\\t<VIN>LVFAG7A31HK000029</VIN>\\r\\n\\t\\t<SerialNumber>DX3JNY1FDTD2</SerialNumber>\\r\\n\\t\\t<UID>12345</UID>\\r\\n\\t\\t<UNAME>admin</UNAME>\\r\\n\\t\\t<StartTime>1513231605000</StartTime>\\r\\n\\t\\t<EndTime>1513231705000</EndTime>\\r\\n\\t</Histories>\\r\\n\\t<Histories>\\r\\n\\t\\t<ID>511</ID>\\r\\n\\t\\t<DeviceId>37aac8e7d96c42ea94fd5408e351474e</DeviceId>\\r\\n\\t\\t<DeviceName>phone</DeviceName>\\r\\n\\t\\t<VIN>LVFAG7A31HK000029</VIN>\\r\\n\\t\\t<SerialNumber>DX3JNY1FDTD2</SerialNumber>\\r\\n\\t\\t<UID>12345</UID>\\r\\n\\t\\t<UNAME>admin</UNAME>\\r\\n\\t\\t<StartTime>1513231705000</StartTime>\\r\\n\\t\\t<EndTime>1513231905000</EndTime>\\r\\n\\t</Histories>\\r\\n</ListAssistHistoriesResponse>","errorExample":""}]', - 'title' => 'ListAssistHistories', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9c7a3b09-a69a-43f5-8bf2-84f7119810eb\\",\\n \\"BrandCount\\": 2\\n}","type":"json"}]', + 'title' => 'Query the number of device brands that meet specified conditions', + 'summary' => 'Queries the number of device brands that meet the specified conditions by calling CountDeviceBrands.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'ListAssistHistoryDetails' => [ - 'methods' => [ - 'get', + 'changeSet' => [ + ['createdAt' => '2024-06-18T02:20:36.000Z', 'description' => 'Error codes changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'iovcc:CountDeviceBrands', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + ], + 'CountDeviceModels' => [ + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'ProjectId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'PZ1HK7JZ', - ], + 'schema' => ['description' => 'The project ID.', 'type' => 'string', 'required' => false, 'example' => 'projectTest', 'title' => ''], ], [ - 'name' => 'AssistId', + 'name' => 'DeviceModelId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '510', - ], + 'schema' => ['description' => 'The device model ID.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], + ], + [ + 'name' => 'DeviceModel', + 'in' => 'query', + 'schema' => ['description' => 'The device model name. Fuzzy match is supported.', 'type' => 'string', 'required' => false, 'example' => 'X1', 'title' => ''], + ], + [ + 'name' => 'DeviceBrand', + 'in' => 'query', + 'schema' => ['description' => 'The device brand.', 'type' => 'string', 'required' => false, 'example' => 'TmallGenius', 'title' => ''], ], ], 'responses' => [ @@ -1404,98 +821,66 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '9c7a3b09-a69a-43f5-8bf2-84f7119810eb', - ], - 'Actions' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Action' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'top', - ], - 'CreatedAt' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1525767660000', - ], - 'Timestamp' => [ - 'description' => '', - 'type' => 'string', - 'example' => '1524560987853KrvUfI1', - ], - 'UpdatedAt' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1525767660000', - ], - 'AssistId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '510', - ], - 'ID' => [ - 'description' => '', - 'type' => 'string', - 'example' => '40475', - ], - ], - ], - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '9c7a3b09-a69a-43f5-8bf2-84f7119810eb', 'title' => ''], + 'ModelCount' => ['description' => 'The number of device models returned by the query.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"9c7a3b09-a69a-43f5-8bf2-84f7119810eb\\",\\n \\"Actions\\": [\\n {\\n \\"Action\\": \\"top\\",\\n \\"CreatedAt\\": 1525767660000,\\n \\"Timestamp\\": \\"1524560987853KrvUfI1\\",\\n \\"UpdatedAt\\": 1525767660000,\\n \\"AssistId\\": \\"510\\",\\n \\"ID\\": \\"40475\\"\\n }\\n ]\\n}","errorExample":"{\\n \\"Code\\":\\"NoPermissionToAccessProject\\",\\n \\"HostId\\":\\"iovcc.cn-shanghai.aliyuncs.com\\",\\n \\"Message\\":\\"User is not authorized to access the specified project.\\",\\n \\"RequestId\\":\\"6F25F67C-F411-499F-BCE2-67CA563CB064\\"\\n}"},{"type":"xml","example":"<ListAssistHistoryDetailsResponse>\\r\\n\\t<RequestId>6F0A833B-7A86-4D92-A083-C184041E2F2D</RequestId>\\r\\n\\t<ActionList>\\r\\n\\t\\t<ID>45070</ID>\\r\\n\\t\\t<AssistId>510</AssistId>\\r\\n\\t\\t<Action>ls</Action>\\r\\n\\t\\t<Timestamp>1524560987853KrvUfI1</Timestamp>\\r\\n\\t\\t<CreatedAt>2018-04-24T09:09:57</CreatedAt>\\r\\n\\t\\t<UpdatedAt>2018-04-24T09:09:59</UpdatedAt>\\r\\n\\t</ActionList>\\r\\n\\t<ActionList>\\r\\n\\t\\t<ID>45071</ID>\\r\\n\\t\\t<AssistId>510</AssistId>\\r\\n\\t\\t<Action>top</Action>\\r\\n\\t\\t<Timestamp>1524560758970zQCkx3A</Timestamp>\\r\\n\\t\\t<CreatedAt>2018-04-24T09:29:41</CreatedAt>\\r\\n\\t\\t<UpdatedAt>2018-04-24T09:29:41</UpdatedAt>\\r\\n\\t</ActionList>\\r\\n</ListAssistHistoryDetailsResponse>","errorExample":""}]', - 'title' => 'ListAssistHistoryDetails', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9c7a3b09-a69a-43f5-8bf2-84f7119810eb\\",\\n \\"ModelCount\\": 10\\n}","type":"json"}]', + 'title' => 'Query the number of device models', + 'summary' => 'Calls CountDeviceModels to query the number of device models.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'DescribeAssistRTMPServerAddress' => [ - 'methods' => [ - 'get', + 'changeSet' => [ + ['createdAt' => '2024-06-18T02:20:36.000Z', 'description' => 'Error codes changed'], ], - 'schemes' => [ - 'https', + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'iovcc:CountDeviceModels', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'CountDevices' => [ + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'ProjectId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'PZ1HK7JZ', - ], + 'schema' => ['description' => 'The project ID.', 'type' => 'string', 'required' => false, 'example' => 'projectTest', 'title' => ''], ], [ - 'name' => 'DeviceId', + 'name' => 'DeviceModelId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '6fde56979c484b93b99fba257e3cbe83', - ], + 'schema' => ['description' => 'The device model ID.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'DeviceModel', + 'in' => 'query', + 'schema' => ['description' => 'The device model name. Fuzzy match is supported.', 'type' => 'string', 'required' => false, 'example' => 'Device Model', 'title' => ''], ], ], 'responses' => [ @@ -1503,373 +888,222 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '9c7a3b09-a69a-43f5-8bf2-84f7119810eb', - ], - 'RTMPServer' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'ra-service-qa.aicc.aliyun.com', - ], - 'OTP' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'ewga5dxHOB8Lm9VH', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '9c7a3b09-a69a-43f5-8bf2-84f7119810eb', 'title' => ''], + 'DeviceCount' => ['description' => 'The total number of devices.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RTMPServer\\": \\"ra-service-qa.aicc.aliyun.com\\",\\n \\"OTP\\": \\"ewga5dxHOB8Lm9VH\\",\\n \\"RequestId\\": \\"9c7a3b09-a69a-43f5-8bf2-84f7119810eb\\"\\n}","errorExample":"{\\n \\"Code\\":\\"NoPermissionToAccessProject\\",\\n \\"HostId\\":\\"iovcc.cn-shanghai.aliyuncs.com\\",\\n \\"Message\\":\\"User is not authorized to access the specified project.\\",\\n \\"RequestId\\":\\"6F25F67C-F411-499F-BCE2-67CA563CB064\\"\\n}"},{"type":"xml","example":"<DescribeAssistRTMPServerAddressResponse>\\r\\n\\t<RequestId>6F0A833B-7A86-4D92-A083-C184041E2F2D</RequestId>\\r\\n\\t<RTMPServer>ra-rtmp.aicc.aliyun.com</RTMPServer>\\r\\n\\t<OTP>ewga5dxHOB8Lm9VH</OTP>\\r\\n</DescribeAssistRTMPServerAddressResponse>","errorExample":""}]', - 'title' => 'DescribeAssistRTMPServerAddress', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9c7a3b09-a69a-43f5-8bf2-84f7119810eb\\",\\n \\"DeviceCount\\": 100\\n}","type":"json"}]', + 'title' => 'Query total number of devices of a specified model', + 'summary' => 'Queries the total number of devices of a specified model.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'SubmitAssistReport' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [ + ['createdAt' => '2024-06-18T02:20:36.000Z', 'description' => 'Error codes changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'write', - 'systemTags' => [ - 'operationType' => 'create', - ], - 'parameters' => [ - [ - 'name' => 'ProjectId', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'PZ1HK7JZ', - ], - ], - [ - 'name' => 'AssistId', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '510', - ], - ], - [ - 'name' => 'AssistDescription', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '', - ], - ], + 'ramActions' => [ [ - 'name' => 'AssistResult', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '', - ], - ], - [ - 'name' => 'AssistTag', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '', - ], - ], - [ - 'name' => 'AssistReason', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'iovcc:CountDevices', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + ], + 'CountYunIdInfo' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'DeviceModel', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'ModelS', - ], + 'AK' => [], ], ], + 'operationType' => 'read', + 'systemTags' => ['operationType' => 'get'], + 'parameters' => [], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '9c7a3b09-a69a-43f5-8bf2-84f7119810eb', + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'E94C9864-56FB-44AD-AC0C-A1CEFB332254', 'title' => ''], + 'YunIdInfo' => [ + 'description' => 'The cloud device statistics.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'TotalBrandCount' => ['description' => 'The total number of brands.', 'type' => 'integer', 'format' => 'int64', 'example' => '5', 'title' => ''], + 'TotalDeviceCount' => ['description' => 'The total number of activated devices.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], + 'TotalDeviceModelCount' => ['description' => 'The total number of device models.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"9c7a3b09-a69a-43f5-8bf2-84f7119810eb\\"\\n}","errorExample":"{\\n \\"Code\\":\\"NoPermissionToAccessProject\\",\\n \\"HostId\\":\\"iovcc.cn-shanghai.aliyuncs.com\\",\\n \\"Message\\":\\"User is not authorized to access the specified project.\\",\\n \\"RequestId\\":\\"6F25F67C-F411-499F-BCE2-67CA563CB064\\"\\n}"},{"type":"xml","example":"<SubmitAssistReportResponse>\\r\\n\\t<RequestId>6F0A833B-7A86-4D92-A083-C184041E2F2D</RequestId>\\r\\n</SubmitAssistReportResponse>","errorExample":""}]', - 'title' => 'SubmitAssistReport', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E94C9864-56FB-44AD-AC0C-A1CEFB332254\\",\\n \\"YunIdInfo\\": [\\n {\\n \\"TotalBrandCount\\": 5,\\n \\"TotalDeviceCount\\": 100,\\n \\"TotalDeviceModelCount\\": 10\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'Query brand, device model, and device counts under a tenant', + 'summary' => 'Queries the number of brands, device models, and devices under a tenant.', + 'description' => 'Queries the number of brands, device models, and devices under a tenant.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'CreateCustomizedProperty' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [ + ['createdAt' => '2024-06-18T02:20:36.000Z', 'description' => 'Error codes changed'], ], - 'schemes' => [ - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'iovcc:CountYunIdInfo', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + ], + 'CreateAppVersion' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', - 'systemTags' => [ - 'operationType' => 'create', - ], + 'systemTags' => ['operationType' => 'create'], 'parameters' => [ [ - 'name' => 'VersionId', + 'name' => 'IsForceUpgrade', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '1', - ], + 'schema' => ['description' => 'Specifies whether to force the upgrade. Valid values: **Y** | **N**.', 'type' => 'string', 'required' => false, 'example' => 'N', 'title' => ''], + ], + [ + 'name' => 'IsAllowNewInstall', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to allow a fresh installation of the application when it does not exist on the client. This is equivalent to a post-installation.', 'type' => 'string', 'required' => false, 'example' => 'N', 'title' => ''], ], [ 'name' => 'ProjectId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'P0VFCREU', - ], + 'schema' => ['description' => 'The project ID.', 'type' => 'string', 'required' => true, 'example' => 'P0VFCREU', 'title' => ''], ], [ - 'name' => 'Name', + 'name' => 'AppId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'AnotherWhiteList', - ], + 'schema' => ['description' => 'The application ID. Specifies the application to upgrade.', 'type' => 'string', 'required' => false, 'example' => '123', 'title' => ''], ], [ - 'name' => 'Value', + 'name' => 'AppVersion', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '100,200', - ], + 'schema' => ['description' => 'The application version number.', 'type' => 'string', 'required' => false, 'example' => '1.0', 'title' => ''], ], [ - 'name' => 'VersionType', + 'name' => 'VersionCode', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'FOTA', - ], + 'schema' => ['description' => 'The version code of the application.', 'type' => 'string', 'required' => false, 'example' => '100', 'title' => ''], ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '6F25F67C-F411-499F-BCE2-67CA563CB064', - ], - 'CustomizedPropertyId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '1', - ], - ], - ], + [ + 'name' => 'InstallType', + 'in' => 'query', + 'schema' => ['description' => 'The installation type. Valid values: **auto** (automatic) and **customize** (custom).', 'type' => 'string', 'required' => false, 'example' => 'auto', 'title' => ''], ], - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"CustomizedPropertyId\\": \\"1\\",\\n \\"RequestId\\": \\"6F25F67C-F411-499F-BCE2-67CA563CB064\\"\\n}","errorExample":"{\\n \\"RequestId\\": \\"6F25F67C-F411-499F-BCE2-67CA563CB064\\",\\n \\"HostId\\": \\"iovcc.cn-shanghai.aliyuncs.com\\",\\n \\"Code\\": \\"NoPermission.NotOwner\\",\\n \\"Message\\": \\"You have no permission because you are not the owner of the data\\"\\n}"},{"type":"xml","example":"<CreateCustomizedPropertyResponse>\\r\\n\\t<RequestId>7676B259-FFA5-4971-A9D7-7B3F48D1DEEB</RequestId>\\r\\n\\t<CustomizedPropertyId>1</CustomizedPropertyId>\\r\\n</CreateCustomizedPropertyResponse>","errorExample":""}]', - 'title' => 'CreateCustomizedProperty', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'DeleteCustomizedProperty' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'https', - ], - 'security' => [ [ - 'AK' => [], + 'name' => 'Remark', + 'in' => 'query', + 'schema' => ['description' => 'The remarks for the version.', 'type' => 'string', 'required' => false, 'example' => 'sample remark', 'title' => ''], ], - ], - 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'delete', - ], - 'parameters' => [ [ - 'name' => 'ProjectId', + 'name' => 'ReleaseNote', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'P0VFCREU', - ], + 'schema' => ['description' => 'The release notes for the version.', 'type' => 'string', 'required' => false, 'example' => 'sample release note', 'title' => ''], ], [ - 'name' => 'Id', + 'name' => 'IsSilentUpgrade', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '1', - ], + 'schema' => ['description' => 'Specifies whether to perform a silent upgrade. Valid values: **Y** | **N**.', 'type' => 'string', 'required' => false, 'example' => 'N', 'title' => ''], ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '6F25F67C-F411-499F-BCE2-67CA563CB064', - ], - ], - ], + [ + 'name' => 'PackageUrl', + 'in' => 'query', + 'schema' => ['description' => 'The URL of the upgrade package.', 'type' => 'string', 'required' => false, 'example' => 'http://www.oss-server.com/file.zip', 'title' => ''], ], - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"6F25F67C-F411-499F-BCE2-67CA563CB064\\"\\n}","errorExample":"{\\n \\"RequestId\\": \\"6F25F67C-F411-499F-BCE2-67CA563CB064\\",\\n \\"HostId\\": \\"iovcc.cn-shanghai.aliyuncs.com\\",\\n \\"Code\\": \\"NoPermission.NotOwner\\",\\n \\"Message\\": \\"You have no permission because you are not the owner of the data\\"\\n}"},{"type":"xml","example":"<DeleteCustomizedPropertyResponse>\\r\\n\\t<RequestId>6F25F67C-F411-499F-BCE2-67CA563CB064</RequestId>\\r\\n</DeleteCustomizedPropertyResponse>","errorExample":""}]', - 'title' => 'DeleteCustomizedProperty', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'FindCustomizedProperties' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'https', - ], - 'security' => [ [ - 'AK' => [], + 'name' => 'IsNeedRestart', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether a restart is required. Valid values: **Y** | **N**.', 'type' => 'string', 'required' => false, 'example' => 'N', 'title' => ''], ], - ], - 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - ], - 'parameters' => [ [ - 'name' => 'ProjectId', + 'name' => 'BlackVersionList', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'P0VFCREU', - ], + 'schema' => ['description' => 'The version blacklist. Specify multiple version codes separated by commas (,).', 'type' => 'string', 'required' => false, 'example' => '10,20,30', 'title' => ''], ], [ - 'name' => 'VersionId', + 'name' => 'WhiteVersionList', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '1', - ], + 'schema' => ['description' => 'The version whitelist. Specify multiple version codes separated by commas (,).', 'type' => 'string', 'required' => false, 'example' => '10,20,30', 'title' => ''], ], [ - 'name' => 'PageIndex', + 'name' => 'RestartType', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '1', - ], + 'schema' => ['description' => 'The restart type after the application installation is complete. Valid values:'."\n" + ."\n" + .'- **system**: System restart.'."\n" + .'- **app**: Application restart.', 'type' => 'string', 'required' => false, 'example' => 'app', 'title' => ''], ], [ - 'name' => 'PageSize', + 'name' => 'RestartAppType', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '20', - ], + 'schema' => ['description' => 'The type of application restart when RestartType is set to application restart. Valid values:'."\n" + ."\n" + .'- **service**: Service restart.'."\n" + .'- **activity**: Activity restart.', 'type' => 'string', 'required' => false, 'example' => 'service', 'title' => ''], ], [ - 'name' => 'Name', + 'name' => 'RestartAppParam', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'AnotherWhiteList', - ], + 'schema' => ['description' => 'The restart parameters that can be specified by the server when the application restarts.', 'type' => 'string', 'required' => false, 'example' => '{"restartDelay":1}', 'title' => ''], ], [ - 'name' => 'VersionType', + 'name' => 'DeviceAdapterList', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'FOTA', - ], + 'schema' => ['description' => 'The list of compatible device models for the application version.'."\n" + ."\n" + .'Format: `deviceModelId1|minOsVersion1|maxOsVersion1,deviceModelId2|minOsVersion2|maxOsVersion2`, where each entry consists of device model ID|minimum OS version|maximum OS version.', 'type' => 'string', 'required' => false, 'example' => '10|2.0.1-R-20180412.1024|3.0.1-R-20180412.1024,11|2.1.1-R-20180412.1024|3.1.1-R-20180412.1024', 'title' => ''], + ], + [ + 'name' => 'ApkMd5', + 'in' => 'query', + 'schema' => ['description' => 'The MD5 value of the APK.', 'type' => 'string', 'required' => false, 'example' => '34653456wertwe234653retwewer3456', 'title' => ''], ], ], 'responses' => [ @@ -1877,166 +1111,103 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '6F25F67C-F411-499F-BCE2-67CA563CB064', - ], - 'CustomizedPropertyList' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Items' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'GmtCreateTimestamp' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1324320000', - ], - 'Value' => [ - 'description' => '', - 'type' => 'string', - 'example' => '1.0,2.0', - ], - 'GmtCreate' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2018-01-01 00:00:00', - ], - 'Name' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'AnotherWhiteList', - ], - 'Id' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - ], - ], - ], - 'TotalCount' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '30', - ], - ], - ], + 'VersionId' => ['description' => 'The version ID.', 'type' => 'string', 'example' => '12345', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '6F25F67C-F411-499F-BCE2-67CA563CB064', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"6F25F67C-F411-499F-BCE2-67CA563CB064\\",\\n \\"CustomizedPropertyList\\": {\\n \\"TotalCount\\": 30,\\n \\"Items\\": [\\n {\\n \\"GmtCreateTimestamp\\": 1324320000,\\n \\"GmtCreate\\": \\"2018-01-01 00:00:00\\",\\n \\"Value\\": \\"1.0,2.0\\",\\n \\"Name\\": \\"AnotherWhiteList\\",\\n \\"Id\\": 1\\n }\\n ]\\n }\\n}","errorExample":"{\\n \\"RequestId\\": \\"6F25F67C-F411-499F-BCE2-67CA563CB064\\",\\n \\"HostId\\": \\"iovcc.cn-shanghai.aliyuncs.com\\",\\n \\"Code\\": \\"NoPermission.NotOwner\\",\\n \\"Message\\": \\"You have no permission because you are not the owner of the data\\"\\n}"},{"type":"xml","example":"<FindCustomizedPropertiesResponse>\\r\\n\\t<RequestId>6F25F67C-F411-499F-BCE2-67CA563CB064</RequestId>\\r\\n\\t<CustomizedPropertyList>\\r\\n\\t\\t<TotalCount>30</TotalCount>\\r\\n\\t\\t<Items>\\r\\n\\t\\t\\t<Id>1</Id>\\r\\n\\t\\t\\t<Name>AnotherWhiteList</Name>\\r\\n\\t\\t\\t<Value>1.0,2.0</Value>\\r\\n\\t\\t\\t<GmtCreate>2018-01-01 00:00:00</GmtCreate>\\r\\n\\t\\t</Items>\\r\\n\\t</CustomizedPropertyList>\\r\\n</FindCustomizedPropertiesResponse>","errorExample":""}]', - 'title' => 'FindCustomizedProperties', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"VersionId\\": \\"12345\\",\\n \\"RequestId\\": \\"6F25F67C-F411-499F-BCE2-67CA563CB064\\"\\n}","type":"json"}]', + 'title' => 'Create an application upgrade version', + 'summary' => 'Creates an application upgrade version by calling CreateAppVersion.', + 'description' => '> When you need to upgrade an application, first call this operation to create an application version, and then proceed with version testing, canary release, and publishing.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'CreateCustomizedFilter' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [ + ['createdAt' => '2024-06-18T02:20:36.000Z', 'description' => 'Error codes changed'], ], - 'schemes' => [ - 'https', + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'iovcc:CreateAppVersion', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'CreateCustomizedFilter' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', - 'systemTags' => [ - 'operationType' => 'create', - ], + 'systemTags' => ['operationType' => 'create'], 'parameters' => [ [ 'name' => 'VersionType', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'FOTA', - ], + 'schema' => ['description' => 'The version type. Valid values:'."\n" + ."\n" + .'- **FOTA**: system version.'."\n" + .'- **APP**: application version.', 'type' => 'string', 'required' => true, 'example' => 'FOTA', 'title' => ''], ], [ 'name' => 'BlackWhiteType', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'BLACK', - ], + 'schema' => ['description' => 'The blacklists and whitelists type for comparison. Valid values:'."\n" + ."\n" + .'- BLACK: blacklist.'."\n" + .'- WHITE: whitelist.', 'type' => 'string', 'required' => true, 'example' => 'BLACK', 'title' => ''], ], [ 'name' => 'Value', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '1,2,3', - ], + 'schema' => ['description' => 'The value of the filter condition.', 'type' => 'string', 'required' => true, 'example' => '1,2,3', 'title' => ''], ], [ 'name' => 'ProjectId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'P0VFCREU', - ], + 'schema' => ['description' => 'The ID of the project.', 'type' => 'string', 'required' => true, 'example' => 'P0VFCREU', 'title' => ''], ], [ 'name' => 'ValueCompareType', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'NUMBER', - ], + 'schema' => ['description' => 'The comparison type for the value. Valid values:'."\n" + ."\n" + .'- **NUMBER**: compared as a number.'."\n" + .'- **STRING**: compared as a string.', 'type' => 'string', 'required' => true, 'example' => 'NUMBER', 'title' => ''], ], [ 'name' => 'Name', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'AnotherFilter', - ], + 'schema' => ['description' => 'The name of the filter condition.', 'type' => 'string', 'required' => true, 'example' => 'AnotherFilter', 'title' => ''], ], [ 'name' => 'ValueType', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'WRITE', - ], + 'schema' => ['description' => 'The value type of the filter condition.'."\n" + ."\n" + .'Currently, only **WRITE** is supported, which indicates handwriting input.', 'type' => 'string', 'required' => true, 'example' => 'WRITE', 'title' => ''], ], [ 'name' => 'VersionId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '1', - ], + 'schema' => ['description' => 'The ID of the version.', 'type' => 'string', 'required' => true, 'example' => '1', 'title' => ''], ], ], 'responses' => [ @@ -2044,73 +1215,80 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'CustomizedFilterId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '1', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '6F25F67C-F411-499F-BCE2-67CA563CB064', - ], + 'CustomizedFilterId' => ['description' => 'The ID of the custom filter condition.', 'type' => 'string', 'example' => '1', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '6F25F67C-F411-499F-BCE2-67CA563CB064', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"CustomizedFilterId\\": \\"1\\",\\n \\"RequestId\\": \\"6F25F67C-F411-499F-BCE2-67CA563CB064\\"\\n}","errorExample":"{\\n \\"RequestId\\": \\"6F25F67C-F411-499F-BCE2-67CA563CB064\\",\\n \\"HostId\\": \\"iovcc.cn-shanghai.aliyuncs.com\\",\\n \\"Code\\": \\"NoPermission.NotOwner\\",\\n \\"Message\\": \\"You have no permission because you are not the owner of the data\\"\\n}"},{"type":"xml","example":"<CreateCustomizedFilterResponse>\\r\\n\\t<CustomizedFilterId>1</CustomizedFilterId>\\r\\n\\t<RequestId>6F25F67C-F411-499F-BCE2-67CA563CB064</RequestId>\\r\\n</CreateCustomizedFilterResponse>","errorExample":""}]', - 'title' => 'CreateCustomizedFilter', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"CustomizedFilterId\\": \\"1\\",\\n \\"RequestId\\": \\"6F25F67C-F411-499F-BCE2-67CA563CB064\\"\\n}","type":"json"}]', + 'title' => 'Add a custom filter condition to a specified version', + 'summary' => 'Adds a custom filter condition to a specified version to extend the query filtering capabilities of the version.', + 'description' => '> When a device initiates an upgrade query request, the custom filter condition evaluates whether the device can discover the upgrade version based on the custom parameters included in the request and the configured rules. The custom parameter names in the device request must match the custom filter condition names configured for the version.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'DeleteAllCustomizedFilters' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [ + ['createdAt' => '2024-06-18T02:20:36.000Z', 'description' => 'Error codes changed'], ], - 'schemes' => [ - 'https', + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'iovcc:CreateCustomizedFilter', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'CreateCustomizedProperty' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', - 'systemTags' => [ - 'operationType' => 'delete', - ], + 'systemTags' => ['operationType' => 'create'], 'parameters' => [ [ + 'name' => 'VersionId', + 'in' => 'query', + 'schema' => ['description' => 'The version ID.', 'type' => 'string', 'required' => true, 'example' => '1', 'title' => ''], + ], + [ 'name' => 'ProjectId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'P0VFCREU', - ], + 'schema' => ['description' => 'The ID of the project to which the version belongs.', 'type' => 'string', 'required' => true, 'example' => 'P0VFCREU', 'title' => ''], ], [ - 'name' => 'VersionId', + 'name' => 'Name', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '1', - ], + 'schema' => ['description' => 'The name of the custom property.', 'type' => 'string', 'required' => true, 'example' => 'AnotherWhiteList', 'title' => ''], + ], + [ + 'name' => 'Value', + 'in' => 'query', + 'schema' => ['description' => 'The value of the custom property.', 'type' => 'string', 'required' => true, 'example' => '100,200', 'title' => ''], ], [ 'name' => 'VersionType', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'FOTA', - ], + 'schema' => ['description' => 'The version type. Valid values: '."\n" + ."\n" + .'- **FOTA**: system version'."\n" + .'- **APP**: application version.', 'type' => 'string', 'required' => true, 'example' => 'FOTA', 'title' => ''], ], ], 'responses' => [ @@ -2118,58 +1296,72 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '6F25F67C-F411-499F-BCE2-67CA563CB064', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '6F25F67C-F411-499F-BCE2-67CA563CB064', 'title' => ''], + 'CustomizedPropertyId' => ['description' => 'The ID of the created custom property.', 'type' => 'string', 'example' => '1', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"6F25F67C-F411-499F-BCE2-67CA563CB064\\"\\n}","errorExample":"{\\n \\"RequestId\\": \\"6F25F67C-F411-499F-BCE2-67CA563CB064\\",\\n \\"HostId\\": \\"iovcc.cn-shanghai.aliyuncs.com\\",\\n \\"Code\\": \\"NoPermission.NotOwner\\",\\n \\"Message\\": \\"You have no permission because you are not the owner of the data\\"\\n}"},{"type":"xml","example":"<DeleteAllCustomizedFiltersResponse>\\r\\n\\t<RequestId>6F25F67C-F411-499F-BCE2-67CA563CB064</RequestId>\\r\\n</DeleteAllCustomizedFiltersResponse>","errorExample":""}]', - 'title' => 'DeleteAllCustomizedFilters', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6F25F67C-F411-499F-BCE2-67CA563CB064\\",\\n \\"CustomizedPropertyId\\": \\"1\\"\\n}","type":"json"}]', + 'title' => 'Create a custom property', + 'summary' => 'Creates a custom property by calling CreateCustomizedProperty.', + 'description' => '> You can add custom properties to a version. These custom properties are returned in the response for that version, allowing you to attach custom values to the version.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'DeleteCustomizedFilter' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [ + ['createdAt' => '2024-06-18T02:20:36.000Z', 'description' => 'Error codes changed'], ], - 'schemes' => [ - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'iovcc:CreateCustomizedProperty', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + ], + 'CreateDeviceBrand' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'delete', - ], + 'operationType' => 'write', + 'systemTags' => ['operationType' => 'create'], 'parameters' => [ [ 'name' => 'ProjectId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'P0VFCREU', - ], + 'schema' => ['description' => 'The project ID.', 'type' => 'string', 'required' => false, 'example' => 'projectTest', 'title' => ''], ], [ - 'name' => 'Id', + 'name' => 'BrandName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '1', - ], + 'schema' => ['description' => 'The brand name.', 'type' => 'string', 'required' => true, 'example' => 'TmallGenius', 'title' => ''], + ], + [ + 'name' => 'Manufacture', + 'in' => 'query', + 'schema' => ['description' => 'The manufacturer name.', 'type' => 'string', 'required' => false, 'example' => 'Alibaba', 'title' => ''], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => ['description' => 'The brand description.', 'type' => 'string', 'required' => false, 'example' => '天猫精灵', 'title' => ''], ], ], 'responses' => [ @@ -2177,109 +1369,114 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '6F25F67C-F411-499F-BCE2-67CA563CB064', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '9c7a3b09-a69a-43f5-8bf2-84f7119810eb', 'title' => ''], + 'BrandId' => ['description' => 'The ID of the created brand.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"6F25F67C-F411-499F-BCE2-67CA563CB064\\"\\n}","errorExample":"{\\n \\"RequestId\\": \\"6F25F67C-F411-499F-BCE2-67CA563CB064\\",\\n \\"HostId\\": \\"iovcc.cn-shanghai.aliyuncs.com\\",\\n \\"Code\\": \\"NoPermission.NotOwner\\",\\n \\"Message\\": \\"You have no permission because you are not the owner of the data\\"\\n}"},{"type":"xml","example":"<DeleteCustomizedFilterResponse>\\r\\n\\t<RequestId>6F25F67C-F411-499F-BCE2-67CA563CB064</RequestId>\\r\\n</DeleteCustomizedFilterResponse>","errorExample":""}]', - 'title' => 'DeleteCustomizedFilter', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9c7a3b09-a69a-43f5-8bf2-84f7119810eb\\",\\n \\"BrandId\\": 1\\n}","type":"json"}]', + 'title' => 'Create a device brand', + 'summary' => 'Creates a device brand by calling CreateDeviceBrand.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'UpdateCustomizedFilter' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [ + ['createdAt' => '2024-06-18T02:20:36.000Z', 'description' => 'Error codes changed'], ], - 'schemes' => [ - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'iovcc:CreateDeviceBrand', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + ], + 'CreateDeviceModel' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'update', - ], + 'operationType' => 'write', + 'systemTags' => ['operationType' => 'create'], 'parameters' => [ [ - 'name' => 'BlackWhiteType', + 'name' => 'InitUsageType', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'BLACK', - ], + 'schema' => ['description' => 'The initial usage type of the device. Valid values:'."\n" + ."\n" + .'- **0**: personal device.'."\n" + .'- **1**: commercial or shared device.', 'type' => 'string', 'required' => false, 'example' => '0', 'title' => ''], ], [ - 'name' => 'ProjectId', + 'name' => 'CanCreateDeviceId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'P0VFCREU', - ], + 'schema' => ['description' => 'Specifies whether the model is allowed to create device IDs.', 'type' => 'string', 'required' => false, 'example' => 'true', 'title' => ''], ], [ - 'name' => 'Name', + 'name' => 'ModelName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'AnotherFilter', - ], + 'schema' => ['description' => 'The device model name.', 'type' => 'string', 'required' => false, 'example' => 'X1', 'title' => ''], ], [ - 'name' => 'Value', + 'name' => 'HardwareType', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '1,4', - ], + 'schema' => ['description' => 'The basis for generating device IDs.', 'type' => 'string', 'required' => false, 'example' => 'sn', 'title' => ''], ], [ - 'name' => 'ValueType', + 'name' => 'BrandName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'WRITE', - ], + 'schema' => ['description' => 'The brand name.', 'type' => 'string', 'required' => false, 'example' => 'TmallGenius', 'title' => ''], ], [ - 'name' => 'ValueCompareType', + 'name' => 'Description', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'NUMBER', - ], + 'schema' => ['description' => 'The model description.', 'type' => 'string', 'required' => false, 'example' => '天猫精灵X1', 'title' => ''], ], [ - 'name' => 'Id', + 'name' => 'DeviceType', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1', - ], + 'schema' => ['description' => 'The device type.', 'type' => 'string', 'required' => false, 'example' => '智能音箱', 'title' => ''], + ], + [ + 'name' => 'ProjectId', + 'in' => 'query', + 'schema' => ['description' => 'The project ID.', 'type' => 'string', 'required' => false, 'example' => 'projectTest', 'title' => ''], + ], + [ + 'name' => 'SecurityChip', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to enable chip ID2 authentication hardening.', 'type' => 'string', 'required' => false, 'example' => '0', 'title' => ''], + ], + [ + 'name' => 'OsPlatform', + 'in' => 'query', + 'schema' => ['description' => 'The operating system platform.', 'type' => 'string', 'required' => false, 'example' => 'android', 'title' => ''], + ], + [ + 'name' => 'ObjectKey', + 'in' => 'query', + 'schema' => ['description' => 'The OSS storage key.', 'type' => 'string', 'required' => false, 'example' => '1151125281886341/375KZRO8TARYBQY7P0E4/2019-04-12/1555062240807.jpg', 'title' => ''], + ], + [ + 'name' => 'DeviceName', + 'in' => 'query', + 'schema' => ['description' => 'The device name.', 'type' => 'string', 'required' => false, 'example' => 'device', 'title' => ''], ], ], 'responses' => [ @@ -2287,58 +1484,75 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '6F25F67C-F411-499F-BCE2-67CA563CB064', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '9c7a3b09-a69a-43f5-8bf2-84f7119810eb', 'title' => ''], + 'DeviceModelId' => ['description' => 'The ID of the newly created device model.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"6F25F67C-F411-499F-BCE2-67CA563CB064\\"\\n}","errorExample":"{\\n \\"RequestId\\": \\"6F25F67C-F411-499F-BCE2-67CA563CB064\\",\\n \\"HostId\\": \\"iovcc.cn-shanghai.aliyuncs.com\\",\\n \\"Code\\": \\"NoPermission.NotOwner\\",\\n \\"Message\\": \\"You have no permission because you are not the owner of the data\\"\\n}"},{"type":"xml","example":"<UpdateCustomizedFilterResponse>\\r\\n\\t<RequestId>6F25F67C-F411-499F-BCE2-67CA563CB064</RequestId>\\r\\n</UpdateCustomizedFilterResponse>","errorExample":""}]', - 'title' => 'UpdateCustomizedFilter', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9c7a3b09-a69a-43f5-8bf2-84f7119810eb\\",\\n \\"DeviceModelId\\": 10\\n}","type":"json"}]', + 'title' => 'Create a new device model', + 'summary' => 'Creates a new device model by calling CreateDeviceModel.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'DescribeCustomizedFilter' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [ + ['createdAt' => '2024-06-18T02:20:36.000Z', 'description' => 'Error codes changed'], + ], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'iovcc:CreateDeviceModel', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'CreateNamespace' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - ], + 'operationType' => 'write', + 'systemTags' => ['operationType' => 'create'], 'parameters' => [ [ 'name' => 'ProjectId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'P0VFCREU', - ], + 'schema' => ['description' => 'The project ID.', 'type' => 'string', 'required' => true, 'example' => 'PIY3UB0T', 'title' => ''], ], [ - 'name' => 'Id', + 'name' => 'AuthType', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '1', - ], + 'schema' => ['description' => 'The data space partitioning and authentication method.'."\n" + ."\n" + .'- **1**: account-based'."\n" + .'- **2**: device-based'."\n" + .'- **101**: account and device-based.', 'type' => 'string', 'required' => true, 'example' => '101', 'title' => ''], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => ['description' => 'The namespace name.', 'type' => 'string', 'required' => true, 'example' => 'user_data', 'title' => ''], + ], + [ + 'name' => 'Desc', + 'in' => 'query', + 'schema' => ['description' => 'The namespace description.', 'type' => 'string', 'required' => true, 'example' => '存储用户数据', 'title' => ''], ], ], 'responses' => [ @@ -2346,170 +1560,148 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'CustomizedFilter' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'GmtCreateTimestamp' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '123543500000', - ], - 'GmtModify' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2018-01-01 00:01:00', - ], - 'ValueCompareType' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'NUMBER', - ], - 'VersionId' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'GmtModifyTimestamp' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '123543500000', - ], - 'Value' => [ - 'description' => '', - 'type' => 'string', - 'example' => '1,5', - ], - 'ValueType' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'WRITE', - ], - 'GmtCreate' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2018-01-01 00:00:00', - ], - 'BlackWhiteType' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'BLACK', - ], - 'Name' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'AnotherFilter', - ], - 'VersionType' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'FOTA', - ], - 'Id' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - ], - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '6F25F67C-F411-499F-BCE2-67CA563CB064', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'E94C9864-56FB-44AD-AC0C-A1CEFB332254', 'title' => ''], + 'Namespace' => ['description' => 'The unique identifier of the namespace.', 'type' => 'string', 'example' => 'cc6c29893f2be7d465db44ec7b5d593e', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"6F25F67C-F411-499F-BCE2-67CA563CB064\\",\\n \\"CustomizedFilter\\": {\\n \\"GmtCreateTimestamp\\": 123543500000,\\n \\"GmtModify\\": \\"2018-01-01 00:01:00\\",\\n \\"ValueCompareType\\": \\"NUMBER\\",\\n \\"VersionId\\": 1,\\n \\"GmtModifyTimestamp\\": 123543500000,\\n \\"Value\\": \\"1,5\\",\\n \\"GmtCreate\\": \\"2018-01-01 00:00:00\\",\\n \\"ValueType\\": \\"WRITE\\",\\n \\"BlackWhiteType\\": \\"BLACK\\",\\n \\"Name\\": \\"AnotherFilter\\",\\n \\"Id\\": 1,\\n \\"VersionType\\": \\"FOTA\\"\\n }\\n}","errorExample":"{\\n \\"RequestId\\": \\"6F25F67C-F411-499F-BCE2-67CA563CB064\\",\\n \\"HostId\\": \\"iovcc.cn-shanghai.aliyuncs.com\\",\\n \\"Code\\": \\"NoPermission.NotOwner\\",\\n \\"Message\\": \\"You have no permission because you are not the owner of the data\\"\\n}"},{"type":"xml","example":"<DescribeCustomizedFilterResponse>\\r\\n\\t<RequestId>6F25F67C-F411-499F-BCE2-67CA563CB064</RequestId>\\r\\n\\t<CustomizedFilter>\\r\\n\\t\\t<Id>1</Id>\\r\\n\\t\\t<Name>AnotherWhiteList</Name>\\r\\n\\t\\t<VersionType>1.0,2.0</VersionType>\\r\\n\\t\\t<VersionId>1</VersionId>\\r\\n\\t\\t<ValueCompareType>NUMBER</ValueCompareType>\\r\\n\\t\\t<BlackWhiteType>BLACK</BlackWhiteType>\\r\\n\\t\\t<Value>1,5</Value>\\r\\n\\t\\t<ValueType>WRITE</ValueType>\\r\\n\\t\\t<GmtCreate>2018-01-01 00:00:00</GmtCreate>\\r\\n\\t\\t<GmtModify>2018-01-01 00:01:00</GmtModify>\\r\\n\\t</CustomizedFilter>\\r\\n</DescribeCustomizedFilterResponse>","errorExample":""}]', - 'title' => 'DescribeCustomizedFilter', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E94C9864-56FB-44AD-AC0C-A1CEFB332254\\",\\n \\"Namespace\\": \\"cc6c29893f2be7d465db44ec7b5d593e\\"\\n}","type":"json"}]', + 'title' => 'Create a namespace', + 'summary' => 'Calls CreateNamespace to create a data storage namespace.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'FindCustomizedFilters' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [ + ['createdAt' => '2024-06-18T02:20:36.000Z', 'description' => 'Error codes changed'], ], - 'schemes' => [ - 'https', + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'iovcc:CreateNamespace', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'CreateOsVersion' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - ], + 'operationType' => 'write', + 'systemTags' => ['operationType' => 'create'], 'parameters' => [ [ + 'name' => 'IsForceNightUpgrade', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to force a night upgrade. Valid values: **Y | N**.'."\n" + ."\n" + .'This parameter and IsForceUpgrade cannot both be set to Y at the same time.', 'type' => 'string', 'required' => true, 'example' => 'N', 'title' => ''], + ], + [ + 'name' => 'MaxClientVersion', + 'in' => 'query', + 'schema' => ['description' => 'The maximum version code of the OTA SDK allowed.', 'type' => 'string', 'required' => false, 'example' => '1200', 'title' => ''], + ], + [ 'name' => 'ProjectId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'P0VFCREU', - ], + 'schema' => ['description' => 'The project ID.', 'type' => 'string', 'required' => true, 'example' => 'P0VFCREU', 'title' => ''], ], [ - 'name' => 'VersionId', + 'name' => 'DeviceModelId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '1', - ], + 'schema' => ['description' => 'The device model ID.', 'type' => 'string', 'required' => true, 'example' => '12', 'title' => ''], ], [ - 'name' => 'PageIndex', + 'name' => 'SystemVersion', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '1', - ], + 'schema' => ['description' => 'The system version number.', 'type' => 'string', 'required' => true, 'example' => '2.0.1-R-20180501.1208', 'title' => ''], ], [ - 'name' => 'PageSize', + 'name' => 'ReleaseNote', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '20', - ], + 'schema' => ['description' => 'The release notes for the version.', 'type' => 'string', 'required' => false, 'example' => '改用UI用户体验，提升系统稳定性', 'title' => ''], ], [ - 'name' => 'Name', + 'name' => 'Remark', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'AnotherFilter', - ], + 'schema' => ['description' => 'The remarks.', 'type' => 'string', 'required' => false, 'example' => '版本备注信息，终端设备不可见', 'title' => ''], ], [ - 'name' => 'VersionType', + 'name' => 'BlackVersionList', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'FOTA', - ], + 'schema' => ['description' => 'The blacklist of system versions, separated by commas (,).', 'type' => 'string', 'required' => false, 'example' => '2.0.1-R-20180501.1208,2.0.1-R-20180501.1209', 'title' => ''], + ], + [ + 'name' => 'IsMilestone', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether this is a milestone version. Valid values: **Y | N**.', 'type' => 'string', 'required' => true, 'example' => 'N', 'title' => ''], + ], + [ + 'name' => 'MinClientVersion', + 'in' => 'query', + 'schema' => ['description' => 'The minimum version code of the OTA SDK allowed.', 'type' => 'string', 'required' => false, 'example' => '1100', 'title' => ''], + ], + [ + 'name' => 'WhiteVersionList', + 'in' => 'query', + 'schema' => ['description' => 'The whitelist of system versions, separated by commas (,).', 'type' => 'string', 'required' => false, 'example' => '2.0.1-R-20180501.1208,2.0.1-R-20180501.1209', 'title' => ''], + ], + [ + 'name' => 'IsForceUpgrade', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to force an upgrade. Valid values: **Y | N**.', 'type' => 'string', 'required' => true, 'example' => 'N', 'title' => ''], + ], + [ + 'name' => 'NightUpgradeDownloadType', + 'in' => 'query', + 'schema' => ['description' => 'The download type for night upgrades. A value of 1 indicates download over Wi-Fi only. A value of 2 indicates download over any network.', 'type' => 'string', 'required' => true, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'NightUpgradeIsShowTip', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to display a prompt dialog box during a night upgrade. Valid values: **Y | N**.', 'type' => 'string', 'required' => true, 'example' => 'N', 'title' => ''], + ], + [ + 'name' => 'NightUpgradeIsAllowedCancel', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether the night upgrade can be canceled. Valid values: **Y | N**.', 'type' => 'string', 'required' => true, 'example' => 'N', 'title' => ''], + ], + [ + 'name' => 'RomList', + 'in' => 'query', + 'schema' => ['description' => 'The list of upgrade packages, including full and incremental packages, in the format `baseVersion|romUrl,baseVersion|romUrl`.'."\n" + ."\n" + .'**baseVersion** is the baseline version.'."\n" + ."\n" + .'- If the package is a full package, set the baseline version to 0.'."\n" + .'- If the package is an incremental package, set the baseline version to the baseline system version number.', 'type' => 'string', 'required' => true, 'example' => '0|http://www.oss-server.com/file1.zip,2.0.1|http://www.oss-server.com/file2.zip', 'title' => ''], + ], + [ + 'name' => 'EnableMobileDownload', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to allow downloading upgrade packages over a mobile network. Valid values: **Y | N**.', 'type' => 'string', 'required' => true, 'example' => 'Y', 'title' => ''], + ], + [ + 'name' => 'MobileDownloadMaxSize', + 'in' => 'query', + 'schema' => ['description' => 'The maximum size of packages allowed for download over a mobile network, in MB. When mobile network download is allowed, packages larger than this limit are not automatically downloaded.', 'type' => 'string', 'required' => false, 'example' => '10', 'title' => ''], ], ], 'responses' => [ @@ -2517,118 +1709,72 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'CustomizedFilterList' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Items' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'GmtModifyTimestamp' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '12354350000', - ], - 'GmtCreateTimestamp' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '12354350000', - ], - 'Value' => [ - 'description' => '', - 'type' => 'string', - 'example' => '1,4', - ], - 'GmtModify' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2018-01-01 00:01:00', - ], - 'ValueCompareType' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'NUMBER', - ], - 'GmtCreate' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2018-01-01 00:00:00', - ], - 'BlackWhiteType' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'BLACK', - ], - 'Name' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'AnotherFilter', - ], - 'Id' => [ - 'description' => 'ID', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - ], - ], - ], - 'TotalCount' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '30', - ], - ], - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '6F25F67C-F411-499F-BCE2-67CA563CB064', - ], + 'VersionId' => ['description' => 'The ID of the created version.', 'type' => 'string', 'example' => '12345', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '6F25F67C-F411-499F-BCE2-67CA563CB064', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"6F25F67C-F411-499F-BCE2-67CA563CB064\\",\\n \\"CustomizedFilterList\\": {\\n \\"TotalCount\\": 30,\\n \\"Items\\": [\\n {\\n \\"GmtModifyTimestamp\\": 12354350000,\\n \\"GmtCreateTimestamp\\": 12354350000,\\n \\"Value\\": \\"1,4\\",\\n \\"GmtModify\\": \\"2018-01-01 00:01:00\\",\\n \\"ValueCompareType\\": \\"NUMBER\\",\\n \\"GmtCreate\\": \\"2018-01-01 00:00:00\\",\\n \\"BlackWhiteType\\": \\"BLACK\\",\\n \\"Name\\": \\"AnotherFilter\\",\\n \\"Id\\": 1\\n }\\n ]\\n }\\n}","errorExample":"{\\n \\"RequestId\\": \\"6F25F67C-F411-499F-BCE2-67CA563CB064\\",\\n \\"HostId\\": \\"iovcc.cn-shanghai.aliyuncs.com\\",\\n \\"Code\\": \\"NoPermission.NotOwner\\",\\n \\"Message\\": \\"You have no permission because you are not the owner of the data\\"\\n}"},{"type":"xml","example":"<FindCustomizedFiltersResponse>\\r\\n\\t<CustomizedFilterList>\\r\\n\\t\\t<Items>\\r\\n\\t\\t\\t<BlackWhiteType>BLACK</BlackWhiteType>\\r\\n\\t\\t\\t<GmtCreate>2018-01-01 00:00:00</GmtCreate>\\r\\n\\t\\t\\t<GmtModify>2018-01-01 00:01:00</GmtModify>\\r\\n\\t\\t\\t<Id>1</Id>\\r\\n\\t\\t\\t<Name>AnotherList</Name>\\r\\n\\t\\t\\t<Value>1,5</Value>\\r\\n\\t\\t\\t<ValueCompareType>NUMBER</ValueCompareType>\\r\\n\\t\\t</Items>\\r\\n\\t\\t<TotalCount>30</TotalCount>\\r\\n\\t</CustomizedFilterList>\\r\\n\\t<RequestId>6F25F67C-F411-499F-BCE2-67CA563CB064</RequestId>\\r\\n</FindCustomizedFiltersResponse>","errorExample":""}]', - 'title' => 'FindCustomizedFilters', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"VersionId\\": \\"12345\\",\\n \\"RequestId\\": \\"6F25F67C-F411-499F-BCE2-67CA563CB064\\"\\n}","type":"json"}]', + 'title' => 'Create a system upgrade version', + 'summary' => 'Calls CreateOsVersion to create a system upgrade version.', + 'description' => '> When you need to perform an over-the-air update (system upgrade), invoke this operation to create a system version first, and then proceed with version testing, grayscale, and publishing.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'ListClientSdks' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [ + ['createdAt' => '2024-06-18T02:20:35.000Z', 'description' => 'Error codes changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'iovcc:CreateOsVersion', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'CreateProjectApp' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'list', - ], + 'operationType' => 'write', + 'systemTags' => ['operationType' => 'create'], 'parameters' => [ [ + 'name' => 'ProjectId', + 'in' => 'query', + 'schema' => ['description' => 'The project ID.', 'type' => 'string', 'required' => true, 'example' => 'P0VFCREU', 'title' => ''], + ], + [ + 'name' => 'AppName', + 'in' => 'query', + 'schema' => ['description' => 'The application name.', 'type' => 'string', 'required' => true, 'example' => 'calendar', 'title' => ''], + ], + [ + 'name' => 'AppPkgName', + 'in' => 'query', + 'schema' => ['description' => 'The package name of the application.', 'type' => 'string', 'required' => true, 'example' => 'com.demo.calendar', 'title' => ''], + ], + [ 'name' => 'OsType', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '1', - ], + 'schema' => ['description' => 'The operating system type. Valid values: 1: Android.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1', 'title' => ''], ], ], 'responses' => [ @@ -2636,149 +1782,106 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'ClientSdks' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'OsType' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'GmtCreate' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1512976910000', - ], - 'GmtModified' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1512976910000', - ], - 'Name' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'AiCCSDK-FOTA', - ], - 'PkgName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'null', - ], - 'PkgType' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'Id' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '6', - ], - ], - ], - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'D1BE8AC4-BE5B-4B04-B78B-A64C6BDB2AC2', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '629586FE-CB2E-4742-995E-121F952CEB72', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"D1BE8AC4-BE5B-4B04-B78B-A64C6BDB2AC2\\",\\n \\"ClientSdks\\": [\\n {\\n \\"OsType\\": 1,\\n \\"GmtCreate\\": 1512976910000,\\n \\"GmtModified\\": 1512976910000,\\n \\"Name\\": \\"AiCCSDK-FOTA\\",\\n \\"PkgName\\": \\"null\\",\\n \\"PkgType\\": 0,\\n \\"Id\\": 6\\n }\\n ]\\n}","errorExample":"{\\n \\"RequestId\\": \\"6F25F67C-F411-499F-BCE2-67CA563CB064\\",\\n \\"HostId\\": \\"iovcc.cn-shanghai.aliyuncs.com\\",\\n \\"Code\\": \\"InvalidTenant\\",\\n \\"Message\\": \\"User is not a valid tenant\\"\\n}"},{"type":"xml","example":"<ListClientSdksResponse>\\r\\n\\t<ClientSdks>\\r\\n\\t\\t<Name>AiCCSDK-FOTA</Name>\\r\\n\\t\\t<OsType>1</OsType>\\r\\n\\t\\t<PkgName></PkgName>\\r\\n\\t\\t<Id>6</Id>\\r\\n\\t\\t<GmtCreate>1512976910000</GmtCreate>\\r\\n\\t\\t<GmtModified>1512976910000</GmtModified>\\r\\n\\t\\t<PkgType>0</PkgType>\\r\\n\\t</ClientSdks>\\r\\n\\t<ClientSdks>\\r\\n\\t\\t<Name>AiCCSDK-SyncStore</Name>\\r\\n\\t\\t<OsType>1</OsType>\\r\\n\\t\\t<PkgName></PkgName>\\r\\n\\t\\t<Id>9</Id>\\r\\n\\t\\t<GmtCreate>1513309968000</GmtCreate>\\r\\n\\t\\t<GmtModified>1513309968000</GmtModified>\\r\\n\\t\\t<PkgType>0</PkgType>\\r\\n\\t</ClientSdks>\\r\\n\\t<RequestId>D1BE8AC4-BE5B-4B04-B78B-A64C6BDB2AC2</RequestId>\\r\\n</ListClientSdksResponse>","errorExample":""}]', - 'title' => 'ListClientSdks', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"629586FE-CB2E-4742-995E-121F952CEB72\\"\\n}","type":"json"}]', + 'title' => 'Create an application under a project', + 'summary' => 'Creates an application under a project by calling CreateProjectApp.', + 'description' => '> There is no limit on the number of applications that can be created under a project. The applications here refer to client applications. Currently, only Android applications are supported.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'GenerateSdkDownloadInfo' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [ + ['createdAt' => '2023-08-21T07:11:21.000Z', 'description' => 'Error codes changed'], + ], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'iovcc:CreateProjectApp', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'CreateRpcService' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - ], + 'operationType' => 'write', + 'systemTags' => ['operationType' => 'create'], 'parameters' => [ [ - 'name' => 'Sdks', + 'name' => 'ProjectId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'AiCCSDK-FOTA,AiCCSDK-CMNS', - ], + 'schema' => ['description' => 'The project ID of IoVCC.', 'type' => 'string', 'required' => true, 'example' => 'ftewtwyy', 'title' => ''], ], [ - 'name' => 'AppId', + 'name' => 'AppKey', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'A3BU0HBO', - ], + 'schema' => ['description' => 'The AppKey of the IoVCC CMNS application. This is the unique identifier of the application.', 'type' => 'string', 'required' => true, 'example' => 'WH2MptXX', 'title' => ''], ], [ - 'name' => 'OsType', + 'name' => 'InterfaceName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '1', - ], + 'schema' => ['description' => 'The name of the service interface.'."\n" + ."\n" + .'For HTTP interfaces, specify the request URL without parameters. Example: `https://www.aliyun.com/rpcServiceTest`.', 'type' => 'string', 'required' => true, 'example' => 'http://www.aliyun.com/aicc/testRpc', 'title' => ''], ], [ - 'name' => 'PkgName', + 'name' => 'InvokeType', 'in' => 'query', 'schema' => [ - 'description' => '', + 'description' => 'The invocation type of the interface.'."\n" + ."\n" + .'Valid values: http (including https) and hsf. HSF interfaces must be deployed in the same VPC as the IoVCC service.', 'type' => 'string', 'required' => true, - 'example' => 'com.test.app', + 'enum' => ['http', 'hsf'], + 'example' => 'http', + 'title' => '', ], ], [ - 'name' => 'ProjectId', + 'name' => 'Params', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '11', - ], + 'schema' => ['description' => '- For HTTP invokes, separate parameter keys with commas (,). Example: `param1,param2`.'."\n" + .'- For HSF invokes, separate parameter types with commas (,). Only the following seven primitive data types are supported: string, int, long, bytes, double, float, and bool. Example: `string,int,long`.', 'type' => 'string', 'required' => true, 'example' => 'param1,param2', 'title' => ''], ], [ - 'name' => 'CertFileObjectKey', + 'name' => 'GroupName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '1768723179523459/11/2018-05-07/1525699039841.rsa', - ], + 'schema' => ['description' => 'The group name of the server-side interface.', 'type' => 'string', 'required' => false, 'example' => 'rpcTestGroup', 'title' => ''], + ], + [ + 'name' => 'MethodName', + 'in' => 'query', + 'schema' => ['description' => 'The method name of the interface invocation. The name consists of letters, digits, and underscores (_).'."\n" + ."\n" + .'- If the invocation type is **http**, the name is custom-defined by the service provider.'."\n" + .'- If the invocation type is **hsf**, the name is the HSF interface method name.', 'type' => 'string', 'required' => true, 'example' => 'testMethodName', 'title' => ''], + ], + [ + 'name' => 'VersionCode', + 'in' => 'query', + 'schema' => ['description' => 'The version number of the interface. This value is custom-defined by the service provider.', 'type' => 'string', 'required' => false, 'example' => '1.0', 'title' => ''], ], ], 'responses' => [ @@ -2786,90 +1889,72 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'F3BAE77D-1954-48C5-95F6-D4937B29E2F4', - ], - 'SdkDownloadInfo' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Url' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'http://iovcc-pm-tenant.oss-cn-shanghai.aliyuncs.com/1768723179523459/11/2018-05-07/aicc-sdk-1525699039841.zip?OSSAccessKeyId=nz2pc56s936**9l&Expires=1141889120&Signature=vjbyPxybdZaNmGa%2ByT272YEAiv4%3D', - ], - ], - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '629586FE-CB2E-4742-995E-121F952CEB72', 'title' => ''], + 'Id' => ['description' => 'The ID of the RPC service interface.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"F3BAE77D-1954-48C5-95F6-D4937B29E2F4\\",\\n \\"SdkDownloadInfo\\": {\\n \\"Url\\": \\"http://iovcc-pm-tenant.oss-cn-shanghai.aliyuncs.com/1768723179523459/11/2018-05-07/aicc-sdk-1525699039841.zip?OSSAccessKeyId=nz2pc56s936**9l&Expires=1141889120&Signature=vjbyPxybdZaNmGa%2ByT272YEAiv4%3D\\"\\n }\\n}","errorExample":"{\\n \\"RequestId\\": \\"6F25F67C-F411-499F-BCE2-67CA563CB064\\",\\n \\"HostId\\": \\"iovcc.cn-shanghai.aliyuncs.com\\",\\n \\"Code\\": \\"NotFoundProject\\",\\n \\"Message\\": \\"Cannot find the specified project\\"\\n}"},{"type":"xml","example":"<GenerateSdkDownloadInfoResponse>\\r\\n\\t<RequestId>F3BAE77D-1954-48C5-95F6-D4937B29E2F4</RequestId>\\r\\n\\t<SdkDownloadInfo>\\r\\n\\t\\t<Url>http://iovcc-pm-tenant.oss-cn-shanghai.aliyuncs.com/1768723179523459/11/2018-05-07/aicc-sdk-1525699039841.zip?OSSAccessKeyId=nz2pc56s936**9l&Expires=1141889120&Signature=vjbyPxybdZaNmGa%2ByT272YEAiv4%3D</Url>\\r\\n\\t</SdkDownloadInfo>\\r\\n</GenerateSdkDownloadInfoResponse>","errorExample":""}]', - 'title' => 'GenerateSdkDownloadInfo', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"629586FE-CB2E-4742-995E-121F952CEB72\\",\\n \\"Id\\": 1\\n}","type":"json"}]', + 'title' => 'Register a CMNS RPC service interface', + 'summary' => 'Registers an RPC service interface based on the CMNS application AppKey, interface name, and interface parameter types.', + 'description' => '> Service interfaces can be exposed through HTTP or HSF.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'CreateSchemaSubscribe' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [ + ['createdAt' => '2024-06-18T02:20:35.000Z', 'description' => 'Error codes changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'iovcc:CreateRpcService', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'CreateSchemaSubscribe' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', - 'systemTags' => [ - 'operationType' => 'create', - ], + 'systemTags' => ['operationType' => 'create'], 'parameters' => [ [ 'name' => 'DeviceModel', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'model_2nd', - ], + 'schema' => ['description' => 'The device name.', 'type' => 'string', 'required' => true, 'example' => 'model_2nd', 'title' => ''], ], [ 'name' => 'SubscribeList', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '', - ], + 'schema' => ['description' => 'The subscription list.', 'type' => 'string', 'required' => false, 'example' => '[{\\"path\\":\\"/car_body_hvac/cooling/water_temperature\\",\\"description\\":\\"水温\\",\\"required\\":false,\\"type\\":\\"number\\",\\"minimum\\":20,\\"exclusiveMinimum\\":false,\\"maximum\\":30,\\"exclusiveMaximum\\":false},{\\"path\\":\\"/car_body_hvac/lubricating/oil_level\\",\\"description\\":\\"机油油位\\",\\"required\\":false,\\"type\\":\\"number\\",\\"minimum\\":3,\\"exclusiveMinimum\\":false,\\"maximum\\":6,\\"exclusiveMaximum\\":false}]', 'title' => ''], ], [ 'name' => 'ProjectId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'PIC3UA0V', - ], + 'schema' => ['description' => 'The project ID.', 'type' => 'string', 'required' => true, 'example' => 'PIC3UA0V', 'title' => ''], ], [ 'name' => 'SchemaVersion', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '1.0', - ], + 'schema' => ['description' => 'The version.', 'type' => 'string', 'required' => false, 'example' => '1.0', 'title' => ''], ], ], 'responses' => [ @@ -2877,59 +1962,75 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '6F25F67C-F411-499F-BCE2-67CA563CB064', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '6F25F67C-F411-499F-BCE2-67CA563CB064', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"6F25F67C-F411-499F-BCE2-67CA563CB064\\"\\n}","errorExample":"{\\n \\"RequestId\\": \\"6F25F67C-F411-499F-BCE2-67CA563CB064\\",\\n \\"HostId\\": \\"iovcc.cn-shanghai.aliyuncs.com\\",\\n \\"Code\\": \\"InvalidTenant\\",\\n \\"Message\\": \\"User is not a valid tenant\\"\\n}"},{"type":"xml","example":"<CreateSchemaSubscribeResponse>\\r\\n <RequestId>6F25F67C-F411-499F-BCE2-67CA563CB064</RequestId>\\r\\n</CreateSchemaSubscribeResponse>","errorExample":""}]', - 'title' => 'CreateSchemaSubscribe', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6F25F67C-F411-499F-BCE2-67CA563CB064\\"\\n}","type":"json"}]', + 'title' => 'Create subscription information', + 'summary' => 'Creates subscription information by calling CreateSchemaSubscribe.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'DeleteSchemaSubscribe' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [ + ['createdAt' => '2024-06-18T02:20:35.000Z', 'description' => 'Error codes changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'iovcc:CreateSchemaSubscribe', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'CreateShadowSchema' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', - 'systemTags' => [ - 'operationType' => 'delete', - ], + 'systemTags' => ['operationType' => 'create'], 'parameters' => [ [ - 'name' => 'Id', + 'name' => 'DeviceModelId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '12', - ], + 'schema' => ['description' => 'The device model ID.', 'type' => 'string', 'required' => true, 'example' => '120', 'title' => ''], + ], + [ + 'name' => 'AuthType', + 'in' => 'query', + 'schema' => ['description' => 'The authentication type.', 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'Namespace', + 'in' => 'query', + 'schema' => ['description' => 'The namespace.', 'type' => 'string', 'required' => false, 'example' => 'b09e93ce436aaf0dcfc2fb2004c1fde8', 'title' => ''], ], [ 'name' => 'ProjectId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'PIC3UA0V', - ], + 'schema' => ['description' => 'The project ID.', 'type' => 'string', 'required' => true, 'example' => 'PIC3UA0V', 'title' => ''], + ], + [ + 'name' => 'Schema', + 'in' => 'query', + 'schema' => ['description' => 'The schema information.', 'type' => 'string', 'required' => false, 'example' => '{"ecu":{"node_desc":"动力系统","brake_controll":{"handbrake":"手刹状态"}},"device_info":{"vin":"车架号","uuid":"uuid","brand":"设备品牌","plugin_version":{"ra":"远程诊断","control":"远程控制","node_desc":"插件版本号","yundevice":"yundevice版本号"},"system_version":"系统版本号"},"car_body_hvac":{"node_desc":"车身与HVAC","cigar_lighter":{"node_desc":"点烟器"},"cleaning_fluid":"清洗液"}}', 'title' => ''], ], ], 'responses' => [ @@ -2937,79 +2038,103 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '6F25F67C-F411-499F-BCE2-67CA563CB064', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '629586FE-CB2E-4742-995E-121F952CEB72', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"6F25F67C-F411-499F-BCE2-67CA563CB064\\"\\n}","errorExample":"{\\n \\"RequestId\\": \\"6F25F67C-F411-499F-BCE2-67CA563CB064\\",\\n \\"HostId\\": \\"iovcc.cn-shanghai.aliyuncs.com\\",\\n \\"Code\\": \\"InvalidTenant\\",\\n \\"Message\\": \\"User is not a valid tenant\\"\\n}"},{"type":"xml","example":"<DeleteSchemaSubscribeResponse>\\r\\n<RequestId>6F25F67C-F411-499F-BCE2-67CA563CB064</RequestId>\\r\\n</DeleteSchemaSubscribeResponse>","errorExample":""}]', - 'title' => 'DeleteSchemaSubscribe', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"629586FE-CB2E-4742-995E-121F952CEB72\\"\\n}","type":"json"}]', + 'title' => 'Create schema information for a device model', + 'summary' => 'Creates schema information for a specified device model by calling CreateShadowSchema.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'UpdateSchemaSubscribe' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [ + ['createdAt' => '2024-06-18T02:20:35.000Z', 'description' => 'Error codes changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'iovcc:CreateShadowSchema', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + ], + 'CreateTrigger' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', - 'systemTags' => [ - 'operationType' => 'update', - ], + 'systemTags' => ['operationType' => 'create'], 'parameters' => [ [ - 'name' => 'DeviceModel', + 'name' => 'ProjectId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'model_2nd', - ], + 'schema' => ['description' => 'The project ID.', 'type' => 'string', 'required' => true, 'example' => 'PE9FQC48', 'title' => ''], ], [ - 'name' => 'SubscribeList', + 'name' => 'Namespace', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '', - ], + 'schema' => ['description' => 'The namespace, such as the namespace of syncstore.', 'type' => 'string', 'required' => true, 'example' => 'f323baa35c304751a4b1254adc8230bf', 'title' => ''], ], [ - 'name' => 'ProjectId', + 'name' => 'Source', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'PIC3UA0V', - ], + 'schema' => ['description' => 'The event identifier that activates the trigger, such as a syncstore path.', 'type' => 'string', 'required' => true, 'example' => '/', 'title' => ''], ], [ - 'name' => 'SchemaVersion', + 'name' => 'FileIds', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '1.0', - ], + 'schema' => ['description' => 'The file IDs of the files where the objective functions reside.'."\n" + ."\n" + .'The file IDs correspond to the objective function IDs. Separate multiple IDs with commas (,).', 'type' => 'string', 'required' => true, 'example' => '1,2', 'title' => ''], + ], + [ + 'name' => 'FunctionIds', + 'in' => 'query', + 'schema' => ['description' => 'The objective function IDs.'."\n" + ."\n" + .'The function IDs correspond to the file IDs of the files where the objective functions reside. Separate multiple IDs with commas (,).', 'type' => 'string', 'required' => true, 'example' => '35,36', 'title' => ''], + ], + [ + 'name' => 'InvocationMode', + 'in' => 'query', + 'schema' => ['description' => 'The invocation mode. Valid values:'."\n" + ."\n" + .'- **0**: serial (synchronous) invocation'."\n" + .'- **1**: parallel (asynchronous) invocation.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '0', 'title' => ''], + ], + [ + 'name' => 'Sandbox', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to trigger in the sandbox environment. Valid values:'."\n" + ."\n" + .'- **0** (default): does not execute in this environment'."\n" + .'- **1**: executes in this environment.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'Production', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to trigger in the production environment. Valid values:'."\n" + ."\n" + .'- **0** (default): does not execute in this environment'."\n" + .'- **1**: executes in this environment.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], ], 'responses' => [ @@ -3017,80 +2142,65 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '6F25F67C-F411-499F-BCE2-67CA563CB064', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '629586FE-CB2E-4742-995E-121F952CEB72', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"6F25F67C-F411-499F-BCE2-67CA563CB064\\"\\n}","errorExample":"{\\n \\"RequestId\\": \\"6F25F67C-F411-499F-BCE2-67CA563CB064\\",\\n \\"HostId\\": \\"iovcc.cn-shanghai.aliyuncs.com\\",\\n \\"Code\\": \\"InvalidTenant\\",\\n \\"Message\\": \\"User is not a valid tenant\\"\\n}"},{"type":"xml","example":"<UpdateSchemaSubscribeResponse>\\r\\n<RequestId>6F25F67C-F411-499F-BCE2-67CA563CB064</RequestId>\\r\\n</UpdateSchemaSubscribeResponse>","errorExample":""}]', - 'title' => 'UpdateSchemaSubscribe', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"629586FE-CB2E-4742-995E-121F952CEB72\\"\\n}","type":"json"}]', + 'title' => 'Create a trigger', + 'summary' => 'Creates a trigger by calling CreateTrigger.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'ListSchemaSubscribes' => [ - 'methods' => [ - 'get', + 'changeSet' => [ + ['createdAt' => '2024-06-18T02:20:35.000Z', 'description' => 'Error codes changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'iovcc:CreateTrigger', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + ], + 'CreateUpstreamAppKeyRelation' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - ], + 'operationType' => 'write', + 'systemTags' => ['operationType' => 'create'], 'parameters' => [ [ - 'name' => 'ProjectId', + 'name' => 'AppKey', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'PIC3UA0V', - ], + 'schema' => ['description' => 'The client application identifier, which is the CMNS application AppKey.', 'type' => 'string', 'required' => true, 'example' => 'xglrajCR', 'title' => ''], ], [ - 'name' => 'DeviceModel', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'model_2nd', - ], - ], - [ - 'name' => 'PageIndex', + 'name' => 'PAppKey', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'The application server identifier that processes CMNS upstream messages.', 'type' => 'string', 'required' => true, 'example' => 'fgbbajCR', 'title' => ''], ], [ - 'name' => 'PageSize', + 'name' => 'ProjectId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], + 'schema' => ['description' => 'The iovcc project ID.', 'type' => 'string', 'required' => true, 'example' => 'ewrtgggr', 'title' => ''], ], ], 'responses' => [ @@ -3098,186 +2208,68 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '6F25F67C-F411-499F-BCE2-67CA563CB064', - ], - 'PageList' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Pagination' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'PageIndex' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'TotalPageCount' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'TotalCount' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'SimpleSign' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'false', - ], - 'HasNextPage' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - ], - ], - 'List' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'DeviceModelId' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '120', - ], - 'Version' => [ - 'description' => '', - 'type' => 'string', - 'example' => '1.0', - ], - 'ProjectId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'PIC3UA0V', - ], - 'GmtCreate' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1537255540160', - ], - 'Namespace' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'b09e93ce436aaf0dcfc2fb2004c1fde8', - ], - 'ValiditySchema' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'DeviceModel' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'model_2nd', - ], - 'GmtModified' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1537255540160', - ], - 'Id' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '12', - ], - ], - ], - ], - ], - ], - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '629586FE-CB2E-4742-995E-121F952CEB72', 'title' => ''], + 'Id' => ['description' => 'The mapping ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"6F25F67C-F411-499F-BCE2-67CA563CB064\\",\\n \\"PageList\\": [\\n {\\n \\"List\\": [\\n {\\n \\"DeviceModelId\\": 120,\\n \\"Version\\": \\"1.0\\",\\n \\"ProjectId\\": \\"PIC3UA0V\\",\\n \\"GmtCreate\\": 1537255540160,\\n \\"Namespace\\": \\"b09e93ce436aaf0dcfc2fb2004c1fde8\\",\\n \\"ValiditySchema\\": \\"{\\\\\\"ecu\\\\\\":{\\\\\\"node_desc\\\\\\":\\\\\\"动力系统\\\\\\",\\\\\\"brake_controll\\\\\\":{\\\\\\"handbrake\\\\\\":\\\\\\"手刹状态\\\\\\"}},\\\\\\"device_info\\\\\\":{\\\\\\"vin\\\\\\":\\\\\\"车架号\\\\\\",\\\\\\"uuid\\\\\\":\\\\\\"uuid\\\\\\",\\\\\\"brand\\\\\\":\\\\\\"设备品牌\\\\\\",\\\\\\"plugin_version\\\\\\":{\\\\\\"ra\\\\\\":\\\\\\"远程诊断\\\\\\",\\\\\\"control\\\\\\":\\\\\\"远程控制\\\\\\",\\\\\\"node_desc\\\\\\":\\\\\\"插件版本号\\\\\\",\\\\\\"yundevice\\\\\\":\\\\\\"yundevice版本号\\\\\\"},\\\\\\"system_version\\\\\\":\\\\\\"系统版本号\\\\\\"},\\\\\\"car_body_hvac\\\\\\":{\\\\\\"node_desc\\\\\\":\\\\\\"车身与HVAC\\\\\\",\\\\\\"cigar_lighter\\\\\\":{\\\\\\"node_desc\\\\\\":\\\\\\"点烟器\\\\\\"},\\\\\\"cleaning_fluid\\\\\\":\\\\\\"清洗液\\\\\\"}}\\",\\n \\"DeviceModel\\": \\"model_2nd\\",\\n \\"GmtModified\\": 1537255540160,\\n \\"Id\\": 12\\n }\\n ],\\n \\"Pagination\\": {\\n \\"PageIndex\\": 1,\\n \\"TotalPageCount\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 10,\\n \\"SimpleSign\\": false,\\n \\"HasNextPage\\": true\\n }\\n }\\n ]\\n}","errorExample":"{\\n \\"RequestId\\": \\"6F25F67C-F411-499F-BCE2-67CA563CB064\\",\\n \\"HostId\\": \\"iovcc.cn-shanghai.aliyuncs.com\\",\\n \\"Code\\": \\"InvalidTenant\\",\\n \\"Message\\": \\"User is not a valid tenant\\"\\n}"},{"type":"xml","example":"<ListSchemaSubscribesResponse>\\r\\n\\t<PageList>\\r\\n\\t\\t<List>\\r\\n\\t\\t\\t<DeviceModel>model_2nd</DeviceModel>\\r\\n\\t\\t\\t<DeviceModelId>208</DeviceModelId>\\r\\n\\t\\t\\t<GmtCreate>1537255540160</GmtCreate>\\r\\n\\t\\t\\t<GmtModified>1537255540160</GmtModified>\\r\\n\\t\\t\\t<Id>49</Id>\\r\\n\\t\\t\\t<Namespace>b09e93ce436aaf0dcfc2fb2004c1fde8</Namespace>\\r\\n\\t\\t\\t<ProjectId>PIC3UA0V</ProjectId>\\r\\n\\t\\t\\t<ValiditySchema>{"type": "object", "title": "model_2nd", "$schema": "http://json-schema.org/draft-04/schema#", "properties": {"car_body_hvac": {"properties": {"cooling": {"properties": {"water_temperature": {"type": "number", "maximum": 30.0, "minimum": 20.0, "description": "水温"}}}, "lubricating": {"properties": {"oil_level": {"type": "number", "maximum": 6.0, "minimum": 3.0, "description": "机油油位"}}}}}}}</ValiditySchema>\\r\\n\\t\\t\\t<Version>1.0</Version>\\r\\n\\t\\t</List>\\r\\n\\t\\t<Pagination>\\r\\n\\t\\t\\t<HasNextPage>true</HasNextPage>\\r\\n\\t\\t\\t<PageIndex>1</PageIndex>\\r\\n\\t\\t\\t<PageSize>10</PageSize>\\r\\n\\t\\t\\t<TotalCount>1</TotalCount>\\r\\n\\t\\t\\t<TotalPageCount>1</TotalPageCount>\\r\\n\\t\\t</Pagination>\\r\\n\\t</PageList>\\r\\n\\t<RequestId>EDCF581A-6A1A-4595-9542-96D084F5F231</RequestId>\\r\\n</ListSchemaSubscribesResponse>","errorExample":""}]', - 'title' => 'ListSchemaSubscribes', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"629586FE-CB2E-4742-995E-121F952CEB72\\",\\n \\"Id\\": 1\\n}","type":"json"}]', + 'title' => 'Create upstream message client-to-server mapping', + 'summary' => 'Creates a mapping between an upstream message client and server based on the client AppKey and server AppKey.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'CreateNamespace' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [ + ['createdAt' => '2024-06-18T02:20:35.000Z', 'description' => 'Error codes changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'iovcc:CreateUpstreamAppKeyRelation', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'CreateUpstreamAppServer' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', - 'systemTags' => [ - 'operationType' => 'create', - ], + 'systemTags' => ['operationType' => 'create'], 'parameters' => [ [ 'name' => 'ProjectId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'PIY3UB0T', - ], - ], - [ - 'name' => 'AuthType', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '101', - ], + 'schema' => ['description' => 'The ID of the IoVCC project.', 'type' => 'string', 'required' => true, 'example' => 'CS1HMVRF', 'title' => ''], ], [ 'name' => 'Name', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'user_data', - ], + 'schema' => ['description' => 'The name of the server application.'."\n" + ."\n" + .'The name can contain letters, digits, and underscores, and cannot exceed 15 characters in length.', 'type' => 'string', 'required' => true, 'example' => 'testServer', 'title' => ''], ], [ - 'name' => 'Desc', + 'name' => 'Tags', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '', - ], + 'schema' => ['description' => 'The upstream business message tags, which help the application server classify and process upstream messages. Separate multiple tags with commas (,).', 'type' => 'string', 'required' => true, 'example' => 'tag1,tag2', 'title' => ''], ], ], 'responses' => [ @@ -3285,64 +2277,72 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'E94C9864-56FB-44AD-AC0C-A1CEFB332254', - ], - 'Namespace' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'cc6c29893f2be7d465db44ec7b5d593e', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '629586FE-CB2E-4742-995E-121F952CEB72', 'title' => ''], + 'Id' => ['description' => 'The ID of the upstream server application.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Namespace\\": \\"cc6c29893f2be7d465db44ec7b5d593e\\",\\n \\"RequestId\\": \\"E94C9864-56FB-44AD-AC0C-A1CEFB332254\\"\\n}","errorExample":"{\\n \\"RequestId\\": \\"6F25F67C-F411-499F-BCE2-67CA563CB064\\",\\n \\"HostId\\": \\"iovcc.cn-shanghai.aliyuncs.com\\",\\n \\"Code\\": \\"InvalidTenant\\",\\n \\"Message\\": \\"User is not a valid tenant\\"\\n}"},{"type":"xml","example":"<CreateNamespaceResponse>\\r\\n\\t<RequestId>E94C9864-56FB-44AD-AC0C-A1CEFB332254</RequestId>\\r\\n\\t<Namespace>cc6c29893f2be7d465db44ec7b5d593e</Namespace>\\r\\n</CreateNamespaceResponse>","errorExample":""}]', - 'title' => 'CreateNamespace', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"629586FE-CB2E-4742-995E-121F952CEB72\\",\\n \\"Id\\": 1\\n}","type":"json"}]', + 'title' => 'Create a server application for processing upstream messages', + 'summary' => 'Creates a server application that processes upstream messages by calling CreateUpstreamAppServer.', + 'description' => '> Creates a server application based on the name, business message filtering tags, and project ID.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'DeleteNamespace' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [ + ['createdAt' => '2024-06-18T02:20:35.000Z', 'description' => 'Error codes changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'iovcc:CreateUpstreamAppServer', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + ], + 'CreateVersionDeviceGroup' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', - 'systemTags' => [ - 'operationType' => 'delete', - ], + 'systemTags' => ['operationType' => 'create'], 'parameters' => [ [ + 'name' => 'MaxCount', + 'in' => 'query', + 'schema' => ['description' => 'The maximum number of devices allowed in the device group.', 'type' => 'string', 'required' => true, 'example' => '100', 'title' => ''], + ], + [ 'name' => 'ProjectId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'PIY3UB0T', - ], + 'schema' => ['description' => 'The ID of the project to which the device group belongs.', 'type' => 'string', 'required' => true, 'example' => 'P0VFCREU', 'title' => ''], ], [ - 'name' => 'Namespace', + 'name' => 'Name', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'cc6c29893f2be7d465db44ec7b5d593e', - ], + 'schema' => ['description' => 'The name of the device group.', 'type' => 'string', 'required' => true, 'example' => '升级分组1', 'title' => ''], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => ['description' => 'The description of the device group.', 'type' => 'string', 'required' => false, 'example' => '测试分组', 'title' => ''], ], ], 'responses' => [ @@ -3350,139 +2350,89 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'E94C9864-56FB-44AD-AC0C-A1CEFB332254', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '6F25F67C-F411-499F-BCE2-67CA563CB064', 'title' => ''], + 'DeviceGroupId' => ['description' => 'The ID of the created test device group.', 'type' => 'string', 'example' => '1', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"E94C9864-56FB-44AD-AC0C-A1CEFB332254\\"\\n}","errorExample":"{\\n \\"RequestId\\": \\"6F25F67C-F411-499F-BCE2-67CA563CB064\\",\\n \\"HostId\\": \\"iovcc.cn-shanghai.aliyuncs.com\\",\\n \\"Code\\": \\"InvalidTenant\\",\\n \\"Message\\": \\"User is not a valid tenant\\"\\n}"},{"type":"xml","example":"<DeleteNamespaceResponse>\\r\\n\\t<RequestId>E94C9864-56FB-44AD-AC0C-A1CEFB332254</RequestId>\\r\\n</DeleteNamespaceResponse>","errorExample":""}]', - 'title' => 'DeleteNamespace', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6F25F67C-F411-499F-BCE2-67CA563CB064\\",\\n \\"DeviceGroupId\\": \\"1\\"\\n}","type":"json"}]', + 'title' => 'Create a device group for testing', + 'summary' => 'Creates a device group for testing by calling CreateVersionDeviceGroup.', + 'description' => 'Test device groups are used to test system or application versions. After you create a test device group and select it when creating a version test, upgrade information for the version to be tested is automatically pushed to the devices in the group.'."\n" + ."\n" + .'> Because versions are associated with device models, the device models in the test device group must match the device model configured for the version to be tested. Otherwise, the devices cannot be upgraded to the version and the test is invalid.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'UpdateNamespaceData' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [ + ['createdAt' => '2024-06-18T02:20:35.000Z', 'description' => 'Error codes changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'iovcc:CreateVersionDeviceGroup', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + ], + 'CreateVersionPrepublish' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', - 'systemTags' => [ - 'operationType' => 'update', - ], + 'systemTags' => ['operationType' => 'create'], 'parameters' => [ [ - 'name' => 'ProjectId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'PIY3UB0T', - ], - ], - [ - 'name' => 'Namespace', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'cc6c29893f2be7d465db44ec7b5d593e', - ], - ], - [ - 'name' => 'AuthType', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '101', - ], - ], - [ - 'name' => 'DeviceIdType', + 'name' => 'IsTotalPrepublish', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'uuid', - ], + 'schema' => ['description' => 'Specifies whether this is a total pre-release. Valid values: **Y | N**.'."\n" + ."\n" + .'> A total pre-release means that the allowed device count is not evenly distributed across device models. Instead, all device models share the same allowed device count.', 'type' => 'string', 'required' => true, 'example' => 'N', 'title' => ''], ], [ - 'name' => 'DeviceId', + 'name' => 'VersionId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '1ac5e182e9634252a02d442a4d5d16fc', - ], + 'schema' => ['description' => 'The version ID.', 'type' => 'string', 'required' => true, 'example' => '1', 'title' => ''], ], [ - 'name' => 'AccountType', + 'name' => 'VersionType', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'www.weibo.com', - ], + 'schema' => ['description' => 'The version type. Valid values:'."\n" + ."\n" + .'- **FOTA**: system version'."\n" + .'- **APP**: application version.', 'type' => 'string', 'required' => true, 'example' => 'FOTA', 'title' => ''], ], [ - 'name' => 'AccountId', + 'name' => 'Name', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '10000', - ], + 'schema' => ['description' => 'The name of the pre-release.', 'type' => 'string', 'required' => true, 'example' => '第一次预发布', 'title' => ''], ], [ - 'name' => 'Path', + 'name' => 'ProjectId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '/CarService/Window/SunroofSlideCtrl', - ], + 'schema' => ['description' => 'The ID of the project to which the pre-release belongs.', 'type' => 'string', 'required' => true, 'example' => 'P0VFCREU', 'title' => ''], ], [ - 'name' => 'OldData', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '2', - ], - ], - [ - 'name' => 'NewData', + 'name' => 'BarrierCount', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '5', - ], + 'schema' => ['description' => 'The number of devices allowed for the pre-release.', 'type' => 'string', 'required' => true, 'example' => '1000', 'title' => ''], ], ], 'responses' => [ @@ -3490,109 +2440,88 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'E94C9864-56FB-44AD-AC0C-A1CEFB332254', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '6F25F67C-F411-499F-BCE2-67CA563CB064', 'title' => ''], + 'PrepublishId' => ['description' => 'The ID of the created pre-release.', 'type' => 'string', 'example' => '1', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"E94C9864-56FB-44AD-AC0C-A1CEFB332254\\"\\n}","errorExample":"{\\n \\"RequestId\\": \\"6F25F67C-F411-499F-BCE2-67CA563CB064\\",\\n \\"HostId\\": \\"iovcc.cn-shanghai.aliyuncs.com\\",\\n \\"Code\\": \\"InvalidTenant\\",\\n \\"Message\\": \\"User is not a valid tenant\\"\\n}"},{"type":"xml","example":"<UpdateNamespaceDataResponse>\\r\\n<RequestId>E94C9864-56FB-44AD-AC0C-A1CEFB332254</RequestId>\\r\\n</UpdateNamespaceDataResponse>","errorExample":""}]', - 'title' => 'UpdateNamespaceData', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6F25F67C-F411-499F-BCE2-67CA563CB064\\",\\n \\"PrepublishId\\": \\"1\\"\\n}","type":"json"}]', + 'title' => 'Create a version pre-release', + 'summary' => 'Creates a version pre-release by calling CreateVersionPrepublish.', + 'description' => 'Creates a version pre-release. A pre-release can be created only when the version is in the "Test Passed" or "Pre-release" state.'."\n" + ."\n" + .'- A system version has only one device model, so the pre-release targets only that device model.'."\n" + .'- An application version may have multiple device models. You can use the **IsTotalPrepublish** parameter to determine whether to evenly distribute the allowed device count across all device models or to share the total allowed device count across all device models.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'GetNamespaceData' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [ + ['createdAt' => '2024-06-18T02:20:35.000Z', 'description' => 'Error codes changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'iovcc:CreateVersionPrepublish', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + ], + 'CreateVersionTest' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - ], + 'operationType' => 'write', + 'systemTags' => ['operationType' => 'create'], 'parameters' => [ [ - 'name' => 'ProjectId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'PIY3UB0T', - ], - ], - [ - 'name' => 'Namespace', + 'name' => 'DeviceGroupId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'cc6c29893f2be7d465db44ec7b5d593e', - ], + 'schema' => ['description' => 'The ID of the test device group.', 'type' => 'string', 'required' => true, 'example' => '1', 'title' => ''], ], [ - 'name' => 'AuthType', + 'name' => 'Description', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '101', - ], + 'schema' => ['description' => 'The description of the test.', 'type' => 'string', 'required' => false, 'example' => '第一次测试', 'title' => ''], ], [ - 'name' => 'DeviceIdType', + 'name' => 'VersionId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'uuid', - ], + 'schema' => ['description' => 'The version ID.', 'type' => 'string', 'required' => true, 'example' => '1', 'title' => ''], ], [ - 'name' => 'DeviceId', + 'name' => 'VersionType', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '1ac5e182e9634252a02d442a4d5d16fc', - ], + 'schema' => ['description' => 'The version type. Valid values:'."\n" + ."\n" + .'- **FOTA**: system version.'."\n" + .'- **APP**: application version.', 'type' => 'string', 'required' => true, 'example' => 'FOTA', 'title' => ''], ], [ - 'name' => 'AccountType', + 'name' => 'Name', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'www.weibo.com', - ], + 'schema' => ['description' => 'The name of the test.', 'type' => 'string', 'required' => true, 'example' => '第一次测试', 'title' => ''], ], [ - 'name' => 'AccountId', + 'name' => 'ProjectId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '10000', - ], + 'schema' => ['description' => 'The ID of the project to which the test belongs.', 'type' => 'string', 'required' => true, 'example' => 'P0VFCREU', 'title' => ''], ], ], 'responses' => [ @@ -3600,94 +2529,97 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'E94C9864-56FB-44AD-AC0C-A1CEFB332254', - ], - 'Data' => [ - 'description' => '', - 'type' => 'string', - 'example' => '[{\\"path\\":\\"/\\",\\"content\\":\\"Window\\",\\"children\\":[{\\"path\\":\\"/Window\\",\\"content\\":\\"SunroofSlideCtrl\\",\\"children\\":[{\\"path\\":\\"/Window/SunroofSlideCtrl\\",\\"content\\":\\"val\\",\\"children\\":[{\\"path\\":\\"/Window/SunroofSlideCtrl/val\\",\\"content\\":\\"3\\"}]}]},{\\"path\\":\\"/Window\\",\\"content\\":\\"SunroofTiltCtrl\\",\\"children\\":[{\\"path\\":\\"/Window/SunroofTiltCtrl\\",\\"content\\":\\"val\\",\\"children\\":[{\\"path\\":\\"/Window/SunroofTiltCtrl/val\\",\\"content\\":\\"1\\"}]}]}]}]', - ], + 'TestId' => ['description' => 'The ID of the created test.', 'type' => 'string', 'example' => '1', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '6F25F67C-F411-499F-BCE2-67CA563CB064', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Data\\": \\"[{\\\\\\\\\\\\\\"path\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"/\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"content\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"Window\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"children\\\\\\\\\\\\\\":[{\\\\\\\\\\\\\\"path\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"/Window\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"content\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"SunroofSlideCtrl\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"children\\\\\\\\\\\\\\":[{\\\\\\\\\\\\\\"path\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"/Window/SunroofSlideCtrl\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"content\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"val\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"children\\\\\\\\\\\\\\":[{\\\\\\\\\\\\\\"path\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"/Window/SunroofSlideCtrl/val\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"content\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"3\\\\\\\\\\\\\\"}]}]},{\\\\\\\\\\\\\\"path\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"/Window\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"content\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"SunroofTiltCtrl\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"children\\\\\\\\\\\\\\":[{\\\\\\\\\\\\\\"path\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"/Window/SunroofTiltCtrl\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"content\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"val\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"children\\\\\\\\\\\\\\":[{\\\\\\\\\\\\\\"path\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"/Window/SunroofTiltCtrl/val\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"content\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"1\\\\\\\\\\\\\\"}]}]}]}]\\",\\n \\"RequestId\\": \\"E94C9864-56FB-44AD-AC0C-A1CEFB332254\\"\\n}","errorExample":"{\\n \\"RequestId\\": \\"6F25F67C-F411-499F-BCE2-67CA563CB064\\",\\n \\"HostId\\": \\"iovcc.cn-shanghai.aliyuncs.com\\",\\n \\"Code\\": \\"InvalidTenant\\",\\n \\"Message\\": \\"User is not a valid tenant\\"\\n}"},{"type":"xml","example":"<GetNamespaceDataResponse>\\r\\n<RequestId>49C0C0A1-2D02-466B-BC26-D73117062FAE</RequestId>\\r\\n\\t<Data>[{"path":"/","content":"Window","children":[{"path":"/Window","content":"SunroofSlideCtrl","children":[{"path":"/Window/SunroofSlideCtrl","content":"val","children":[{"path":"/Window/SunroofSlideCtrl/val","content":"3"}]}]},{"path":"/Window","content":"SunroofTiltCtrl","children":[{"path":"/Window/SunroofTiltCtrl","content":"val","children":[{"path":"/Window/SunroofTiltCtrl/val","content":"1"}]}]}]}]</Data>\\r\\n</GetNamespaceDataResponse>","errorExample":""}]', - 'title' => 'GetNamespaceData', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TestId\\": \\"1\\",\\n \\"RequestId\\": \\"6F25F67C-F411-499F-BCE2-67CA563CB064\\"\\n}","type":"json"}]', + 'title' => 'Create a system or application version test', + 'summary' => 'Creates a test for a system or application version and pushes upgrade messages to devices in the test group.', + 'description' => 'During the version testing phase, you need to perform upgrade tests on a small batch of specified devices. This operation depends on a previously created test device group. The target devices for the test are managed in the test device group.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'GetNamespaceStatisticsData' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [ + ['createdAt' => '2024-06-18T02:20:35.000Z', 'description' => 'Error codes changed'], + ], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'iovcc:CreateVersionTest', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'DelayPublishOsVersion' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - ], + 'operationType' => 'write', + 'systemTags' => ['operationType' => 'delete'], 'parameters' => [ [ + 'name' => 'VersionId', + 'in' => 'query', + 'schema' => ['description' => 'The version ID.', 'type' => 'string', 'required' => true, 'example' => '12323', 'title' => ''], + ], + [ 'name' => 'ProjectId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'PIY3UB0T', - ], + 'schema' => ['description' => 'The project ID.', 'type' => 'string', 'required' => true, 'example' => 'SASUHQ', 'title' => ''], ], [ - 'name' => 'Namespace', + 'name' => 'PrepubTime', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'cc6c29893f2be7d465db44ec7b5d593e', - ], + 'schema' => ['description' => 'The scheduled pre-publish time.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1570672685997', 'title' => ''], ], [ - 'name' => 'DimensionType', + 'name' => 'PublishTime', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '101', - ], + 'schema' => ['description' => 'The scheduled publish time.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1570672685997', 'title' => ''], ], [ - 'name' => 'StartTime', + 'name' => 'DownTime', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '2018-09-20', - ], + 'schema' => ['description' => 'The scheduled delisting time.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1570672685997', 'title' => ''], ], [ - 'name' => 'EndTime', + 'name' => 'Email', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '2018-09-18', - ], + 'schema' => ['description' => 'The email address.', 'type' => 'string', 'required' => true, 'example' => '12323232@qq.com', 'title' => ''], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => ['description' => 'The description.', 'type' => 'string', 'required' => false, 'example' => '发布描述', 'title' => ''], + ], + [ + 'name' => 'SendMessage', + 'in' => 'query', + 'schema' => ['description' => 'The upgrade notes.', 'type' => 'string', 'required' => false, 'example' => '升级说明', 'title' => ''], + ], + [ + 'name' => 'PrepublishCount', + 'in' => 'query', + 'schema' => ['description' => 'The maximum number of pre-publish instances.', 'type' => 'string', 'required' => false, 'example' => '1000', 'title' => ''], ], ], 'responses' => [ @@ -3695,97 +2627,68 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'E94C9864-56FB-44AD-AC0C-A1CEFB332254', - ], - 'Statistics' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Categories' => [ - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'integer', - 'example' => '["1534907280000","1534907340000","1534907400000"]', - 'format' => 'int64', - ], - ], - 'Series' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Data' => [ - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'integer', - 'example' => '[1,10,5]', - 'format' => 'int64', - ], - ], - 'Name' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - ], - ], - ], - ], - ], + 'RequestId' => ['type' => 'string', 'description' => '', 'example' => '629586FE-CB2E-4742-995E-121F952CEB72', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"E94C9864-56FB-44AD-AC0C-A1CEFB332254\\",\\n \\"Statistics\\": {\\n \\"Series\\": [\\n {\\n \\"Name\\": \\"设备访问次数\\",\\n \\"Data\\": [\\n \\"[1,10,5]\\"\\n ]\\n }\\n ],\\n \\"Categories\\": [\\n \\"[\\\\\\"1534907280000\\\\\\",\\\\\\"1534907340000\\\\\\",\\\\\\"1534907400000\\\\\\"]\\"\\n ]\\n }\\n}","errorExample":"{\\n \\"RequestId\\": \\"6F25F67C-F411-499F-BCE2-67CA563CB064\\",\\n \\"HostId\\": \\"iovcc.cn-shanghai.aliyuncs.com\\",\\n \\"Code\\": \\"InvalidTenant\\",\\n \\"Message\\": \\"User is not a valid tenant\\"\\n}"},{"type":"xml","example":"<GetNamespaceStatisticsDataResponse>\\r\\n\\t<RequestId>49C0C0A1-2D02-466B-BC26-D73117062FAE</RequestId>\\r\\n\\t<Statistics>\\r\\n\\t\\t<Series>\\r\\n\\t\\t\\t<Data>1</Data>\\r\\n\\t\\t\\t<Data>10</Data>\\r\\n\\t\\t\\t<Data>5</Data>\\r\\n\\t\\t\\t<Name>设备访问次数</Name>\\r\\n\\t\\t</Series>\\r\\n\\t\\t<Categories>1534907280000</Categories>\\r\\n\\t\\t<Categories>1534907340000</Categories>\\r\\n\\t\\t<Categories>1534907400000</Categories>\\r\\n\\t</Statistics>\\r\\n</GetNamespaceStatisticsDataResponse>","errorExample":""}]', - 'title' => 'GetNamespaceStatisticsData', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"629586FE-CB2E-4742-995E-121F952CEB72\\"\\n}","type":"json"}]', + 'title' => 'Schedule a system version publish', + 'summary' => 'Schedules the publish of a system version.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'ListNamespaces' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [ + ['createdAt' => '2024-06-18T02:20:34.000Z', 'description' => 'Error codes changed'], + ], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'iovcc:DelayPublishOsVersion', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'DeleteAllCustomizedFilters' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - ], + 'operationType' => 'write', + 'systemTags' => ['operationType' => 'delete'], 'parameters' => [ [ 'name' => 'ProjectId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'PIY3UB0T', - ], + 'schema' => ['description' => 'The ID of the project.', 'type' => 'string', 'required' => true, 'example' => 'P0VFCREU', 'title' => ''], ], [ - 'name' => 'AuthType', + 'name' => 'VersionId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '101', - ], + 'schema' => ['description' => 'The ID of the version.', 'type' => 'string', 'required' => true, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'VersionType', + 'in' => 'query', + 'schema' => ['description' => 'The type of the version. Valid values:'."\n" + ."\n" + .'- **FOTA**: system version.'."\n" + .'- **APP**: application version.', 'type' => 'string', 'required' => true, 'example' => 'FOTA', 'title' => ''], ], ], 'responses' => [ @@ -3793,110 +2696,60 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Namespaces' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'AuthType' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '101', - ], - 'Description' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'test', - ], - 'UserId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '123456', - ], - 'ProjectId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'PLR58HKB', - ], - 'GmtCreate' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1526871654000', - ], - 'Namespace' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'cca8e86c056bdc4fe78751vbf3f26c7k', - ], - 'GmtModified' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1526871654000', - ], - 'Name' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'test', - ], - ], - ], - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'E94C9864-56FB-44AD-AC0C-A1CEFB332254', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '6F25F67C-F411-499F-BCE2-67CA563CB064', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"E94C9864-56FB-44AD-AC0C-A1CEFB332254\\",\\n \\"Namespaces\\": [\\n {\\n \\"AuthType\\": 101,\\n \\"Description\\": \\"test\\",\\n \\"UserId\\": \\"123456\\",\\n \\"ProjectId\\": \\"PLR58HKB\\",\\n \\"GmtCreate\\": 1526871654000,\\n \\"Namespace\\": \\"cca8e86c056bdc4fe78751vbf3f26c7k\\",\\n \\"GmtModified\\": 1526871654000,\\n \\"Name\\": \\"test\\"\\n }\\n ]\\n}","errorExample":"{\\n \\"RequestId\\": \\"6F25F67C-F411-499F-BCE2-67CA563CB064\\",\\n \\"HostId\\": \\"iovcc.cn-shanghai.aliyuncs.com\\",\\n \\"Code\\": \\"InvalidTenant\\",\\n \\"Message\\": \\"User is not a valid tenant\\"\\n}"},{"type":"xml","example":"<ListNamespacesResponse>\\r\\n<RequestId>49C0C0A1-2D02-466B-BC26-D73117062FAE</RequestId>\\r\\n\\t<Namespaces>\\r\\n\\t\\t<Namespace>cca8e86c056bdc4fe7875a9bf3f26c7f</Namespace>\\r\\n\\t\\t<Name>DEFAULT_BY_ACCOUNT_DEVICEDEFAULT_BY_ACCOUNT_DEVICE</Name>\\r\\n\\t\\t<UserId>1151125281886341</UserId>\\r\\n\\t\\t<ProjectId>PLR58NHL</ProjectId>\\r\\n\\t\\t<Description>DEFAULT_BY_ACCOUNT_DEVICE</Description>\\r\\n\\t\\t<GmtCreate>1526871654000</GmtCreate>\\r\\n\\t\\t<GmtModified>1526871654000</GmtModified>\\r\\n\\t\\t<AuthType>101</AuthType>\\r\\n\\t</Namespaces>\\r\\n\\t<Namespaces>\\r\\n\\t\\t<Namespace>f04998a1834f4a6d8debb403b995713a</Namespace>\\r\\n\\t\\t<Name>DEFAULT_BY_DEVICE</Name>\\r\\n\\t\\t<UserId>1151125281886341</UserId>\\r\\n\\t\\t<ProjectId>PLR58NHL</ProjectId>\\r\\n\\t\\t<Description>DEFAULT_BY_DEVICE</Description>\\r\\n\\t\\t<GmtCreate>1526871654000</GmtCreate>\\r\\n\\t\\t<GmtModified>1526871654000</GmtModified>\\r\\n\\t\\t<AuthType>2</AuthType>\\r\\n\\t</Namespaces>\\r\\n</ListNamespacesResponse>","errorExample":""}]', - 'title' => 'ListNamespaces', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6F25F67C-F411-499F-BCE2-67CA563CB064\\"\\n}","type":"json"}]', + 'title' => 'Delete all custom filters under a version', + 'summary' => 'Deletes all custom filters under a specified version by calling DeleteAllCustomizedFilters.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'DeleteOpenAccount' => [ - 'methods' => [ - 'get', + 'changeSet' => [ + ['createdAt' => '2024-06-18T02:20:34.000Z', 'description' => 'Error codes changed'], + ], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'iovcc:DeleteAllCustomizedFilters', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'DeleteAllVersionGroupDevices' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', - 'systemTags' => [ - 'operationType' => 'delete', - ], + 'systemTags' => ['operationType' => 'delete'], 'parameters' => [ [ - 'name' => 'IdentityId', + 'name' => 'ProjectId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'identityidtest', - ], + 'schema' => ['description' => 'The ID of the project.', 'type' => 'string', 'required' => true, 'example' => 'P0VFCREU', 'title' => ''], ], [ - 'name' => 'ProjectId', + 'name' => 'DeviceGroupId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'projectTest', - ], + 'schema' => ['description' => 'The ID of the test device group.', 'type' => 'string', 'required' => true, 'example' => '1', 'title' => ''], ], ], 'responses' => [ @@ -3904,78 +2757,60 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '9c7a3b09-a69a-43f5-8bf2-84f7119810eb', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '6F25F67C-F411-499F-BCE2-67CA563CB064', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"9c7a3b09-a69a-43f5-8bf2-84f7119810eb\\"\\n}","errorExample":"{\\n \\"Code\\":\\"NoPermissionToAccessProject\\",\\n \\"HostId\\":\\"iovcc.cn-shanghai.aliyuncs.com\\",\\n \\"Message\\":\\"User is not authorized to access the specified project.\\",\\n \\"RequestId\\":\\"6F25F67C-F411-499F-BCE2-67CA563CB064\\"\\n}"},{"type":"xml","example":"<DeleteOpenAccountResponse>\\r\\n\\t<RequestId>6F0A833B-7A86-4D92-A083-C184041E2F2D</RequestId>\\r\\n</DeleteOpenAccountResponse>","errorExample":""}]', - 'title' => 'DeleteOpenAccount', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6F25F67C-F411-499F-BCE2-67CA563CB064\\"\\n}","type":"json"}]', + 'title' => 'Delete all devices from a test device group', + 'summary' => 'Calls DeleteAllVersionGroupDevices to delete all devices from a test device group.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'ListOpenAccountLinks' => [ - 'methods' => [ - 'get', + 'changeSet' => [ + ['createdAt' => '2024-06-18T02:20:34.000Z', 'description' => 'Error codes changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'iovcc:DeleteAllVersionGroupDevices', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + ], + 'DeleteCustomizedFilter' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'delete'], 'parameters' => [ [ 'name' => 'ProjectId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'projectTest', - ], - ], - [ - 'name' => 'IdentityId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'identityidtest', - ], - ], - [ - 'name' => 'Idp', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'ALIOS', - ], + 'schema' => ['description' => 'The ID of the project.', 'type' => 'string', 'required' => true, 'example' => 'P0VFCREU', 'title' => ''], ], [ - 'name' => 'OpenId', + 'name' => 'Id', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '12345', - ], + 'schema' => ['description' => 'The ID of the custom filter condition.', 'type' => 'string', 'required' => true, 'example' => '1', 'title' => ''], ], ], 'responses' => [ @@ -3983,166 +2818,60 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '9c7a3b09-a69a-43f5-8bf2-84f7119810eb', - ], - 'OpenAccounts' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Status' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'Type' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'DisplayName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'displaynametest', - ], - 'CreateAccessKey' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'createaccesskeytest', - ], - 'OpenId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '12345', - ], - 'Mobile' => [ - 'description' => '', - 'type' => 'string', - 'example' => '1390000****', - ], - 'Region' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'cn', - ], - 'IdentityId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'identityidtest', - ], - 'LoginId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'loginidtest', - ], - 'Idp' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'ALIOS', - ], - 'AliyunId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'aliyunidtest', - ], - ], - ], - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '6F25F67C-F411-499F-BCE2-67CA563CB064', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"9c7a3b09-a69a-43f5-8bf2-84f7119810eb\\",\\n \\"OpenAccounts\\": [\\n {\\n \\"Status\\": 0,\\n \\"Type\\": 1,\\n \\"DisplayName\\": \\"displaynametest\\",\\n \\"CreateAccessKey\\": \\"createaccesskeytest\\",\\n \\"OpenId\\": \\"12345\\",\\n \\"Mobile\\": \\"1390000****\\",\\n \\"Region\\": \\"cn\\",\\n \\"IdentityId\\": \\"identityidtest\\",\\n \\"LoginId\\": \\"loginidtest\\",\\n \\"Idp\\": \\"ALIOS\\",\\n \\"AliyunId\\": \\"aliyunidtest\\"\\n }\\n ]\\n}","errorExample":"{\\n \\"Code\\":\\"NoPermissionToAccessProject\\",\\n \\"HostId\\":\\"iovcc.cn-shanghai.aliyuncs.com\\",\\n \\"Message\\":\\"User is not authorized to access the specified project.\\",\\n \\"RequestId\\":\\"6F25F67C-F411-499F-BCE2-67CA563CB064\\"\\n}"},{"type":"xml","example":"<ListOpenAccountLinksResponse>\\r\\n\\t<RequestId>E94C9864-56FB-44AD-AC0C-A1CEFB332254</RequestId>\\r\\n\\t<OpenAccountLinks>\\r\\n\\t\\t<AliyunId>aliyunidtest</AliyunId>\\r\\n\\t\\t<CreateAccessKey>createaccesskeytest</CreateAccessKey>\\r\\n\\t\\t<DisplayName>displaynametest</DisplayName>\\r\\n\\t\\t<IdentityId>identityidtest</IdentityId>\\r\\n\\t\\t<Idp>ALIOS</Idp>\\r\\n\\t\\t<LoginId>loginidtest</LoginId>\\r\\n\\t\\t<Mobile>1390000****</Mobile>\\r\\n\\t\\t<OpenId>12345</OpenId>\\r\\n\\t\\t<Region>cn</Region>\\r\\n\\t\\t<Status>0</Status>\\r\\n\\t\\t<Type>1</Type>\\r\\n\\t</OpenAccountLinks>\\r\\n</ListOpenAccountLinksResponse>","errorExample":""}]', - 'title' => 'ListOpenAccountLinks', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6F25F67C-F411-499F-BCE2-67CA563CB064\\"\\n}","type":"json"}]', + 'title' => 'Delete a specified custom filter condition', + 'summary' => 'Calls DeleteCustomizedFilter to delete a specified custom filter condition.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'ListOpenAccounts' => [ - 'methods' => [ - 'get', + 'changeSet' => [ + ['createdAt' => '2024-06-18T02:20:34.000Z', 'description' => 'Error codes changed'], + ], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'iovcc:DeleteCustomizedFilter', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'DeleteCustomizedProperty' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'delete'], 'parameters' => [ [ - 'name' => 'Length', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '20', - ], - ], - [ - 'name' => 'Start', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], - ], - [ - 'name' => 'Mobile', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '1390000****', - ], - ], - [ - 'name' => 'Email', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'test@alibaba.com', - ], - ], - [ - 'name' => 'DisplayName', + 'name' => 'ProjectId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'displaynametest', - ], + 'schema' => ['description' => 'The ID of the project.', 'type' => 'string', 'required' => true, 'example' => 'P0VFCREU', 'title' => ''], ], [ - 'name' => 'ProjectId', + 'name' => 'Id', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'projectTest', - ], + 'schema' => ['description' => 'The ID of the custom property.', 'type' => 'string', 'required' => true, 'example' => '1', 'title' => ''], ], ], 'responses' => [ @@ -4150,154 +2879,60 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '9c7a3b09-a69a-43f5-8bf2-84f7119810eb', - ], - 'OpenAccounts' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Status' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'Type' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'DisplayName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'displaynametest', - ], - 'CreateAccessKey' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'createaccesskeytest', - ], - 'OpenId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '12345', - ], - 'Mobile' => [ - 'description' => '', - 'type' => 'string', - 'example' => '1390000****', - ], - 'Region' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'cn', - ], - 'IdentityId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'identityidtest', - ], - 'LoginId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'loginidtest', - ], - 'Idp' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'ALIOS', - ], - 'AliyunId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'aliyunidtest', - ], - ], - ], - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '6F25F67C-F411-499F-BCE2-67CA563CB064', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"9c7a3b09-a69a-43f5-8bf2-84f7119810eb\\",\\n \\"OpenAccounts\\": [\\n {\\n \\"Status\\": 0,\\n \\"Type\\": 1,\\n \\"DisplayName\\": \\"displaynametest\\",\\n \\"CreateAccessKey\\": \\"createaccesskeytest\\",\\n \\"OpenId\\": \\"12345\\",\\n \\"Mobile\\": \\"1390000****\\",\\n \\"Region\\": \\"cn\\",\\n \\"IdentityId\\": \\"identityidtest\\",\\n \\"LoginId\\": \\"loginidtest\\",\\n \\"Idp\\": \\"ALIOS\\",\\n \\"AliyunId\\": \\"aliyunidtest\\"\\n }\\n ]\\n}","errorExample":"{\\n \\"Code\\":\\"NoPermissionToAccessProject\\",\\n \\"HostId\\":\\"iovcc.cn-shanghai.aliyuncs.com\\",\\n \\"Message\\":\\"User is not authorized to access the specified project.\\",\\n \\"RequestId\\":\\"6F25F67C-F411-499F-BCE2-67CA563CB064\\"\\n}"},{"type":"xml","example":"<ListOpenAccountsResponse>\\r\\n\\t<RequestId>81275440-EF9D-4570-A78F-7576441D3BF8</RequestId>\\r\\n\\t<OpenAccounts>\\r\\n\\t\\t<AliyunId>aliyunidtest</AliyunId>\\r\\n\\t\\t<CreateAccessKey>createaccesskeytest</CreateAccessKey>\\r\\n\\t\\t<DisplayName>displaynametest</DisplayName>\\r\\n\\t\\t<IdentityId>identityidtest</IdentityId>\\r\\n\\t\\t<Idp>ALIOS</Idp>\\r\\n\\t\\t<LoginId>loginidtest</LoginId>\\r\\n\\t\\t<Mobile>1390000****</Mobile>\\r\\n\\t\\t<OpenId>12345</OpenId>\\r\\n\\t\\t<Region>cn</Region>\\r\\n\\t\\t<Status>0</Status>\\r\\n\\t\\t<Type>1</Type>\\r\\n\\t</OpenAccounts>\\r\\n</ListOpenAccountsResponse>","errorExample":""}]', - 'title' => 'ListOpenAccounts', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6F25F67C-F411-499F-BCE2-67CA563CB064\\"\\n}","type":"json"}]', + 'title' => 'Delete a specified custom property record', + 'summary' => 'Deletes a specified custom property record by calling DeleteCustomizedProperty.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'DescribeOpenAccount' => [ - 'methods' => [ - 'get', + 'changeSet' => [ + ['createdAt' => '2024-06-18T02:20:34.000Z', 'description' => 'Error codes changed'], + ], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'iovcc:DeleteCustomizedProperty', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'DeleteDevice' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - ], + 'operationType' => 'write', + 'systemTags' => ['operationType' => 'delete'], 'parameters' => [ [ - 'name' => 'ProjectId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'projectTest', - ], - ], - [ - 'name' => 'IdentityId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'identityidtest', - ], - ], - [ - 'name' => 'Idp', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'ALIOS', - ], - ], - [ - 'name' => 'IdToken', + 'name' => 'DeviceId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'idtokentest', - ], + 'schema' => ['description' => 'The device ID.', 'type' => 'string', 'required' => false, 'example' => '100', 'title' => ''], ], [ - 'name' => 'OpenId', + 'name' => 'ProjectId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '12345', - ], + 'schema' => ['description' => 'The project ID.', 'type' => 'string', 'required' => false, 'example' => 'projectTest', 'title' => ''], ], ], 'responses' => [ @@ -4305,132 +2940,68 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'OpenAccount' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Status' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'Type' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'DisplayName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'displaynametest', - ], - 'CreateAccessKey' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'createaccesskeytest', - ], - 'OpenId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '12345', - ], - 'Mobile' => [ - 'description' => '', - 'type' => 'string', - 'example' => '1390000****', - ], - 'Region' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'cn', - ], - 'IdentityId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'identityidtest', - ], - 'LoginId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'loginidtest', - ], - 'Idp' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'ALIOS', - ], - 'AliyunId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'aliyunidtest', - ], - ], - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '9c7a3b09-a69a-43f5-8bf2-84f7119810eb', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '9c7a3b09-a69a-43f5-8bf2-84f7119810eb', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"9c7a3b09-a69a-43f5-8bf2-84f7119810eb\\",\\n \\"OpenAccount\\": {\\n \\"Status\\": 0,\\n \\"Type\\": 1,\\n \\"DisplayName\\": \\"displaynametest\\",\\n \\"CreateAccessKey\\": \\"createaccesskeytest\\",\\n \\"OpenId\\": \\"12345\\",\\n \\"Mobile\\": \\"1390000****\\",\\n \\"Region\\": \\"cn\\",\\n \\"IdentityId\\": \\"identityidtest\\",\\n \\"LoginId\\": \\"loginidtest\\",\\n \\"Idp\\": \\"ALIOS\\",\\n \\"AliyunId\\": \\"aliyunidtest\\"\\n }\\n}","errorExample":"{\\n \\"Code\\":\\"NoPermissionToAccessProject\\",\\n \\"HostId\\":\\"iovcc.cn-shanghai.aliyuncs.com\\",\\n \\"Message\\":\\"User is not authorized to access the specified project.\\",\\n \\"RequestId\\":\\"6F25F67C-F411-499F-BCE2-67CA563CB064\\"\\n}"},{"type":"xml","example":"<DescribeOpenAccountResponse>\\r\\n\\t<RequestId>E94C9864-56FB-44AD-AC0C-A1CEFB332254</RequestId>\\r\\n\\t<OpenAccount>\\r\\n\\t\\t<AliyunId>aliyunidtest</AliyunId>\\r\\n\\t\\t<CreateAccessKey>createaccesskeytest</CreateAccessKey>\\r\\n\\t\\t<DisplayName>displaynametest</DisplayName>\\r\\n\\t\\t<IdentityId>identityidtest</IdentityId>\\r\\n\\t\\t<Idp>ALIOS</Idp>\\r\\n\\t\\t<LoginId>loginidtest</LoginId>\\r\\n\\t\\t<Mobile>1390000****</Mobile>\\r\\n\\t\\t<OpenId>12345</OpenId>\\r\\n\\t\\t<Region>cn</Region>\\r\\n\\t\\t<Status>0</Status>\\r\\n\\t\\t<Type>1</Type>\\r\\n\\t</OpenAccount>\\r\\n</DescribeOpenAccountResponse>","errorExample":""}]', - 'title' => 'DescribeOpenAccount', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9c7a3b09-a69a-43f5-8bf2-84f7119810eb\\"\\n}","type":"json"}]', + 'title' => 'Delete device information', + 'summary' => 'Calls DeleteDevice to delete device information.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'CreateUpstreamAppKeyRelation' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [ + ['createdAt' => '2024-06-18T02:20:34.000Z', 'description' => 'Error codes changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'iovcc:DeleteDevice', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + ], + 'DeleteFunctionFile' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', - 'systemTags' => [ - 'operationType' => 'create', - ], + 'systemTags' => ['operationType' => 'delete'], 'parameters' => [ [ - 'name' => 'AppKey', + 'name' => 'ProjectId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'xglrajCR', - ], + 'schema' => ['description' => 'The project ID.', 'type' => 'string', 'required' => true, 'example' => 'PE9FQC48', 'title' => ''], ], [ - 'name' => 'PAppKey', + 'name' => 'FileName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'fgbbajCR', - ], + 'schema' => ['description' => 'The file name.', 'type' => 'string', 'required' => true, 'example' => 'hello.zip', 'title' => ''], ], [ - 'name' => 'ProjectId', + 'name' => 'FileType', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'ewrtgggr', - ], + 'schema' => ['description' => 'The file type. Valid values:'."\n" + ."\n" + .'- **0**: single file.'."\n" + .'- **1**: package file.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], ], 'responses' => [ @@ -4438,75 +3009,60 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '629586FE-CB2E-4742-995E-121F952CEB72', - ], - 'Id' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '629586FE-CB2E-4742-995E-121F952CEB72', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Id\\": 1,\\n \\"RequestId\\": \\"629586FE-CB2E-4742-995E-121F952CEB72\\"\\n}","errorExample":"{\\n \\"Code\\":\\"MissingParameter\\",\\n \\"Message\\":\\"The AppKey is mandatory for this action\\",\\n \\"HostId\\": \\"iovcc.cn-shanghai.aliyuncs.com\\",\\n \\"RequestId\\":\\"629586FE-CB2E-4742-995E-121F952CEB72\\"\\n}"},{"type":"xml","example":"<CreateUpstreamAppKeyRelationResponse>\\r\\n\\t<Id>1</Id>\\r\\n\\t<RequestId>629586FE-CB2E-4742-995E-121F952CEB72</RequestId>\\r\\n</CreateUpstreamAppKeyRelationResponse>","errorExample":""}]', - 'title' => 'CreateUpstreamAppKeyRelation', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"629586FE-CB2E-4742-995E-121F952CEB72\\"\\n}","type":"json"}]', + 'title' => 'Delete a function file', + 'summary' => 'Deletes a function file.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'CreateUpstreamAppServer' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [ + ['createdAt' => '2024-06-18T02:20:34.000Z', 'description' => 'Error codes changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'iovcc:DeleteFunctionFile', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'DeleteNamespace' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', - 'systemTags' => [ - 'operationType' => 'create', - ], + 'systemTags' => ['operationType' => 'delete'], 'parameters' => [ [ 'name' => 'ProjectId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'CS1HMVRF', - ], + 'schema' => ['description' => 'The project ID.', 'type' => 'string', 'required' => true, 'example' => 'PIY3UB0T', 'title' => ''], ], [ - 'name' => 'Name', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'testServer', - ], - ], - [ - 'name' => 'Tags', + 'name' => 'Namespace', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'tag1,tag2', - ], + 'schema' => ['description' => 'The unique identifier of the namespace.', 'type' => 'string', 'required' => true, 'example' => 'cc6c29893f2be7d465db44ec7b5d593e', 'title' => ''], ], ], 'responses' => [ @@ -4514,65 +3070,60 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '629586FE-CB2E-4742-995E-121F952CEB72', - ], - 'Id' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'E94C9864-56FB-44AD-AC0C-A1CEFB332254', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Id\\": 1,\\n \\"RequestId\\": \\"629586FE-CB2E-4742-995E-121F952CEB72\\"\\n}","errorExample":"{\\n \\"Code\\":\\"MissingParameter\\",\\n \\"Message\\":\\"The Name is mandatory for this action\\",\\n \\"HostId\\": \\"iovcc.cn-shanghai.aliyuncs.com\\",\\n \\"RequestId\\":\\"629586FE-CB2E-4742-995E-121F952CEB72\\"\\n}"},{"type":"xml","example":"<CreateUpstreamAppServerResponse>\\r\\n\\t<Id>1</Id>\\r\\n\\t<RequestId>629586FE-CB2E-4742-995E-121F952CEB72</RequestId>\\r\\n</CreateUpstreamAppServerResponse>","errorExample":""}]', - 'title' => 'CreateUpstreamAppServer', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E94C9864-56FB-44AD-AC0C-A1CEFB332254\\"\\n}","type":"json"}]', + 'title' => 'Delete a namespace', + 'summary' => 'Calls DeleteNamespace to delete a specified data storage namespace. After deletion, the data in the namespace is lost.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'DeleteUpstreamAppKeyRelation' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [ + ['createdAt' => '2024-06-18T02:20:34.000Z', 'description' => 'Error codes changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'iovcc:DeleteNamespace', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'DeleteOpenAccount' => [ + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'delete', - ], + 'operationType' => 'write', + 'systemTags' => ['operationType' => 'delete'], 'parameters' => [ [ - 'name' => 'Id', + 'name' => 'IdentityId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '1', - ], + 'schema' => ['description' => 'The cloud user ID.', 'type' => 'string', 'required' => false, 'example' => 'identityidtest', 'title' => ''], ], [ 'name' => 'ProjectId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'sghghshr', - ], + 'schema' => ['description' => 'The project ID.', 'type' => 'string', 'required' => false, 'example' => 'projectTest', 'title' => ''], ], ], 'responses' => [ @@ -4580,60 +3131,60 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '629586FE-CB2E-4742-995E-121F952CEB72', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '9c7a3b09-a69a-43f5-8bf2-84f7119810eb', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"629586FE-CB2E-4742-995E-121F952CEB72\\"\\n}","errorExample":"{\\n \\"Code\\":\\"MissingParameter\\",\\n \\"Message\\":\\"The id is mandatory for this action\\",\\n \\"HostId\\": \\"iovcc.cn-shanghai.aliyuncs.com\\",\\n \\"RequestId\\":\\"629586FE-CB2E-4742-995E-121F952CEB72\\"\\n}"},{"type":"xml","example":"<DeleteUpstreamAppKeyRelationResponse>\\r\\n<RequestId>629586FE-CB2E-4742-995E-121F952CEB72</RequestId>\\r\\n</DeleteUpstreamAppKeyRelationResponse>","errorExample":""}]', - 'title' => 'DeleteUpstreamAppKeyRelation', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9c7a3b09-a69a-43f5-8bf2-84f7119810eb\\"\\n}","type":"json"}]', + 'title' => 'Delete account information', + 'summary' => 'Calls DeleteOpenAccount to delete account information.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'DeleteUpstreamAppServer' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [ + ['createdAt' => '2024-06-18T02:20:34.000Z', 'description' => 'Error codes changed'], + ], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'iovcc:DeleteOpenAccount', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'DeleteProjectApp' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', - 'systemTags' => [ - 'operationType' => 'delete', - ], + 'systemTags' => ['operationType' => 'delete'], 'parameters' => [ [ 'name' => 'ProjectId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'sghghshr', - ], + 'schema' => ['description' => 'The project ID.', 'type' => 'string', 'required' => true, 'example' => 'PPCVFRG7', 'title' => ''], ], [ - 'name' => 'Id', + 'name' => 'AppId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1', - ], + 'schema' => ['description' => 'The application ID.', 'type' => 'string', 'required' => true, 'example' => 'AJROOEWE', 'title' => ''], ], ], 'responses' => [ @@ -4641,80 +3192,61 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '629586FE-CB2E-4742-995E-121F952CEB72', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '629586FE-CB2E-4742-995E-121F952CEB72', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"629586FE-CB2E-4742-995E-121F952CEB72\\"\\n}","errorExample":"{\\n \\"Code\\":\\"MissingParameter\\",\\n \\"Message\\":\\"The id is mandatory for this action\\",\\n \\"HostId\\": \\"iovcc.cn-shanghai.aliyuncs.com\\",\\n \\"RequestId\\":\\"629586FE-CB2E-4742-995E-121F952CEB72\\"\\n}"},{"type":"xml","example":"<DeleteUpstreamAppServerResponse>\\r\\n<RequestId>629586FE-CB2E-4742-995E-121F952CEB72</RequestId>\\r\\n</DeleteUpstreamAppServerResponse>","errorExample":""}]', - 'title' => 'DeleteUpstreamAppServer', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"629586FE-CB2E-4742-995E-121F952CEB72\\"\\n}","type":"json"}]', + 'title' => 'Delete a custom application created by a user in a project', + 'summary' => 'Deletes a custom application created by a user in a specified project.', + 'description' => '> Deletes a custom application created by a user in a project based on the project ID and application ID. After deletion, the application can be recovered by creating a new application with the same package name. The AppId, AppKey, and AppSecret of the original application remain unchanged.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'UpdateUpstreamAppServer' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [ + ['createdAt' => '2024-06-18T02:20:34.000Z', 'description' => 'Error codes changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'iovcc:DeleteProjectApp', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'DeleteRpcService' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', - 'systemTags' => [ - 'operationType' => 'update', - ], + 'systemTags' => ['operationType' => 'delete'], 'parameters' => [ [ 'name' => 'Id', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1', - ], - ], - [ - 'name' => 'Name', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'upstreamTest', - ], - ], - [ - 'name' => 'Tags', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'tag1,tag2', - ], + 'schema' => ['description' => 'The ID of the service API registration record.', 'type' => 'string', 'required' => true, 'example' => '1', 'title' => ''], ], [ 'name' => 'ProjectId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'ewtwtt4f', - ], + 'schema' => ['description' => 'The ID of the IoVCC project.', 'type' => 'string', 'required' => true, 'example' => 'sghghshr', 'title' => ''], ], ], 'responses' => [ @@ -4722,92 +3254,60 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '629586FE-CB2E-4742-995E-121F952CEB72', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '629586FE-CB2E-4742-995E-121F952CEB72', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"629586FE-CB2E-4742-995E-121F952CEB72\\"\\n}","errorExample":"{\\n \\"Code\\":\\"MissingParameter\\",\\n \\"Message\\":\\"The Id is mandatory for this action\\",\\n \\"HostId\\": \\"iovcc.cn-shanghai.aliyuncs.com\\",\\n \\"RequestId\\":\\"629586FE-CB2E-4742-995E-121F952CEB72\\"\\n}"},{"type":"xml","example":"<UpdateUpstreamAppServerResponse>\\r\\n<RequestId>629586FE-CB2E-4742-995E-121F952CEB72</RequestId>\\r\\n</UpdateUpstreamAppServerResponse>","errorExample":""}]', - 'title' => 'UpdateUpstreamAppServer', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"629586FE-CB2E-4742-995E-121F952CEB72\\"\\n}","type":"json"}]', + 'title' => 'Delete an RPC service API registration record', + 'summary' => 'Deletes an RPC service API registration record by record ID.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'ListMessageAcks' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [ + ['createdAt' => '2024-06-18T02:20:34.000Z', 'description' => 'Error codes changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'iovcc:DeleteRpcService', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + ], + 'DeleteSchemaSubscribe' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - ], + 'operationType' => 'write', + 'systemTags' => ['operationType' => 'delete'], 'parameters' => [ [ - 'name' => 'PageSize', + 'name' => 'Id', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '20', - ], + 'schema' => ['description' => 'The ID of the data record.', 'type' => 'string', 'required' => true, 'example' => '12', 'title' => ''], ], [ 'name' => 'ProjectId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'gsgshhfs', - ], - ], - [ - 'name' => 'DeviceId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'fc71429ddd9b473c81d7ef5f33ab10cc', - ], - ], - [ - 'name' => 'MessageId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '24266', - ], - ], - [ - 'name' => 'PageIndex', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'The project ID.', 'type' => 'string', 'required' => true, 'example' => 'PIC3UA0V', 'title' => ''], ], ], 'responses' => [ @@ -4815,153 +3315,58 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '629586FE-CB2E-4742-995E-121F952CEB72', - ], - 'MessageAcks' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Pagination' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'PageIndex' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'TotalPageCount' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - 'PageSize' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '20', - ], - 'TotalCount' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '30', - ], - ], - ], - 'List' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'DeviceId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'fc71429ddd9b473c81d7ef5f33ab10cc', - ], - 'AckTime' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1525684245000', - ], - 'Mid' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '24266', - ], - ], - ], - ], - ], - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '6F25F67C-F411-499F-BCE2-67CA563CB064', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"629586FE-CB2E-4742-995E-121F952CEB72\\",\\n \\"MessageAcks\\": {\\n \\"List\\": [\\n {\\n \\"DeviceId\\": \\"fc71429ddd9b473c81d7ef5f33ab10cc\\",\\n \\"AckTime\\": 1525684245000,\\n \\"Mid\\": 24266\\n }\\n ],\\n \\"Pagination\\": {\\n \\"PageIndex\\": 1,\\n \\"TotalPageCount\\": 2,\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 30\\n }\\n }\\n}","errorExample":"{\\n \\"Code\\":\\"MissingParameter\\",\\n \\"Message\\":\\"The DeviceId is mandatory for this action\\",\\n \\"HostId\\": \\"iovcc.cn-shanghai.aliyuncs.com\\",\\n \\"RequestId\\":\\"629586FE-CB2E-4742-995E-121F952CEB72\\"\\n}"},{"type":"xml","example":"<ListMessageAcksResponse>\\r\\n\\t<MessageAcks>\\r\\n\\t\\t<Pagination>\\r\\n\\t\\t\\t<TotalCount>3</TotalCount>\\r\\n\\t\\t\\t<TotalPageCount>1</TotalPageCount>\\r\\n\\t\\t\\t<PageIndex>1</PageIndex>\\r\\n\\t\\t\\t<PageSize>20</PageSize>\\r\\n\\t\\t</Pagination>\\r\\n\\t\\t<List>\\r\\n\\t\\t\\t<Mid>106577</Mid>\\r\\n\\t\\t\\t<DeviceId>fc71429ddd9b473c81d7ef5f33ab10cc</DeviceId>\\r\\n\\t\\t\\t<AckTime>1525517606000</AckTime>\\r\\n\\t\\t</List>\\r\\n\\t\\t<List>\\r\\n\\t\\t\\t<Mid>205951</Mid>\\r\\n\\t\\t\\t<DeviceId>fc71429ddd9b473c81d7ef5f33ab10cc</DeviceId>\\r\\n\\t\\t\\t<AckTime>1525516333000</AckTime>\\r\\n\\t\\t</List>\\r\\n\\t\\t<List>\\r\\n\\t\\t\\t<Mid>106578</Mid>\\r\\n\\t\\t\\t<DeviceId>fc71429ddd9b473c81d7ef5f33ab10cc</DeviceId>\\r\\n\\t\\t\\t<AckTime>1525517639000</AckTime>\\r\\n\\t\\t</List>\\r\\n\\t</MessageAcks>\\r\\n\\t<RequestId>629586FE-CB2E-4742-995E-121F952CEB72</RequestId>\\r\\n</ListMessageAcksResponse>","errorExample":""}]', - 'title' => 'ListMessageAcks', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6F25F67C-F411-499F-BCE2-67CA563CB064\\"\\n}","type":"json"}]', + 'title' => 'Delete subscription information', + 'summary' => 'Deletes subscription information by calling DeleteSchemaSubscribe.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'ListOfflineMessages' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'iovcc:DeleteSchemaSubscribe', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'DeleteShadowSchema' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - ], + 'operationType' => 'write', + 'systemTags' => ['operationType' => 'delete'], 'parameters' => [ [ - 'name' => 'PageSize', + 'name' => 'Id', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '20', - ], + 'schema' => ['description' => 'The ID of the data record.', 'type' => 'string', 'required' => true, 'example' => '12', 'title' => ''], ], [ 'name' => 'ProjectId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'sfgsghd6', - ], - ], - [ - 'name' => 'Type', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'deviceId', - ], - ], - [ - 'name' => 'Value', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'fc71429ddd9b473c81d7ef5f33ab10cc', - ], - ], - [ - 'name' => 'PageIndex', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'The project ID.', 'type' => 'string', 'required' => true, 'example' => 'PIC3UA0V', 'title' => ''], ], ], 'responses' => [ @@ -4969,124 +3374,58 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '629586FE-CB2E-4742-995E-121F952CEB72', - ], - 'OfflineMessages' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Pagination' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'PageIndex' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'TotalPageCount' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - 'PageSize' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '20', - ], - 'TotalCount' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '30', - ], - ], - ], - 'List' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'ExpiredTime' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1525693420000', - ], - 'Mid' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '106577', - ], - 'GmtCreate' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1525517606000', - ], - ], - ], - ], - ], - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '6F25F67C-F411-499F-BCE2-67CA563CB064', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"629586FE-CB2E-4742-995E-121F952CEB72\\",\\n \\"OfflineMessages\\": {\\n \\"List\\": [\\n {\\n \\"GmtCreate\\": 1525517606000,\\n \\"ExpiredTime\\": 1525693420000,\\n \\"Mid\\": 106577\\n }\\n ],\\n \\"Pagination\\": {\\n \\"PageIndex\\": 1,\\n \\"TotalPageCount\\": 2,\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 30\\n }\\n }\\n}","errorExample":"{\\n \\"Code\\":\\"MissingParameter\\",\\n \\"Message\\":\\"The type is mandatory for this action\\",\\n \\"HostId\\": \\"iovcc.cn-shanghai.aliyuncs.com\\",\\n \\"RequestId\\":\\"629586FE-CB2E-4742-995E-121F952CEB72\\"\\n}"},{"type":"xml","example":"<ListOfflineMessagesResponse>\\r\\n\\t<OfflineMessages>\\r\\n\\t\\t<Pagination>\\r\\n\\t\\t\\t<TotalCount>2</TotalCount>\\r\\n\\t\\t\\t<TotalPageCount>1</TotalPageCount>\\r\\n\\t\\t\\t<PageIndex>1</PageIndex>\\r\\n\\t\\t\\t<PageSize>20</PageSize>\\r\\n\\t\\t</Pagination>\\r\\n\\t\\t<List>\\r\\n\\t\\t\\t<Mid>106577</Mid>\\r\\n\\t\\t\\t<ExpiredTime>1525693420000</ExpiredTime>\\r\\n\\t\\t\\t<GmtCreate>1525517606000</GmtCreate>\\r\\n\\t\\t</List>\\r\\n\\t\\t<List>\\r\\n\\t\\t\\t<Mid>205951</Mid>\\r\\n\\t\\t\\t<ExpiredTime>1525693520000</ExpiredTime>\\r\\n\\t\\t\\t<GmtCreate>1525517616000</GmtCreate>\\r\\n\\t\\t</List>\\r\\n\\t</OfflineMessages>\\r\\n\\t<RequestId>629586FE-CB2E-4742-995E-121F952CEB72</RequestId>\\r\\n</ListOfflineMessagesResponse>","errorExample":""}]', - 'title' => 'ListOfflineMessages', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6F25F67C-F411-499F-BCE2-67CA563CB064\\"\\n}","type":"json"}]', + 'title' => 'Delete schema information of a device model', + 'summary' => 'Deletes the schema information of a specified device model.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'DescribeMessage' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'iovcc:DeleteShadowSchema', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'DeleteTrigger' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], + 'operationType' => 'write', + 'systemTags' => ['operationType' => 'delete'], 'parameters' => [ [ 'name' => 'ProjectId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'fsgtd5y5r', - ], + 'schema' => ['description' => 'The project ID.', 'type' => 'string', 'required' => true, 'example' => 'PE9FQC48', 'title' => ''], ], [ - 'name' => 'MessageId', + 'name' => 'Id', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '455888', - ], + 'schema' => ['description' => 'The trigger ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1', 'title' => ''], ], ], 'responses' => [ @@ -5094,163 +3433,60 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'sfsgghdhh56666', - ], - 'Message' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Type' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - 'Action' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'com.aliyun.iovcc.test', - ], - 'ProjectId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'ssgdghww', - ], - 'PredictSendCnt' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '3', - ], - 'Uri' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'page://broadcast.alios.com', - ], - 'Desc' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'this is desc test', - ], - 'AuditMsg' => [ - 'type' => 'string', - ], - 'AppName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'pushdemo', - ], - 'AppKey' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'wTiRKC9m', - ], - 'GmtCreateTime' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1525681245000', - ], - 'ExipiredTime' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1525684245000', - ], - 'AckCnt' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'Title' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'this is a title test', - ], - 'Parameter' => [ - 'description' => '', - 'type' => 'string', - 'example' => '{\\"package\\":\\"com.aliyun.iovcc.test\\",\\"key1\\":\\"value1\\"}"', - ], - 'Audit' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'Id' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2231942', - ], - 'SendStatus' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - ], - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '629586FE-CB2E-4742-995E-121F952CEB72', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"sfsgghdhh56666\\",\\n \\"Message\\": {\\n \\"Type\\": 2,\\n \\"Action\\": \\"com.aliyun.iovcc.test\\",\\n \\"ProjectId\\": \\"ssgdghww\\",\\n \\"PredictSendCnt\\": 3,\\n \\"Uri\\": \\"page://broadcast.alios.com\\",\\n \\"Desc\\": \\"this is desc test\\",\\n \\"AppName\\": \\"pushdemo\\",\\n \\"GmtCreateTime\\": 1525681245000,\\n \\"AppKey\\": \\"wTiRKC9m\\",\\n \\"ExipiredTime\\": 1525684245000,\\n \\"AckCnt\\": 1,\\n \\"Title\\": \\"this is a title test\\",\\n \\"Parameter\\": \\"{\\\\\\\\\\\\\\"package\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"com.aliyun.iovcc.test\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"key1\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"value1\\\\\\\\\\\\\\"}\\\\\\"\\",\\n \\"Id\\": 2231942,\\n \\"SendStatus\\": 0\\n }\\n}","errorExample":"{\\n \\"Code\\":\\"MissingParameter\\",\\n \\"Message\\":\\"The MessageId is mandatory for this action\\",\\n \\"HostId\\": \\"iovcc.cn-shanghai.aliyuncs.com\\",\\n \\"RequestId\\":\\"629586FE-CB2E-4742-995E-121F952CEB72\\"\\n}"},{"type":"xml","example":"<DescribeMessageResponse>\\r\\n\\t<Message>\\r\\n\\t\\t<Id>2231942</Id>\\r\\n\\t\\t<AppName>ALIOS_JARVIS</AppName>\\r\\n\\t\\t<AppKey>WS2MptYY</AppKey>\\r\\n\\t\\t<ProjectId>ssgdghww</ProjectId>\\r\\n\\t\\t<Type>1</Type>\\r\\n\\t\\t<SendStatus>1</SendStatus>\\r\\n\\t\\t<Title></Title>\\r\\n\\t\\t<Desc></Desc>\\r\\n\\t\\t<Action>test.action.alios.com</Action>\\r\\n\\t\\t<Uri>page://broadcast.alios.com</Uri>\\r\\n\\t\\t<Parameter>{"package":"com.aliyun.iovcc.test","key1":"value1"}</Parameter>\\r\\n\\t\\t<PredictSendCnt>1</PredictSendCnt>\\r\\n\\t\\t<AckCnt>1</AckCnt>\\r\\n\\t\\t<GmtCreateTime>1525256539000</GmtCreateTime>\\r\\n\\t\\t<ExipiredTime>1525260138000</ExipiredTime>\\r\\n\\t</Message>\\r\\n\\t<RequestId>629586FE-CB2E-4742-995E-121F952CEB72</RequestId>\\r\\n</DescribeMessageResponse>","errorExample":""}]', - 'title' => 'DescribeMessage', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"629586FE-CB2E-4742-995E-121F952CEB72\\"\\n}","type":"json"}]', + 'title' => 'Delete a trigger', + 'summary' => 'Calls DeleteTrigger to delete a trigger.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'PushVersionMessage' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [ + ['createdAt' => '2024-06-18T02:20:34.000Z', 'description' => 'Error codes changed'], ], - 'schemes' => [ - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'iovcc:DeleteTrigger', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + ], + 'DeleteUpstreamAppKeyRelation' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'none', - ], + 'systemTags' => ['operationType' => 'delete'], 'parameters' => [ [ - 'name' => 'ProjectId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'P0VFCREU', - ], - ], - [ - 'name' => 'VersionId', + 'name' => 'Id', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '1', - ], + 'schema' => ['description' => 'The ID of the upstream mapping relationship.', 'type' => 'string', 'required' => true, 'example' => '1', 'title' => ''], ], [ - 'name' => 'VersionType', + 'name' => 'ProjectId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'FOTA', - ], + 'schema' => ['description' => 'The ID of the iovcc project.', 'type' => 'string', 'required' => true, 'example' => 'sghghshr', 'title' => ''], ], ], 'responses' => [ @@ -5258,130 +3494,129 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '6F25F67C-F411-499F-BCE2-67CA563CB064', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '629586FE-CB2E-4742-995E-121F952CEB72', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"6F25F67C-F411-499F-BCE2-67CA563CB064\\"\\n}","errorExample":"{\\n \\"RequestId\\": \\"6F25F67C-F411-499F-BCE2-67CA563CB064\\",\\n \\"HostId\\": \\"iovcc.cn-shanghai.aliyuncs.com\\",\\n \\"Code\\": \\"NoPermission.NotOwner\\",\\n \\"Message\\": \\"You have no permission because you are not the owner of the data\\"\\n}"},{"type":"xml","example":"<PushVersionMessageResponse>\\r\\n\\t<RequestId>6F25F67C-F411-499F-BCE2-67CA563CB064</RequestId>\\r\\n</PushVersionMessageResponse>","errorExample":""}]', - 'title' => 'PushVersionMessage', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"629586FE-CB2E-4742-995E-121F952CEB72\\"\\n}","type":"json"}]', + 'title' => 'Delete upstream message mapping between application and server', + 'summary' => 'Deletes the mapping record between the application and server for upstream messages based on the mapping relationship ID.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'FindVersionMessages' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [ + ['createdAt' => '2024-06-18T02:20:34.000Z', 'description' => 'Error codes changed'], ], - 'schemes' => [ - 'https', + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'iovcc:DeleteUpstreamAppKeyRelation', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'DeleteUpstreamAppServer' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - ], + 'operationType' => 'write', + 'systemTags' => ['operationType' => 'delete'], 'parameters' => [ [ 'name' => 'ProjectId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'P0VFCREU', - ], - ], - [ - 'name' => 'PageIndex', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '1', - ], + 'schema' => ['description' => 'The ID of the IoVCC project.', 'type' => 'string', 'required' => true, 'example' => 'sghghshr', 'title' => ''], ], [ - 'name' => 'PageSize', + 'name' => 'Id', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '20', - ], + 'schema' => ['description' => 'The record ID of the server application.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1', 'title' => ''], ], - [ - 'name' => 'MessageType', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '629586FE-CB2E-4742-995E-121F952CEB72', 'title' => ''], + ], 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'VERSION_TEST', + 'title' => '', + 'example' => '', ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"629586FE-CB2E-4742-995E-121F952CEB72\\"\\n}","type":"json"}]', + 'title' => 'Delete server application information for processing upstream messages', + 'summary' => 'Deletes the information about a server application that processes upstream messages based on the record ID.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2024-06-18T02:20:34.000Z', 'description' => 'Error codes changed'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ [ - 'name' => 'TestId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '1', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'iovcc:DeleteUpstreamAppServer', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + ], + 'DeleteVersionAllBlackDevices' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'VersionId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '1', - ], + 'AK' => [], ], + ], + 'operationType' => 'write', + 'systemTags' => ['operationType' => 'delete'], + 'parameters' => [ [ - 'name' => 'SendRecordId', + 'name' => 'ProjectId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'The project ID.', 'type' => 'string', 'required' => true, 'example' => 'P0VFCREU', 'title' => ''], ], [ - 'name' => 'DeviceId', + 'name' => 'VersionType', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'b8fe2e24ff2b48e0a3aa4e49809fc1b3', - ], + 'schema' => ['description' => 'The version type. Valid values:'."\n" + ."\n" + .'- **FOTA**: system upgrade.'."\n" + .'- **APP**: application upgrade.', 'type' => 'string', 'required' => true, 'example' => 'FOTA', 'title' => ''], ], [ - 'name' => 'VersionType', + 'name' => 'VersionId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'FOTA', - ], + 'schema' => ['description' => 'The version ID.', 'type' => 'string', 'required' => true, 'example' => '12345', 'title' => ''], ], ], 'responses' => [ @@ -5389,179 +3624,68 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '6F25F67C-F411-499F-BCE2-67CA563CB064', - ], - 'MessageList' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Items' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'GmtModifyTimestamp' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '18974500000', - ], - 'GmtCreateTimestamp' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '18974500000', - ], - 'Status' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'SUCCESS', - ], - 'GmtModify' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2018-01-01 00:01:00', - ], - 'MessageId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '1', - ], - 'DeviceId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'b8fe2e24ff2b48e0a3aa4e49809fc1b3', - ], - 'GmtCreate' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2018-01-01 00:00:00', - ], - 'VersionId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '1', - ], - 'StatusDesc' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'TestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '1', - ], - 'Id' => [ - 'description' => 'ID', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - ], - ], - ], - 'TotalCount' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '5', - ], - ], - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '6F25F67C-F411-499F-BCE2-67CA563CB064', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"6F25F67C-F411-499F-BCE2-67CA563CB064\\",\\n \\"MessageList\\": {\\n \\"TotalCount\\": 5,\\n \\"Items\\": [\\n {\\n \\"GmtModifyTimestamp\\": 18974500000,\\n \\"GmtCreateTimestamp\\": 18974500000,\\n \\"Status\\": \\"SUCCESS\\",\\n \\"GmtModify\\": \\"2018-01-01 00:01:00\\",\\n \\"MessageId\\": \\"1\\",\\n \\"DeviceId\\": \\"b8fe2e24ff2b48e0a3aa4e49809fc1b3\\",\\n \\"GmtCreate\\": \\"2018-01-01 00:00:00\\",\\n \\"VersionId\\": \\"1\\",\\n \\"StatusDesc\\": \\"发送成功\\",\\n \\"TestId\\": \\"1\\",\\n \\"Id\\": 1\\n }\\n ]\\n }\\n}","errorExample":"{\\n \\"RequestId\\": \\"6F25F67C-F411-499F-BCE2-67CA563CB064\\",\\n \\"HostId\\": \\"iovcc.cn-shanghai.aliyuncs.com\\",\\n \\"Code\\": \\"NoPermission.NotOwner\\",\\n \\"Message\\": \\"You have no permission because you are not the owner of the data\\"\\n}"},{"type":"xml","example":"<FindVersionMessagesResponse>\\r\\n\\t<RequestId>6F25F67C-F411-499F-BCE2-67CA563CB064</RequestId>\\r\\n\\t<MessageList>\\r\\n\\t\\t<TotalCount>30</TotalCount>\\r\\n\\t\\t<Items>\\r\\n\\t\\t\\t<Id>1</Id>\\r\\n\\t\\t\\t<VersionId>1</VersionId>\\r\\n\\t\\t\\t<TestId>1</TestId>\\r\\n\\t\\t\\t<MessageId>1</MessageId>\\r\\n\\t\\t\\t<DeviceId>b8fe2e24ff2b48e0a3aa4e49809fc1b3</DeviceId>\\r\\n\\t\\t\\t<Status>SUCCESS</Status>\\r\\n\\t\\t\\t<StatusDesc>发送成功</StatusDesc>\\r\\n\\t\\t\\t<GmtCreate>2018-01-01 00:00:00</GmtCreate>\\r\\n\\t\\t\\t<GmtModify>2018-01-01 00:01:00</GmtModify>\\r\\n\\t\\t</Items>\\r\\n\\t</MessageList>\\r\\n</FindVersionMessagesResponse>","errorExample":""}]', - 'title' => 'FindVersionMessages', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6F25F67C-F411-499F-BCE2-67CA563CB064\\"\\n}","type":"json"}]', + 'title' => 'Delete all blacklisted devices', + 'summary' => 'Deletes all blacklisted devices under a system version or application version.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'FindVersionMessageSendRecords' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [ + ['createdAt' => '2024-06-18T02:20:34.000Z', 'description' => 'Error codes changed'], ], - 'schemes' => [ - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'iovcc:DeleteVersionAllBlackDevices', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + ], + 'DeleteVersionAllWhiteDevices' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - ], + 'operationType' => 'write', + 'systemTags' => ['operationType' => 'delete'], 'parameters' => [ [ - 'name' => 'VersionType', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'FOTA', - ], - ], - [ 'name' => 'ProjectId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'P0VFCREU', - ], + 'schema' => ['description' => 'The project ID.', 'type' => 'string', 'required' => true, 'example' => 'P0VFCREU', 'title' => ''], ], [ - 'name' => 'PageIndex', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '1', - ], - ], - [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '20', - ], - ], - [ - 'name' => 'MessageType', + 'name' => 'VersionType', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'SYSTEM_UPDATE', - ], + 'schema' => ['description' => 'The version type. Valid values:'."\n" + ."\n" + .'- **FOTA**: system upgrade'."\n" + .'- **APP**: application upgrade.', 'type' => 'string', 'required' => true, 'example' => 'FOTA', 'title' => ''], ], [ 'name' => 'VersionId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'The version ID.', 'type' => 'string', 'required' => true, 'example' => '12345', 'title' => ''], ], ], 'responses' => [ @@ -5569,306 +3693,220 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'MessageSendRecordList' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Items' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'GmtCreateTimestamp' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1645460000', - ], - 'MessageType' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'SYSTEM_UPDATE', - ], - 'FailedCount' => [ - 'description' => '', - 'type' => 'string', - 'example' => '0', - ], - 'SkippedCount' => [ - 'description' => '', - 'type' => 'string', - 'example' => '0', - ], - 'Result' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'SUCCESS', - ], - 'SucceededCount' => [ - 'description' => '', - 'type' => 'string', - 'example' => '100', - ], - 'GmtCreate' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2018-01-01 00:00:00', - ], - 'VersionId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '1', - ], - 'ResultDesc' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'TargetId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '1', - ], - 'Id' => [ - 'description' => 'ID', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - ], - ], - ], - 'TotalCount' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '30', - ], - ], - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '6F25F67C-F411-499F-BCE2-67CA563CB064', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '6F25F67C-F411-499F-BCE2-67CA563CB064', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"6F25F67C-F411-499F-BCE2-67CA563CB064\\",\\n \\"MessageSendRecordList\\": {\\n \\"TotalCount\\": 30,\\n \\"Items\\": [\\n {\\n \\"GmtCreateTimestamp\\": 1645460000,\\n \\"MessageType\\": \\"SYSTEM_UPDATE\\",\\n \\"FailedCount\\": \\"0\\",\\n \\"SkippedCount\\": \\"0\\",\\n \\"Result\\": \\"SUCCESS\\",\\n \\"SucceededCount\\": \\"100\\",\\n \\"GmtCreate\\": \\"2018-01-01 00:00:00\\",\\n \\"VersionId\\": \\"1\\",\\n \\"ResultDesc\\": \\"发送成功\\",\\n \\"TargetId\\": \\"1\\",\\n \\"Id\\": 1\\n }\\n ]\\n }\\n}","errorExample":"{\\n \\"RequestId\\": \\"6F25F67C-F411-499F-BCE2-67CA563CB064\\",\\n \\"HostId\\": \\"iovcc.cn-shanghai.aliyuncs.com\\",\\n \\"Code\\": \\"NoPermission.NotOwner\\",\\n \\"Message\\": \\"You have no permission because you are not the owner of the data\\"\\n}"},{"type":"xml","example":"<FindVersionMessageSendRecordsResponse>\\r\\n\\t<RequestId>6F25F67C-F411-499F-BCE2-67CA563CB064</RequestId>\\r\\n\\t<MessageSendRecordList>\\r\\n\\t\\t<TotalCount>30</TotalCount>\\r\\n\\t\\t<Items>\\r\\n\\t\\t\\t<Id>1</Id>\\r\\n\\t\\t\\t<MessageType>SYSTEM_UPDATE</MessageType>\\r\\n\\t\\t\\t<VersionId>1</VersionId>\\r\\n\\t\\t\\t<TargetId>1</TargetId>\\r\\n\\t\\t\\t<Result>SUCCESS</Result>\\r\\n\\t\\t\\t<ResultDesc>发送成功</ResultDesc>\\r\\n\\t\\t\\t<SucceededCount>100</SucceededCount>\\r\\n\\t\\t\\t<FailedCount>0</FailedCount>\\r\\n\\t\\t\\t<SkippedCount>0</SkippedCount>\\r\\n\\t\\t\\t<GmtCreate>2018-01-01 00:00:00</GmtCreate>\\r\\n\\t\\t</Items>\\r\\n\\t</MessageSendRecordList>\\r\\n</FindVersionMessageSendRecordsResponse>","errorExample":""}]', - 'title' => 'FindVersionMessageSendRecords', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6F25F67C-F411-499F-BCE2-67CA563CB064\\"\\n}","type":"json"}]', + 'title' => 'Delete all device whitelists', + 'summary' => 'Deletes all device whitelists under a system version or application version.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'CreateAppVersion' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [ + ['createdAt' => '2024-06-18T02:20:33.000Z', 'description' => 'Error codes changed'], ], - 'schemes' => [ - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'iovcc:DeleteVersionAllWhiteDevices', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + ], + 'DeleteVersionBlackDevices' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', - 'systemTags' => [ - 'operationType' => 'create', - ], + 'systemTags' => ['operationType' => 'delete'], 'parameters' => [ [ - 'name' => 'IsForceUpgrade', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'N', - ], - ], - [ - 'name' => 'IsAllowNewInstall', + 'name' => 'DeviceIds', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'N', - ], + 'schema' => ['description' => 'The list of device IDs, separated by commas (,). The type of device ID used is determined by **DeviceIdType**.', 'type' => 'string', 'required' => true, 'example' => '11,22,33', 'title' => ''], ], [ 'name' => 'ProjectId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'P0VFCREU', - ], - ], - [ - 'name' => 'AppId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '123', - ], + 'schema' => ['description' => 'The project ID.', 'type' => 'string', 'required' => true, 'example' => 'P0VFCREU', 'title' => ''], ], [ - 'name' => 'AppVersion', + 'name' => 'VersionType', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '1.0', - ], + 'schema' => ['description' => 'The version type. Valid values:'."\n" + ."\n" + .'- **FOTA**: system upgrade'."\n" + .'- **APP**: application upgrade.', 'type' => 'string', 'required' => true, 'example' => 'FOTA', 'title' => ''], ], [ - 'name' => 'VersionCode', + 'name' => 'VersionId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '100', - ], + 'schema' => ['description' => 'The version ID.', 'type' => 'string', 'required' => true, 'example' => '12345', 'title' => ''], ], [ - 'name' => 'InstallType', + 'name' => 'DeviceIdType', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'auto', - ], + 'schema' => ['description' => 'The device ID type. Valid values:'."\n" + ."\n" + .'- **device_id**: hardware ID'."\n" + .'- **sn**: serial number'."\n" + .'- **vin**: vehicle identification number'."\n" + .'- **hardware_id**: hardware ID.', 'type' => 'string', 'required' => true, 'example' => 'hardware_id', 'title' => ''], ], - [ - 'name' => 'Remark', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '6F25F67C-F411-499F-BCE2-67CA563CB064', 'title' => ''], + ], 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'sample remark', + 'title' => '', + 'example' => '', ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6F25F67C-F411-499F-BCE2-67CA563CB064\\"\\n}","type":"json"}]', + 'title' => 'Delete device blacklist of a system version or application version', + 'summary' => 'Deletes devices from the blacklist of a system version or application version by calling DeleteVersionBlackDevices.', + 'description' => '> Call this operation when you need to delete the device blacklist of a version.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2024-06-18T02:20:33.000Z', 'description' => 'Error codes changed'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ [ - 'name' => 'ReleaseNote', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'sample release note', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'iovcc:DeleteVersionBlackDevices', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + ], + 'DeleteVersionBlackDevicesById' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'IsSilentUpgrade', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'N', - ], + 'AK' => [], ], + ], + 'operationType' => 'write', + 'systemTags' => ['operationType' => 'delete'], + 'parameters' => [ [ - 'name' => 'PackageUrl', + 'name' => 'Ids', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'http://www.oss-server.com/file.zip', - ], + 'schema' => ['description' => 'The list of blacklist IDs, separated by commas (,).', 'type' => 'string', 'required' => true, 'example' => '100,200,300', 'title' => ''], ], [ - 'name' => 'IsNeedRestart', + 'name' => 'ProjectId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'N', - ], + 'schema' => ['description' => 'The project ID.', 'type' => 'string', 'required' => true, 'example' => 'P0VFCREU', 'title' => ''], ], [ - 'name' => 'BlackVersionList', + 'name' => 'VersionType', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '10,20,30', - ], + 'schema' => ['description' => 'The version type. Valid values:'."\n" + ."\n" + .'- **FOTA**: system upgrade.'."\n" + .'- **APP**: application upgrade.', 'type' => 'string', 'required' => true, 'example' => 'FOTA', 'title' => ''], ], [ - 'name' => 'WhiteVersionList', + 'name' => 'VersionId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '10,20,30', - ], + 'schema' => ['description' => 'The version ID.', 'type' => 'string', 'required' => true, 'example' => '12345', 'title' => ''], ], - [ - 'name' => 'RestartType', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '6F25F67C-F411-499F-BCE2-67CA563CB064', 'title' => ''], + ], 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'app', + 'title' => '', + 'example' => '', ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6F25F67C-F411-499F-BCE2-67CA563CB064\\"\\n}","type":"json"}]', + 'title' => 'Delete device blacklist entries for a system version or application version', + 'summary' => 'Deletes device blacklist entries for a system version or application version by ID.', + 'description' => '> Call this operation to delete device blacklist entries for a version by blacklist ID.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2024-06-18T02:20:33.000Z', 'description' => 'Error codes changed'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ [ - 'name' => 'RestartAppType', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'service', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'iovcc:DeleteVersionBlackDevicesById', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + ], + 'DeleteVersionDeviceGroup' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'RestartAppParam', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '{"restartDelay":1}', - ], + 'AK' => [], ], + ], + 'operationType' => 'read', + 'systemTags' => ['operationType' => 'delete'], + 'parameters' => [ [ - 'name' => 'DeviceAdapterList', + 'name' => 'ProjectId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '10|2.0.1-R-20180412.1024|3.0.1-R-20180412.1024,11|2.1.1-R-20180412.1024|3.1.1-R-20180412.1024', - ], + 'schema' => ['description' => 'The ID of the project to which the device group belongs.', 'type' => 'string', 'required' => true, 'example' => 'P0VFCREU', 'title' => ''], ], [ - 'name' => 'ApkMd5', + 'name' => 'Id', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '34653456wertwe234653retwewer3456', - ], + 'schema' => ['description' => 'The ID of the device group.', 'type' => 'string', 'required' => true, 'example' => '1', 'title' => ''], ], ], 'responses' => [ @@ -5876,83 +3914,70 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'VersionId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '12345', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '6F25F67C-F411-499F-BCE2-67CA563CB064', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '6F25F67C-F411-499F-BCE2-67CA563CB064', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"VersionId\\": \\"12345\\",\\n \\"RequestId\\": \\"6F25F67C-F411-499F-BCE2-67CA563CB064\\"\\n}","errorExample":"{\\n \\"RequestId\\": \\"6F25F67C-F411-499F-BCE2-67CA563CB064\\",\\n \\"HostId\\": \\"iovcc.cn-shanghai.aliyuncs.com\\",\\n \\"Code\\": \\"NoPermissionToAccessProject\\",\\n \\"Message\\": \\"User is not authorized to access the specified project.\\"\\n}"},{"type":"xml","example":"<CreateAppVersionResponse>\\r\\n\\t<RequestId>6F25F67C-F411-499F-BCE2-67CA563CB064</RequestId>\\r\\n\\t<VersionId>12345</VersionId>\\r\\n</CreateAppVersionResponse>","errorExample":""}]', - 'title' => 'CreateAppVersion', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6F25F67C-F411-499F-BCE2-67CA563CB064\\"\\n}","type":"json"}]', + 'title' => 'Delete a test device group', + 'summary' => 'Deletes a test device group by calling DeleteVersionDeviceGroup.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'UpdateAppBlackWhiteVersions' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [ + ['createdAt' => '2024-06-18T02:20:33.000Z', 'description' => 'Error codes changed'], ], - 'schemes' => [ - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'iovcc:DeleteVersionDeviceGroup', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + ], + 'DeleteVersionGroupDevice' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'update', - ], + 'systemTags' => ['operationType' => 'delete'], 'parameters' => [ [ - 'name' => 'WhiteAppVersions', + 'name' => 'DeviceIds', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '12,13,14', - ], + 'schema' => ['description' => 'The original device ID.', 'type' => 'string', 'required' => true, 'example' => 'b8fe2e24ff2b48e0a3aa4e49809fc1b3', 'title' => ''], ], [ 'name' => 'ProjectId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'P0VFCREU', - ], + 'schema' => ['description' => 'The ID of the project to which the device belongs.', 'type' => 'string', 'required' => true, 'example' => 'P0VFCREU', 'title' => ''], ], [ - 'name' => 'VersionId', + 'name' => 'DeviceGroupId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '12345', - ], + 'schema' => ['description' => 'The ID of the test device group to which the device belongs.', 'type' => 'string', 'required' => true, 'example' => '1', 'title' => ''], ], [ - 'name' => 'BlackAppVersions', + 'name' => 'DeviceIdType', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '12,13,14', - ], + 'schema' => ['description' => 'The type of DeviceIds used for identification. Valid values: **device_id**, **sn**, **vin**, **hardware_id**, **uuid**.', 'type' => 'string', 'required' => true, 'example' => 'device_id', 'title' => ''], ], ], 'responses' => [ @@ -5960,68 +3985,65 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '6F25F67C-F411-499F-BCE2-67CA563CB064', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '6F25F67C-F411-499F-BCE2-67CA563CB064', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"6F25F67C-F411-499F-BCE2-67CA563CB064\\"\\n}","errorExample":"{\\n \\"RequestId\\": \\"6F25F67C-F411-499F-BCE2-67CA563CB064\\",\\n \\"HostId\\": \\"iovcc.cn-shanghai.aliyuncs.com\\",\\n \\"Code\\": \\"NoPermissionToAccessProject\\",\\n \\"Message\\": \\"User is not authorized to access the specified project.\\"\\n}"},{"type":"xml","example":"<UpdateAppBlackWhiteVersionsResponse>\\r\\n\\t<RequestId>6F25F67C-F411-499F-BCE2-67CA563CB064</RequestId>\\r\\n</UpdateAppBlackWhiteVersionsResponse>","errorExample":""}]', - 'title' => 'UpdateAppBlackWhiteVersions', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6F25F67C-F411-499F-BCE2-67CA563CB064\\"\\n}","type":"json"}]', + 'title' => 'Remove a specific device from a test device group', + 'summary' => 'Removes a specific device from a test device group by calling DeleteVersionGroupDevice.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'UpdateAppVersionReleaseNote' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [ + ['createdAt' => '2024-06-18T02:20:33.000Z', 'description' => 'Error codes changed'], + ], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'iovcc:DeleteVersionGroupDevice', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'DeleteVersionGroupDeviceById' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'update', - ], + 'operationType' => 'write', + 'systemTags' => ['operationType' => 'delete'], 'parameters' => [ [ 'name' => 'ProjectId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'P0VFCREU', - ], + 'schema' => ['description' => 'The project ID.', 'type' => 'string', 'required' => true, 'example' => 'P0VFCREU', 'title' => ''], ], [ - 'name' => 'VersionId', + 'name' => 'DeviceGroupId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '12345', - ], + 'schema' => ['description' => 'The device group ID.', 'type' => 'string', 'required' => true, 'example' => '1234', 'title' => ''], ], [ - 'name' => 'ReleaseNote', + 'name' => 'Ids', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'sample release note', - ], + 'schema' => ['description' => 'The list of device record IDs in the group, separated by commas (,).', 'type' => 'string', 'required' => true, 'example' => '11,22,33', 'title' => ''], ], ], 'responses' => [ @@ -6029,68 +4051,60 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '6F25F67C-F411-499F-BCE2-67CA563CB064', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '6F25F67C-F411-499F-BCE2-67CA563CB064', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"6F25F67C-F411-499F-BCE2-67CA563CB064\\"\\n}","errorExample":"{\\n \\"RequestId\\": \\"6F25F67C-F411-499F-BCE2-67CA563CB064\\",\\n \\"HostId\\": \\"iovcc.cn-shanghai.aliyuncs.com\\",\\n \\"Code\\": \\"NoPermissionToAccessProject\\",\\n \\"Message\\": \\"User is not authorized to access the specified project.\\"\\n}"},{"type":"xml","example":"<UpdateAppVersionReleaseNoteResponse>\\r\\n\\t<RequestId>6F25F67C-F411-499F-BCE2-67CA563CB064</RequestId>\\r\\n</UpdateAppVersionReleaseNoteResponse>","errorExample":""}]', - 'title' => 'UpdateAppVersionReleaseNote', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6F25F67C-F411-499F-BCE2-67CA563CB064\\"\\n}","type":"json"}]', + 'title' => 'Delete test group devices by ID', + 'summary' => 'Deletes test group devices by ID by calling DeleteVersionGroupDeviceById.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'UpdateAppVersionStatus' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [ + ['createdAt' => '2024-06-18T02:20:33.000Z', 'description' => 'Error codes changed'], ], - 'schemes' => [ - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'iovcc:DeleteVersionGroupDeviceById', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + ], + 'DeleteVersionTest' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'update', - ], + 'systemTags' => ['operationType' => 'delete'], 'parameters' => [ [ 'name' => 'ProjectId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'P0VFCREU', - ], + 'schema' => ['description' => 'The ID of the project.', 'type' => 'string', 'required' => true, 'example' => 'P0VFCREU', 'title' => ''], ], [ 'name' => 'Id', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '12345', - ], - ], - [ - 'name' => 'Status', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'PUBLISHED', - ], + 'schema' => ['description' => 'The ID of the test.', 'type' => 'string', 'required' => true, 'example' => '1', 'title' => ''], ], ], 'responses' => [ @@ -6098,238 +4112,83 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '6F25F67C-F411-499F-BCE2-67CA563CB064', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '6F25F67C-F411-499F-BCE2-67CA563CB064', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"6F25F67C-F411-499F-BCE2-67CA563CB064\\"\\n}","errorExample":"{\\n \\"RequestId\\": \\"6F25F67C-F411-499F-BCE2-67CA563CB064\\",\\n \\"HostId\\": \\"iovcc.cn-shanghai.aliyuncs.com\\",\\n \\"Code\\": \\"NoPermissionToAccessProject\\",\\n \\"Message\\": \\"User is not authorized to access the specified project.\\"\\n}"},{"type":"xml","example":"<UpdateAppVersionStatusResponse>\\r\\n\\t<RequestId>6F25F67C-F411-499F-BCE2-67CA563CB064</RequestId>\\r\\n</UpdateAppVersionStatusResponse>","errorExample":""}]', - 'title' => 'UpdateAppVersionStatus', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6F25F67C-F411-499F-BCE2-67CA563CB064\\"\\n}","type":"json"}]', + 'title' => 'Delete a specified test under a version', + 'summary' => 'Deletes a specified test under a version by calling DeleteVersionTest.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'UpdateAppVersion' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [ + ['createdAt' => '2024-06-18T02:20:33.000Z', 'description' => 'Error codes changed'], ], - 'schemes' => [ - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'iovcc:DeleteVersionTest', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + ], + 'DeleteVersionWhiteDevices' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'update', - ], + 'operationType' => 'write', + 'systemTags' => ['operationType' => 'delete'], 'parameters' => [ [ - 'name' => 'BlackVersionList', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '10,20,30', - ], - ], - [ - 'name' => 'IsAllowNewInstall', + 'name' => 'DeviceIds', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'N', - ], + 'schema' => ['description' => 'The list of device IDs, separated by commas (,).', 'type' => 'string', 'required' => true, 'example' => '11,22,33', 'title' => ''], ], [ 'name' => 'ProjectId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'P0VFCREU', - ], - ], - [ - 'name' => 'AppId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '123', - ], - ], - [ - 'name' => 'AppVersion', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '1.0', - ], - ], - [ - 'name' => 'VersionCode', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '100', - ], - ], - [ - 'name' => 'InstallType', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'auto', - ], - ], - [ - 'name' => 'Remark', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'sample remark', - ], - ], - [ - 'name' => 'IsForceUpgrade', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'N', - ], - ], - [ - 'name' => 'IsSilentUpgrade', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'N', - ], - ], - [ - 'name' => 'IsNeedRestart', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'N', - ], - ], - [ - 'name' => 'PackageUrl', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'http://www.oss-server.com/file.zip', - ], - ], - [ - 'name' => 'ReleaseNote', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'sample release note', - ], - ], - [ - 'name' => 'WhiteVersionList', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '10,20,30', - ], + 'schema' => ['description' => 'The project ID.', 'type' => 'string', 'required' => true, 'example' => 'P0VFCREU', 'title' => ''], ], [ - 'name' => 'RestartType', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'app', - ], - ], - [ - 'name' => 'RestartAppType', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'service', - ], - ], - [ - 'name' => 'RestartAppParam', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '{"restartDelay":1}', - ], - ], - [ - 'name' => 'DeviceAdapterList', + 'name' => 'VersionType', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '10|2.0.1-R-20180412.1024|3.0.1-R-20180412.1024,11|2.1.1-R-20180412.1024|3.1.1-R-20180412.1024', - ], + 'schema' => ['description' => 'The version type. Valid values:'."\n" + ."\n" + .'- **FOTA**: system upgrade'."\n" + .'- **APP**: application upgrade.', 'type' => 'string', 'required' => true, 'example' => 'FOTA', 'title' => ''], ], [ 'name' => 'VersionId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '11', - ], + 'schema' => ['description' => 'The version ID.', 'type' => 'string', 'required' => true, 'example' => '12345', 'title' => ''], ], [ - 'name' => 'ApkMd5', + 'name' => 'DeviceIdType', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '34653456wertwe234653retwewer3456', - ], + 'schema' => ['description' => 'The device ID type. Valid values:'."\n" + ."\n" + .'- **device_id**: hardware ID'."\n" + .'- **sn**: serial number'."\n" + .'- **vin**: vehicle identification number'."\n" + .'- **hardware_id**: hardware ID.', 'type' => 'string', 'required' => true, 'example' => 'hardware_id', 'title' => ''], ], ], 'responses' => [ @@ -6337,157 +4196,74 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '6F25F67C-F411-499F-BCE2-67CA563CB064', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '6F25F67C-F411-499F-BCE2-67CA563CB064', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"6F25F67C-F411-499F-BCE2-67CA563CB064\\"\\n}","errorExample":"{\\n \\"RequestId\\": \\"6F25F67C-F411-499F-BCE2-67CA563CB064\\",\\n \\"HostId\\": \\"iovcc.cn-shanghai.aliyuncs.com\\",\\n \\"Code\\": \\"NoPermissionToAccessProject\\",\\n \\"Message\\": \\"User is not authorized to access the specified project.\\"\\n}"},{"type":"xml","example":"<UpdateAppVersionResponse>\\r\\n\\t<RequestId>6F25F67C-F411-499F-BCE2-67CA563CB064</RequestId>\\r\\n</UpdateAppVersionResponse>","errorExample":""}]', - 'title' => 'UpdateAppVersion', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6F25F67C-F411-499F-BCE2-67CA563CB064\\"\\n}","type":"json"}]', + 'title' => 'Delete device whitelist of a system version or application version', + 'summary' => 'Calls DeleteVersionWhiteDevices to delete the device whitelist of a system version or application version.', + 'description' => '> Call this operation to delete the device whitelist of a version.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'UpdateAppVersionRemark' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [ + ['createdAt' => '2024-06-18T02:20:33.000Z', 'description' => 'Error codes changed'], ], - 'schemes' => [ - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], - 'security' => [ + 'ramActions' => [ [ - 'AK' => [], - ], - ], - 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'update', - ], - 'parameters' => [ - [ - 'name' => 'ProjectId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'P0VFCREU', - ], - ], - [ - 'name' => 'VersionId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '123', - ], - ], - [ - 'name' => 'Remark', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'sample remark', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '6F25F67C-F411-499F-BCE2-67CA563CB064', - ], + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'iovcc:DeleteVersionWhiteDevices', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"6F25F67C-F411-499F-BCE2-67CA563CB064\\"\\n}","errorExample":"{\\n \\"RequestId\\": \\"6F25F67C-F411-499F-BCE2-67CA563CB064\\",\\n \\"HostId\\": \\"iovcc.cn-shanghai.aliyuncs.com\\",\\n \\"Code\\": \\"NoPermissionToAccessProject\\",\\n \\"Message\\": \\"User is not authorized to access the specified project.\\"\\n}"},{"type":"xml","example":"<UpdateAppVersionRemarkResponse>\\r\\n\\t<RequestId>6F25F67C-F411-499F-BCE2-67CA563CB064</RequestId>\\r\\n</UpdateAppVersionRemarkResponse>","errorExample":""}]', - 'title' => 'UpdateAppVersionRemark', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', ], - 'GetDeviceAppUpdateFunnelEvents' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'https', - ], + 'DeleteVersionWhiteDevicesById' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - ], + 'operationType' => 'write', + 'systemTags' => ['operationType' => 'delete'], 'parameters' => [ [ - 'name' => 'PackageName', + 'name' => 'Ids', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'com.aliyun.package1', - ], + 'schema' => ['description' => 'The list of whitelist IDs, separated by commas (,).', 'type' => 'string', 'required' => true, 'example' => '1,2,3', 'title' => ''], ], [ 'name' => 'ProjectId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'P0VFCREU', - ], - ], - [ - 'name' => 'TargetVersionCode', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '100', - ], + 'schema' => ['description' => 'The project ID.', 'type' => 'string', 'required' => true, 'example' => 'P0VFCREU', 'title' => ''], ], [ - 'name' => 'IdType', + 'name' => 'VersionType', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'hardware_id', - ], + 'schema' => ['description' => 'The version type. Valid values:'."\n" + ."\n" + .'- **FOTA**: system upgrade.'."\n" + .'- **APP**: application upgrade.', 'type' => 'string', 'required' => true, 'example' => 'FOTA', 'title' => ''], ], [ - 'name' => 'OriginalId', + 'name' => 'VersionId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '23452345234523452', - ], + 'schema' => ['description' => 'The version ID.', 'type' => 'string', 'required' => true, 'example' => '12345', 'title' => ''], ], ], 'responses' => [ @@ -6495,113 +4271,68 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '6F25F67C-F411-499F-BCE2-67CA563CB064', - ], - 'EventList' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'PackageName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'com.aliyun.package1', - ], - 'DeviceId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'AS23DG23SA5D43GA34SD23GW456E', - ], - 'TargetVersionCode' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2005680', - ], - 'Event' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'os_download_succ', - ], - 'ReportTimestamp' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '16834500000', - ], - 'ReportTime' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2018-02-14 14:20:18', - ], - 'TenantId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'P0VFCREU', - ], - ], - ], - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '6F25F67C-F411-499F-BCE2-67CA563CB064', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"6F25F67C-F411-499F-BCE2-67CA563CB064\\",\\n \\"EventList\\": [\\n {\\n \\"PackageName\\": \\"com.aliyun.package1\\",\\n \\"DeviceId\\": \\"AS23DG23SA5D43GA34SD23GW456E\\",\\n \\"TargetVersionCode\\": \\"2005680\\",\\n \\"Event\\": \\"os_download_succ\\",\\n \\"ReportTimestamp\\": 16834500000,\\n \\"ReportTime\\": \\"2018-02-14 14:20:18\\",\\n \\"TenantId\\": \\"P0VFCREU\\"\\n }\\n ]\\n}","errorExample":"{\\n \\"RequestId\\": \\"6F25F67C-F411-499F-BCE2-67CA563CB064\\",\\n \\"HostId\\": \\"iovcc.cn-shanghai.aliyuncs.com\\",\\n \\"Code\\": \\"NoPermissionToAccessProject\\",\\n \\"Message\\": \\"User is not authorized to access the specified project.\\"\\n}"},{"type":"xml","example":"<GetDeviceAppUpdateFunnelEventsResponse>\\r\\n\\t<RequestId>6F25F67C-F411-499F-BCE2-67CA563CB064</RequestId>\\r\\n\\t<EventList>\\r\\n\\t\\t<TotalCount>25</TotalCount>\\r\\n\\t\\t<Items>\\r\\n\\t\\t\\t<TenantId>P0VFCREU</TenantId>\\r\\n\\t\\t\\t<DeviceId>AS23DG23SA5D43GA34SD23GW456E</DeviceId>\\r\\n\\t\\t\\t<TargetVersionCode>2005680</TargetVersionCode>\\r\\n\\t\\t\\t<PackageName>com.aliyun.package1</PackageName>\\r\\n\\t\\t\\t<Event>os_download_succ</Event>\\r\\n\\t\\t\\t<ReportTime>2018-02-14 14:20:18</ReportTime>\\r\\n\\t\\t</Items>\\r\\n\\t</EventList>\\r\\n</GetDeviceAppUpdateFunnelEventsResponse>","errorExample":""}]', - 'title' => 'GetDeviceAppUpdateFunnelEvents', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6F25F67C-F411-499F-BCE2-67CA563CB064\\"\\n}","type":"json"}]', + 'title' => 'Delete device whitelists of a system version or application version', + 'summary' => 'Deletes device whitelists of a system version or application version by ID.', + 'description' => '> Call this operation to delete device whitelists of a version by ID.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'PublishAppVersion' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [ + ['createdAt' => '2024-06-18T02:20:33.000Z', 'description' => 'Error codes changed'], ], - 'schemes' => [ - 'https', + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'iovcc:DeleteVersionWhiteDevicesById', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'DeployFunctionFile' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', - 'systemTags' => [ - 'operationType' => 'create', - ], + 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ 'name' => 'ProjectId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'P0VFCREU', - ], + 'schema' => ['description' => 'The project ID.', 'type' => 'string', 'required' => true, 'example' => 'PE9FQC48', 'title' => ''], ], [ - 'name' => 'VersionId', + 'name' => 'FileId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '1', - ], + 'schema' => ['description' => 'The function file ID.', 'type' => 'string', 'required' => true, 'example' => '35', 'title' => ''], ], [ - 'name' => 'SendMessage', + 'name' => 'DeployEnv', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'boolean', - 'required' => true, - 'example' => 'false', - ], + 'schema' => ['description' => 'The deployment environment. Valid values:'."\n" + .'- **0**: sandbox environment.'."\n" + .'- **1**: production environment.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '0', 'title' => ''], ], ], 'responses' => [ @@ -6609,120 +4340,60 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '6F25F67C-F411-499F-BCE2-67CA563CB064', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '629586FE-CB2E-4742-995E-121F952CEB72', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"6F25F67C-F411-499F-BCE2-67CA563CB064\\"\\n}","errorExample":"{\\n \\"RequestId\\": \\"6F25F67C-F411-499F-BCE2-67CA563CB064\\",\\n \\"HostId\\": \\"iovcc.cn-shanghai.aliyuncs.com\\",\\n \\"Code\\": \\"NoPermissionToAccessProject\\",\\n \\"Message\\": \\"User is not authorized to access the specified project.\\"\\n}"},{"type":"xml","example":"<PublishAppVersionResponse>\\r\\n\\t<RequestId>6F25F67C-F411-499F-BCE2-67CA563CB064</RequestId>\\r\\n</PublishAppVersionResponse>","errorExample":""}]', - 'title' => 'PublishAppVersion', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"629586FE-CB2E-4742-995E-121F952CEB72\\"\\n}","type":"json"}]', + 'title' => 'Deploy a function', + 'summary' => 'Deploys a function by calling DeployFunctionFile.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'FindAppVersions' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [ + ['createdAt' => '2024-06-18T02:20:33.000Z', 'description' => 'Error codes changed'], ], - 'schemes' => [ - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'iovcc:DeployFunctionFile', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + ], + 'DescribeAppVersion' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'Status', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'PUBLISHED', - ], - ], - [ 'name' => 'ProjectId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'P0VFCREU', - ], - ], - [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '20', - ], + 'schema' => ['description' => 'The project ID.', 'type' => 'string', 'required' => true, 'example' => 'P0VFCREU', 'title' => ''], ], [ 'name' => 'VersionId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '12345', - ], - ], - [ - 'name' => 'DeviceModelId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '1230', - ], - ], - [ - 'name' => 'PageIndex', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '1', - ], - ], - [ - 'name' => 'AppId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '123', - ], - ], - [ - 'name' => 'Remark', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'sample remark', - ], + 'schema' => ['description' => 'The version ID.', 'type' => 'string', 'required' => true, 'example' => '12345', 'title' => ''], ], ], 'responses' => [ @@ -6730,213 +4401,122 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'AppVersionList' => [ - 'description' => '', + 'AppVersion' => [ + 'description' => 'The basic version information.', 'type' => 'object', 'properties' => [ - 'Items' => [ - 'description' => '', + 'Status' => ['description' => 'The application version status. The status definitions are the same as those for system versions.', 'type' => 'string', 'example' => 'PUBLISHED', 'title' => ''], + 'IsAllowNewInstall' => ['description' => 'Specifies whether the server is allowed to return this application version when the application does not exist on the client. Valid values: **Y | N**.', 'type' => 'string', 'example' => 'Y', 'title' => ''], + 'ReleaseNote' => ['description' => 'The version release note.', 'type' => 'string', 'example' => 'sample release note', 'title' => ''], + 'PackageName' => ['description' => 'The application package name.', 'type' => 'string', 'example' => 'com.aliyun.iovcc.ota', 'title' => ''], + 'Remark' => ['description' => 'The version remarks. This information is not visible to terminal devices.', 'type' => 'string', 'example' => 'sample remark', 'title' => ''], + 'StatusName' => ['description' => 'The display name of the version status.', 'type' => 'string', 'example' => '已发布', 'title' => ''], + 'ApkMd5' => ['description' => 'The MD5 value of the APK.', 'type' => 'string', 'example' => '34653456wertwe234653retwewer3456', 'title' => ''], + 'RestartAppParam' => ['description' => 'The application restart parameter.', 'type' => 'string', 'example' => 'k1:v1', 'title' => ''], + 'WhiteVersionList' => ['description' => 'The version whitelist. Version codes are concatenated with commas.', 'type' => 'string', 'example' => '10,20,30', 'title' => ''], + 'AppName' => ['description' => 'The application name.', 'type' => 'string', 'example' => 'iovcc-ota', 'title' => ''], + 'AppId' => ['description' => 'The application ID.', 'type' => 'string', 'example' => '12', 'title' => ''], + 'RestartAppType' => ['description' => 'If restartType is set to application restart, this field indicates the type of application restart. Valid values:'."\n" + ."\n" + .'- **service**: Service restart.'."\n" + .'- **activity**: Activity restart.', 'type' => 'string', 'example' => 'activity', 'title' => ''], + 'VersionCode' => ['description' => 'The application version code, which is used for version comparison during upgrades.', 'type' => 'integer', 'format' => 'int64', 'example' => '201', 'title' => ''], + 'BlackVersionList' => ['description' => 'The version blacklist. Version codes are concatenated with commas.', 'type' => 'string', 'example' => '10,20,30', 'title' => ''], + 'GmtModify' => ['description' => 'The update time.', 'type' => 'string', 'example' => '2018-04-24 12:23:45', 'title' => ''], + 'DownloadUrl' => ['description' => 'The download URL of the upgrade package.', 'type' => 'string', 'example' => 'http://www.cdn-server.com/file.zip', 'title' => ''], + 'Adapters' => [ + 'description' => 'The list of compatible device models for the application version.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'Status' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'PUBLISHED', - ], - 'GmtCreateTimestamp' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '12432500000', - ], - 'GmtModify' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2018-04-24 12:23:45', - ], - 'IsAllowNewInstall' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Y', - ], - 'StatusName' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'RestartAppParam' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'N', - ], - 'IsSilentUpgrade' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'N', - ], - 'AppPackageName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'com.aliyun.iovcc.ota', - ], - 'GmtModifyTimestamp' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '12432500000', - ], - 'AppName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'iovcc-ota', - ], - 'InstallType' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'auto', - ], - 'IsNeedRestart' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'N', - ], - 'RestartAppType' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'service', - ], - 'AppId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '20', - ], - 'RestartType' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'app', - ], - 'GmtCreate' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2018-04-24 12:23:45', - ], - 'AppVersion' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2.0.2', - ], - 'VersionCode' => [ - 'description' => '', - 'type' => 'string', - 'example' => '201', - ], - 'IsForceUpgrade' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'N', - ], - 'Id' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '12345', - ], + 'DeviceModelId' => ['description' => 'The ID of the compatible device model.', 'type' => 'string', 'example' => '123', 'title' => ''], + 'MaxOsVersion' => ['description' => 'The maximum allowed system version number.', 'type' => 'string', 'example' => '2.0.1-R-20180412.0923', 'title' => ''], + 'MinOsVersion' => ['description' => 'The minimum allowed system version number.', 'type' => 'string', 'example' => '3.0.1-R-20180412.0923', 'title' => ''], + 'VersionId' => ['description' => 'The current version ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '12345', 'title' => ''], + 'Id' => ['description' => 'The ID of the upgrade package.', 'type' => 'integer', 'format' => 'int64', 'example' => '1234', 'title' => ''], + 'DeviceModelName' => ['description' => 'The device model name.', 'type' => 'string', 'example' => 'DM1', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], - 'TotalCount' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1000', - ], + 'IsSilentUpgrade' => ['description' => 'Specifies whether silent upgrade is enabled. Valid values: **Y | N**.', 'type' => 'string', 'example' => 'N', 'title' => ''], + 'InstallType' => ['description' => 'The installation method of the application upgrade package. Valid values: **auto** / **customize**.', 'type' => 'string', 'example' => 'auto', 'title' => ''], + 'IsNeedRestart' => ['description' => 'Specifies whether a restart is required. Valid values: **Y | N**.', 'type' => 'string', 'example' => 'N', 'title' => ''], + 'Size' => ['description' => 'The size of the upgrade package, in bytes.', 'type' => 'string', 'example' => '1204560', 'title' => ''], + 'RestartType' => ['description' => 'The restart type after the application is installed. Valid values:'."\n" + ."\n" + .'- **system**: System restart.'."\n" + .'- **app**: Application restart.', 'type' => 'string', 'example' => 'app', 'title' => ''], + 'GmtCreate' => ['description' => 'The creation time.', 'type' => 'string', 'example' => '2018-04-24 12:23:45', 'title' => ''], + 'Md5' => ['description' => 'The MD5 value of the upgrade package.', 'type' => 'string', 'example' => '345adsff2094asas2345et3', 'title' => ''], + 'AppVersion' => ['description' => 'The application version number.', 'type' => 'string', 'example' => '2.0.1', 'title' => ''], + 'IsForceUpgrade' => ['description' => 'Specifies whether a forced upgrade is required. Valid values: **Y | N**.', 'type' => 'string', 'example' => 'N', 'title' => ''], + 'Id' => ['description' => 'The version ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '12345', 'title' => ''], + 'OriginalUrl' => ['description' => 'The original URL of the upgrade package.', 'type' => 'string', 'example' => 'http://www.oss-server.com/file.zip', 'title' => ''], ], + 'title' => '', + 'example' => '', ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '6F25F67C-F411-499F-BCE2-67CA563CB064', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '6F25F67C-F411-499F-BCE2-67CA563CB064', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"6F25F67C-F411-499F-BCE2-67CA563CB064\\",\\n \\"AppVersionList\\": {\\n \\"TotalCount\\": 1000,\\n \\"Items\\": [\\n {\\n \\"GmtCreateTimestamp\\": 12432500000,\\n \\"Status\\": \\"PUBLISHED\\",\\n \\"IsAllowNewInstall\\": \\"Y\\",\\n \\"GmtModify\\": \\"2018-04-24 12:23:45\\",\\n \\"StatusName\\": \\"已发布\\",\\n \\"RestartAppParam\\": \\"N\\",\\n \\"AppPackageName\\": \\"com.aliyun.iovcc.ota\\",\\n \\"IsSilentUpgrade\\": \\"N\\",\\n \\"GmtModifyTimestamp\\": 12432500000,\\n \\"AppName\\": \\"iovcc-ota\\",\\n \\"InstallType\\": \\"auto\\",\\n \\"IsNeedRestart\\": \\"N\\",\\n \\"RestartAppType\\": \\"service\\",\\n \\"AppId\\": \\"20\\",\\n \\"RestartType\\": \\"app\\",\\n \\"GmtCreate\\": \\"2018-04-24 12:23:45\\",\\n \\"AppVersion\\": \\"2.0.2\\",\\n \\"VersionCode\\": \\"201\\",\\n \\"IsForceUpgrade\\": \\"N\\",\\n \\"Id\\": 12345\\n }\\n ]\\n }\\n}","errorExample":"{\\n \\"RequestId\\": \\"6F25F67C-F411-499F-BCE2-67CA563CB064\\",\\n \\"HostId\\": \\"iovcc.cn-shanghai.aliyuncs.com\\",\\n \\"Code\\": \\"NoPermissionToAccessProject\\",\\n \\"Message\\": \\"User is not authorized to access the specified project.\\"\\n}"},{"type":"xml","example":"<FindAppVersionsResponse>\\r\\n\\t<AppVersionList>\\r\\n\\t\\t<Items>\\r\\n\\t\\t\\t<AppId>1</AppId>\\r\\n\\t\\t\\t<AppName>iovcc-ota</AppName>\\r\\n\\t\\t\\t<AppPackageName>com.aliyun.iovcc.ota</AppPackageName>\\r\\n\\t\\t\\t<AppVersion>2.0.2</AppVersion>\\r\\n\\t\\t\\t<AsAllowNewInstall>N</AsAllowNewInstall>\\r\\n\\t\\t\\t<GmtCreate></GmtCreate>\\r\\n\\t\\t\\t<GmtModify></GmtModify>\\r\\n\\t\\t\\t<Id>124</Id>\\r\\n\\t\\t\\t<InstallType>auto</InstallType>\\r\\n\\t\\t\\t<IsForceUpgrade>N</IsForceUpgrade>\\r\\n\\t\\t\\t<IsNeedRestart>N</IsNeedRestart>\\r\\n\\t\\t\\t<IsSilentUpgrade>N</IsSilentUpgrade>\\r\\n\\t\\t\\t<RestartAppParam>N</RestartAppParam>\\r\\n\\t\\t\\t<RestartAppType>N</RestartAppType>\\r\\n\\t\\t\\t<RestartType>system</RestartType>\\r\\n\\t\\t\\t<Status>PUBLISHED</Status>\\r\\n\\t\\t\\t<StatusName>已发布</StatusName>\\r\\n\\t\\t\\t<VersionCode>202</VersionCode>\\r\\n\\t\\t</Items>\\r\\n\\t\\t<TotalCount>1000</TotalCount>\\r\\n\\t</AppVersionList>\\r\\n\\t<RequestId>6F25F67C-F411-499F-BCE2-67CA563CB064</RequestId>\\r\\n</FindAppVersionsResponse>","errorExample":""}]', - 'title' => 'FindAppVersions', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AppVersion\\": {\\n \\"Status\\": \\"PUBLISHED\\",\\n \\"IsAllowNewInstall\\": \\"Y\\",\\n \\"ReleaseNote\\": \\"sample release note\\",\\n \\"PackageName\\": \\"com.aliyun.iovcc.ota\\",\\n \\"Remark\\": \\"sample remark\\",\\n \\"StatusName\\": \\"已发布\\",\\n \\"ApkMd5\\": \\"34653456wertwe234653retwewer3456\\",\\n \\"RestartAppParam\\": \\"k1:v1\\",\\n \\"WhiteVersionList\\": \\"10,20,30\\",\\n \\"AppName\\": \\"iovcc-ota\\",\\n \\"AppId\\": \\"12\\",\\n \\"RestartAppType\\": \\"activity\\",\\n \\"VersionCode\\": 201,\\n \\"BlackVersionList\\": \\"10,20,30\\",\\n \\"GmtModify\\": \\"2018-04-24 12:23:45\\",\\n \\"DownloadUrl\\": \\"http://www.cdn-server.com/file.zip\\",\\n \\"Adapters\\": [\\n {\\n \\"DeviceModelId\\": \\"123\\",\\n \\"MaxOsVersion\\": \\"2.0.1-R-20180412.0923\\",\\n \\"MinOsVersion\\": \\"3.0.1-R-20180412.0923\\",\\n \\"VersionId\\": 12345,\\n \\"Id\\": 1234,\\n \\"DeviceModelName\\": \\"DM1\\"\\n }\\n ],\\n \\"IsSilentUpgrade\\": \\"N\\",\\n \\"InstallType\\": \\"auto\\",\\n \\"IsNeedRestart\\": \\"N\\",\\n \\"Size\\": \\"1204560\\",\\n \\"RestartType\\": \\"app\\",\\n \\"GmtCreate\\": \\"2018-04-24 12:23:45\\",\\n \\"Md5\\": \\"345adsff2094asas2345et3\\",\\n \\"AppVersion\\": \\"2.0.1\\",\\n \\"IsForceUpgrade\\": \\"N\\",\\n \\"Id\\": 12345,\\n \\"OriginalUrl\\": \\"http://www.oss-server.com/file.zip\\"\\n },\\n \\"RequestId\\": \\"6F25F67C-F411-499F-BCE2-67CA563CB064\\"\\n}","type":"json"}]', + 'title' => 'Retrieve system version details', + 'summary' => 'Calls DescribeAppVersion to retrieve the details of a system version.', + 'description' => '> You can call this operation to retrieve the details of an application version.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'AddVersionBlackDevices' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [ + ['createdAt' => '2024-06-18T02:20:32.000Z', 'description' => 'Error codes changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'iovcc:DescribeAppVersion', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + ], + 'DescribeAssistRTMPServerAddress' => [ + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', - 'systemTags' => [ - 'operationType' => 'create', - ], + 'operationType' => 'read', + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'DeviceIds', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '11,22,33', - ], - ], - [ 'name' => 'ProjectId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'P0VFCREU', - ], - ], - [ - 'name' => 'VersionType', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'FOTA', - ], - ], - [ - 'name' => 'DeviceIdType', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'hardware_id', - ], + 'schema' => ['description' => 'The project ID.', 'type' => 'string', 'required' => true, 'example' => 'PZ1HK7JZ', 'title' => ''], ], [ - 'name' => 'VersionId', + 'name' => 'DeviceId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '12345', - ], + 'schema' => ['description' => 'The device ID.', 'type' => 'string', 'required' => true, 'example' => '6fde56979c484b93b99fba257e3cbe83', 'title' => ''], ], ], 'responses' => [ @@ -6944,218 +4524,128 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '6F25F67C-F411-499F-BCE2-67CA563CB064', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '9c7a3b09-a69a-43f5-8bf2-84f7119810eb', 'title' => ''], + 'RTMPServer' => ['description' => 'The RTMP server address.', 'type' => 'string', 'example' => 'ra-service-qa.aicc.aliyun.com', 'title' => ''], + 'OTP' => ['description' => 'The one-time password.', 'type' => 'string', 'example' => 'ewga5dxHOB8Lm9VH', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"6F25F67C-F411-499F-BCE2-67CA563CB064\\"\\n}","errorExample":"{\\n \\"RequestId\\": \\"6F25F67C-F411-499F-BCE2-67CA563CB064\\",\\n \\"HostId\\": \\"iovcc.cn-shanghai.aliyuncs.com\\",\\n \\"Code\\": \\"NoPermissionToAccessProject\\",\\n \\"Message\\": \\"User is not authorized to access the specified project.\\"\\n}"},{"type":"xml","example":"<AddVersionBlackDevicesResponse>\\r\\n\\t<RequestId>6F25F67C-F411-499F-BCE2-67CA563CB064</RequestId>\\r\\n</AddVersionBlackDevicesResponse>","errorExample":""}]', - 'title' => 'AddVersionBlackDevices', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9c7a3b09-a69a-43f5-8bf2-84f7119810eb\\",\\n \\"RTMPServer\\": \\"ra-service-qa.aicc.aliyun.com\\",\\n \\"OTP\\": \\"ewga5dxHOB8Lm9VH\\"\\n}","type":"json"}]', + 'title' => 'Obtain remote desktop RTMP server address', + 'summary' => 'Calls DescribeAssistRTMPServerAddress to obtain the remote desktop RTMP server address.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'CreateOsVersion' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [ + ['createdAt' => '2024-06-18T02:20:32.000Z', 'description' => 'Error codes changed'], ], - 'schemes' => [ - 'https', + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'iovcc:DescribeAssistRTMPServerAddress', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'DescribeAssistReport' => [ + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', - 'systemTags' => [ - 'operationType' => 'create', - ], + 'operationType' => 'read', + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'IsForceNightUpgrade', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'N', - ], - ], - [ - 'name' => 'MaxClientVersion', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '1200', - ], - ], - [ 'name' => 'ProjectId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'P0VFCREU', - ], + 'schema' => ['description' => 'The project ID.', 'type' => 'string', 'required' => true, 'example' => 'PZ1HK7JZ', 'title' => ''], ], [ - 'name' => 'DeviceModelId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '12', - ], - ], - [ - 'name' => 'SystemVersion', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '2.0.1-R-20180501.1208', - ], - ], - [ - 'name' => 'ReleaseNote', + 'name' => 'AssistId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '', - ], + 'schema' => ['description' => 'The remote diagnostic session ID.', 'type' => 'string', 'required' => true, 'example' => '510', 'title' => ''], ], - [ - 'name' => 'Remark', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '9c7a3b09-a69a-43f5-8bf2-84f7119810eb', 'title' => ''], + 'AssistResult' => ['description' => 'The diagnostic conclusion.', 'type' => 'string', 'example' => '手动设置正确时间', 'title' => ''], + 'AssistReason' => ['description' => 'The diagnostic root cause, which describes the primary cause of the issue.', 'type' => 'string', 'example' => '没有和时间服务器同步', 'title' => ''], + 'AssistId' => ['description' => 'The diagnostic session ID.', 'type' => 'string', 'example' => '510', 'title' => ''], + 'AssistDescription' => ['description' => 'The diagnostic defect description, which describes the issue symptoms and reproduction steps.', 'type' => 'string', 'example' => '设备时间异常', 'title' => ''], + 'AssistTag' => ['description' => 'The diagnostic labels used for history queries. Multiple labels are separated by spaces.', 'type' => 'string', 'example' => '系统时间', 'title' => ''], + ], 'description' => '', - 'type' => 'string', - 'required' => false, + 'title' => '', 'example' => '', ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9c7a3b09-a69a-43f5-8bf2-84f7119810eb\\",\\n \\"AssistResult\\": \\"手动设置正确时间\\",\\n \\"AssistReason\\": \\"没有和时间服务器同步\\",\\n \\"AssistId\\": \\"510\\",\\n \\"AssistDescription\\": \\"设备时间异常\\",\\n \\"AssistTag\\": \\"系统时间\\"\\n}","type":"json"}]', + 'title' => 'Retrieve a specified remote diagnostic report', + 'summary' => 'Calls DescribeAssistReport to retrieve a specified remote diagnostic report.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2024-06-18T02:20:33.000Z', 'description' => 'Error codes changed'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ [ - 'name' => 'BlackVersionList', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '2.0.1-R-20180501.1208,2.0.1-R-20180501.1209', - ], - ], - [ - 'name' => 'IsMilestone', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'N', - ], - ], - [ - 'name' => 'MinClientVersion', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '1100', - ], - ], - [ - 'name' => 'WhiteVersionList', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '2.0.1-R-20180501.1208,2.0.1-R-20180501.1209', - ], - ], - [ - 'name' => 'IsForceUpgrade', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'N', - ], - ], - [ - 'name' => 'NightUpgradeDownloadType', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '1', - ], - ], - [ - 'name' => 'NightUpgradeIsShowTip', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'N', - ], - ], - [ - 'name' => 'NightUpgradeIsAllowedCancel', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'N', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'iovcc:DescribeAssistReport', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + ], + 'DescribeAssistWSServerAddress' => [ + 'methods' => ['get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'RomList', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '0|http://www.oss-server.com/file1.zip,2.0.1|http://www.oss-server.com/file2.zip', - ], + 'AK' => [], ], + ], + 'operationType' => 'read', + 'systemTags' => ['operationType' => 'get'], + 'parameters' => [ [ - 'name' => 'EnableMobileDownload', + 'name' => 'ProjectId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'Y', - ], + 'schema' => ['description' => 'The project ID.', 'type' => 'string', 'required' => true, 'example' => 'PZ1HK7JZ', 'title' => ''], ], [ - 'name' => 'MobileDownloadMaxSize', + 'name' => 'DeviceId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '10', - ], + 'schema' => ['description' => 'The DIS device ID.', 'type' => 'string', 'required' => true, 'example' => '6fde56979c484b93b99fba257e3cbc12', 'title' => ''], ], ], 'responses' => [ @@ -7163,93 +4653,60 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'VersionId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '12345', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '6F25F67C-F411-499F-BCE2-67CA563CB064', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '9c7a3b09-a69a-43f5-8bf2-84f7119810eb', 'title' => ''], + 'WsServer' => ['description' => 'The WebSocket service address.', 'type' => 'string', 'example' => 'ws://ra-service-qa.aicc.aliyun.com:7001', 'title' => ''], + 'OTP' => ['description' => 'The one-time password.', 'type' => 'string', 'example' => 'ewga5dxHOB8Lm9VH', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"VersionId\\": \\"12345\\",\\n \\"RequestId\\": \\"6F25F67C-F411-499F-BCE2-67CA563CB064\\"\\n}","errorExample":"{\\n \\"RequestId\\": \\"6F25F67C-F411-499F-BCE2-67CA563CB064\\",\\n \\"HostId\\": \\"iovcc.cn-shanghai.aliyuncs.com\\",\\n \\"Code\\": \\"NoPermissionToAccessProject\\",\\n \\"Message\\": \\"User is not authorized to access the specified project.\\"\\n}"},{"type":"xml","example":"<CreateOsVersionResponse>\\r\\n\\t<RequestId>6F25F67C-F411-499F-BCE2-67CA563CB064</RequestId>\\r\\n\\t<VersionId>1003</VersionId>\\r\\n</CreateOsVersionResponse>","errorExample":""}]', - 'title' => 'CreateOsVersion', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'DeleteVersionBlackDevices' => [ - 'methods' => [ - 'post', - 'get', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9c7a3b09-a69a-43f5-8bf2-84f7119810eb\\",\\n \\"WsServer\\": \\"ws://ra-service-qa.aicc.aliyun.com:7001\\",\\n \\"OTP\\": \\"ewga5dxHOB8Lm9VH\\"\\n}","type":"json"}]', + 'title' => 'Retrieve webSocket service address', + 'summary' => 'Retrieves the WebSocket server address for remote diagnostics.', + 'description' => 'Retrieves the WebSocket server address for remote diagnostics.', + 'changeSet' => [ + ['createdAt' => '2024-06-18T02:20:32.000Z', 'description' => 'Error codes changed'], ], - 'schemes' => [ - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'iovcc:DescribeAssistWSServerAddress', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + ], + 'DescribeCustomizedFilter' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', - 'systemTags' => [ - 'operationType' => 'delete', - ], + 'operationType' => 'read', + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'DeviceIds', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '11,22,33', - ], - ], - [ 'name' => 'ProjectId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'P0VFCREU', - ], + 'schema' => ['description' => 'The ID of the project.', 'type' => 'string', 'required' => true, 'example' => 'P0VFCREU', 'title' => ''], ], [ - 'name' => 'VersionType', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'FOTA', - ], - ], - [ - 'name' => 'VersionId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '12345', - ], - ], - [ - 'name' => 'DeviceIdType', + 'name' => 'Id', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'hardware_id', - ], + 'schema' => ['description' => 'The ID of the custom filter.', 'type' => 'string', 'required' => true, 'example' => '1', 'title' => ''], ], ], 'responses' => [ @@ -7257,78 +4714,83 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '6F25F67C-F411-499F-BCE2-67CA563CB064', + 'CustomizedFilter' => [ + 'description' => 'The details of the custom filter.', + 'type' => 'object', + 'properties' => [ + 'GmtCreateTimestamp' => ['description' => 'The timestamp of the creation time.', 'type' => 'integer', 'format' => 'int64', 'example' => '123543500000', 'title' => ''], + 'GmtModify' => ['description' => 'The modification time.', 'type' => 'string', 'example' => '2018-01-01 00:01:00', 'title' => ''], + 'ValueCompareType' => ['description' => 'The comparison type of the value. Valid values:'."\n" + ."\n" + .'- **NUMBER**: compared as a number.'."\n" + .'- **STRING**: compared as a string.', 'type' => 'string', 'example' => 'NUMBER', 'title' => ''], + 'VersionId' => ['description' => 'The ID of the version.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'GmtModifyTimestamp' => ['description' => 'The timestamp of the modification time.', 'type' => 'integer', 'format' => 'int64', 'example' => '123543500000', 'title' => ''], + 'Value' => ['description' => 'The value of the filter.', 'type' => 'string', 'example' => '1,5', 'title' => ''], + 'ValueType' => ['description' => 'The input type of the filter. Currently, only **WRITE** is supported, which indicates handwriting input.', 'type' => 'string', 'example' => 'WRITE', 'title' => ''], + 'GmtCreate' => ['description' => 'The creation time.', 'type' => 'string', 'example' => '2018-01-01 00:00:00', 'title' => ''], + 'BlackWhiteType' => ['description' => 'The blacklists and whitelists type for comparison. Valid values: BLACK: blacklist. WHITE: whitelist.', 'type' => 'string', 'example' => 'BLACK', 'title' => ''], + 'Name' => ['description' => 'The name of the filter.', 'type' => 'string', 'example' => 'AnotherFilter', 'title' => ''], + 'VersionType' => ['description' => 'The version type. Valid values: FOTA | APP.', 'type' => 'string', 'example' => 'FOTA', 'title' => ''], + 'Id' => ['description' => 'The ID of the custom filter.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '6F25F67C-F411-499F-BCE2-67CA563CB064', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"6F25F67C-F411-499F-BCE2-67CA563CB064\\"\\n}","errorExample":"{\\n \\"RequestId\\": \\"6F25F67C-F411-499F-BCE2-67CA563CB064\\",\\n \\"HostId\\": \\"iovcc.cn-shanghai.aliyuncs.com\\",\\n \\"Code\\": \\"NoPermissionToAccessProject\\",\\n \\"Message\\": \\"User is not authorized to access the specified project.\\"\\n}"},{"type":"xml","example":"<DeleteVersionBlackDevicesResponse>\\r\\n\\t<RequestId>6F25F67C-F411-499F-BCE2-67CA563CB064</RequestId>\\r\\n</DeleteVersionBlackDevicesResponse>","errorExample":""}]', - 'title' => 'DeleteVersionBlackDevices', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"CustomizedFilter\\": {\\n \\"GmtCreateTimestamp\\": 123543500000,\\n \\"GmtModify\\": \\"2018-01-01 00:01:00\\",\\n \\"ValueCompareType\\": \\"NUMBER\\",\\n \\"VersionId\\": 1,\\n \\"GmtModifyTimestamp\\": 123543500000,\\n \\"Value\\": \\"1,5\\",\\n \\"ValueType\\": \\"WRITE\\",\\n \\"GmtCreate\\": \\"2018-01-01 00:00:00\\",\\n \\"BlackWhiteType\\": \\"BLACK\\",\\n \\"Name\\": \\"AnotherFilter\\",\\n \\"VersionType\\": \\"FOTA\\",\\n \\"Id\\": 1\\n },\\n \\"RequestId\\": \\"6F25F67C-F411-499F-BCE2-67CA563CB064\\"\\n}","type":"json"}]', + 'title' => 'Retrieve custom filter details', + 'summary' => 'Calls DescribeCustomizedFilter to retrieve the details of a custom filter.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'DeleteVersionBlackDevicesById' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [ + ['createdAt' => '2024-06-18T02:20:32.000Z', 'description' => 'Error codes changed'], + ], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'iovcc:DescribeCustomizedFilter', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'DescribeDefaultSchema' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', - 'systemTags' => [ - 'operationType' => 'delete', - ], + 'operationType' => 'read', + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'Ids', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '100,200,300', - ], - ], - [ 'name' => 'ProjectId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'P0VFCREU', - ], - ], - [ - 'name' => 'VersionType', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'FOTA', - ], + 'schema' => ['description' => 'Project ID', 'type' => 'string', 'required' => true, 'example' => 'PIC3UA0V', 'title' => ''], ], [ - 'name' => 'VersionId', + 'name' => 'DeviceModelId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '12345', - ], + 'schema' => ['description' => 'Device model ID', 'type' => 'string', 'required' => true, 'example' => '120', 'title' => ''], ], ], 'responses' => [ @@ -7336,88 +4798,74 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '6F25F67C-F411-499F-BCE2-67CA563CB064', - ], + 'RequestId' => ['description' => 'Request ID', 'type' => 'string', 'example' => '6F25F67C-F411-499F-BCE2-67CA563CB064', 'title' => ''], + 'Schema' => ['description' => 'Default schema information', 'type' => 'string', 'example' => '{"ecu":{"node_desc":"动力系统","brake_controll":{"handbrake":"手刹状态"}},"device_info":{"vin":"车架号","uuid":"uuid","brand":"设备品牌","plugin_version":{"ra":"远程诊断","control":"远程控制","node_desc":"插件版本号","yundevice":"yundevice版本号"},"system_version":"系统版本号"},"car_body_hvac":{"node_desc":"车身与HVAC","cigar_lighter":{"node_desc":"点烟器"},"cleaning_fluid":"清洗液"}}', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"6F25F67C-F411-499F-BCE2-67CA563CB064\\"\\n}","errorExample":"{\\n \\"RequestId\\": \\"6F25F67C-F411-499F-BCE2-67CA563CB064\\",\\n \\"HostId\\": \\"iovcc.cn-shanghai.aliyuncs.com\\",\\n \\"Code\\": \\"NoPermissionToAccessProject\\",\\n \\"Message\\": \\"User is not authorized to access the specified project.\\"\\n}"},{"type":"xml","example":"<DeleteVersionBlackDevicesByIdResponse>\\r\\n\\t<RequestId>6F25F67C-F411-499F-BCE2-67CA563CB064</RequestId>\\r\\n</DeleteVersionBlackDevicesByIdResponse>","errorExample":""}]', - 'title' => 'DeleteVersionBlackDevicesById', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6F25F67C-F411-499F-BCE2-67CA563CB064\\",\\n \\"Schema\\": \\"{\\\\\\"ecu\\\\\\":{\\\\\\"node_desc\\\\\\":\\\\\\"动力系统\\\\\\",\\\\\\"brake_controll\\\\\\":{\\\\\\"handbrake\\\\\\":\\\\\\"手刹状态\\\\\\"}},\\\\\\"device_info\\\\\\":{\\\\\\"vin\\\\\\":\\\\\\"车架号\\\\\\",\\\\\\"uuid\\\\\\":\\\\\\"uuid\\\\\\",\\\\\\"brand\\\\\\":\\\\\\"设备品牌\\\\\\",\\\\\\"plugin_version\\\\\\":{\\\\\\"ra\\\\\\":\\\\\\"远程诊断\\\\\\",\\\\\\"control\\\\\\":\\\\\\"远程控制\\\\\\",\\\\\\"node_desc\\\\\\":\\\\\\"插件版本号\\\\\\",\\\\\\"yundevice\\\\\\":\\\\\\"yundevice版本号\\\\\\"},\\\\\\"system_version\\\\\\":\\\\\\"系统版本号\\\\\\"},\\\\\\"car_body_hvac\\\\\\":{\\\\\\"node_desc\\\\\\":\\\\\\"车身与HVAC\\\\\\",\\\\\\"cigar_lighter\\\\\\":{\\\\\\"node_desc\\\\\\":\\\\\\"点烟器\\\\\\"},\\\\\\"cleaning_fluid\\\\\\":\\\\\\"清洗液\\\\\\"}}\\"\\n}","type":"json"}]', + 'title' => 'Get default schema information by device model', + 'summary' => 'Call DescribeDefaultSchema to get default schema information by device model.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'DeleteVersionWhiteDevices' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'https', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'iovcc:DescribeDefaultSchema', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'DescribeDeviceBrand' => [ + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', - 'systemTags' => [ - 'operationType' => 'delete', - ], + 'operationType' => 'read', + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'DeviceIds', + 'name' => 'ProjectId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '11,22,33', - ], + 'schema' => ['description' => 'The project ID.', 'type' => 'string', 'required' => false, 'example' => 'projectTest', 'title' => ''], ], [ - 'name' => 'ProjectId', + 'name' => 'DeviceBrandId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'P0VFCREU', - ], + 'schema' => ['description' => 'The device brand ID to query. This parameter and **DeviceBrand** cannot both be empty.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''], ], [ - 'name' => 'VersionType', + 'name' => 'DeviceBrand', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'FOTA', - ], + 'schema' => ['description' => 'The device brand name to query. This parameter and **DeviceBrandId** cannot both be empty.', 'type' => 'string', 'required' => false, 'example' => 'TmallGenius', 'title' => ''], ], [ - 'name' => 'VersionId', + 'name' => 'Start', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '12345', - ], + 'schema' => ['description' => 'The start position of the query list.', 'type' => 'string', 'required' => false, 'example' => '0', 'title' => ''], ], [ - 'name' => 'DeviceIdType', + 'name' => 'Length', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'hardware_id', - ], + 'schema' => ['description' => 'The maximum length of the query list.', 'type' => 'string', 'required' => false, 'example' => '20', 'title' => ''], ], ], 'responses' => [ @@ -7425,78 +4873,78 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '6F25F67C-F411-499F-BCE2-67CA563CB064', + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '9c7a3b09-a69a-43f5-8bf2-84f7119810eb', 'title' => ''], + 'DeviceBrand' => [ + 'description' => 'The query result.', + 'type' => 'object', + 'properties' => [ + 'DeviceBrandId' => ['description' => 'The brand ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'Description' => ['description' => 'The brand description.', 'type' => 'string', 'example' => '天猫精灵品牌', 'title' => ''], + 'ProjectId' => ['description' => 'The project ID.', 'type' => 'string', 'example' => 'projectTest', 'title' => ''], + 'Manufacture' => ['description' => 'The manufacturer.', 'type' => 'string', 'example' => 'Alibaba', 'title' => ''], + 'DeviceBrand' => ['description' => 'The brand name.', 'type' => 'string', 'example' => '天猫精灵', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"6F25F67C-F411-499F-BCE2-67CA563CB064\\"\\n}","errorExample":"{\\n \\"RequestId\\": \\"6F25F67C-F411-499F-BCE2-67CA563CB064\\",\\n \\"HostId\\": \\"iovcc.cn-shanghai.aliyuncs.com\\",\\n \\"Code\\": \\"NoPermissionToAccessProject\\",\\n \\"Message\\": \\"User is not authorized to access the specified project.\\"\\n}\\n"},{"type":"xml","example":"<DeleteVersionWhiteDevicesResponse>\\r\\n\\t<RequestId>6F25F67C-F411-499F-BCE2-67CA563CB064</RequestId>\\r\\n</DeleteVersionWhiteDevicesResponse>","errorExample":""}]', - 'title' => 'DeleteVersionWhiteDevices', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9c7a3b09-a69a-43f5-8bf2-84f7119810eb\\",\\n \\"DeviceBrand\\": {\\n \\"DeviceBrandId\\": 1,\\n \\"Description\\": \\"天猫精灵品牌\\",\\n \\"ProjectId\\": \\"projectTest\\",\\n \\"Manufacture\\": \\"Alibaba\\",\\n \\"DeviceBrand\\": \\"天猫精灵\\"\\n }\\n}","type":"json"}]', + 'title' => 'Query device brand information', + 'summary' => 'Queries device brand information by brand ID or brand name.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'DeleteVersionWhiteDevicesById' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'https', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'iovcc:DescribeDeviceBrand', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'DescribeDeviceIdByOuterInfo' => [ + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', - 'systemTags' => [ - 'operationType' => 'delete', - ], + 'operationType' => 'read', + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'Ids', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '1,2,3', - ], - ], - [ 'name' => 'ProjectId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'P0VFCREU', - ], + 'schema' => ['description' => 'The project ID.', 'type' => 'string', 'required' => false, 'example' => 'projectTest', 'title' => ''], ], [ - 'name' => 'VersionType', + 'name' => 'QueryType', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'FOTA', - ], + 'schema' => ['description' => 'The type of the third-party device unique identifier.'."\n" + ."\n" + .'Currently supported values: **sn**, **vin**, and **hardware_id**.', 'type' => 'string', 'required' => false, 'example' => 'sn', 'title' => ''], ], [ - 'name' => 'VersionId', + 'name' => 'QueryValue', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '12345', - ], + 'schema' => ['description' => 'The value of the third-party device unique identifier.', 'type' => 'string', 'required' => false, 'example' => '12345abcde', 'title' => ''], ], ], 'responses' => [ @@ -7504,78 +4952,68 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '6F25F67C-F411-499F-BCE2-67CA563CB064', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '9c7a3b09-a69a-43f5-8bf2-84f7119810eb', 'title' => ''], + 'DeviceId' => ['description' => 'The device ID.', 'type' => 'string', 'example' => 'deviceabcde', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"6F25F67C-F411-499F-BCE2-67CA563CB064\\"\\n}","errorExample":"{\\n \\"RequestId\\": \\"6F25F67C-F411-499F-BCE2-67CA563CB064\\",\\n \\"HostId\\": \\"iovcc.cn-shanghai.aliyuncs.com\\",\\n \\"Code\\": \\"NoPermissionToAccessProject\\",\\n \\"Message\\": \\"User is not authorized to access the specified project.\\"\\n}"},{"type":"xml","example":"<DeleteVersionWhiteDevicesByIdResponse>\\r\\n\\t<RequestId>6F25F67C-F411-499F-BCE2-67CA563CB064</RequestId>\\r\\n</DeleteVersionWhiteDevicesByIdResponse>","errorExample":""}]', - 'title' => 'DeleteVersionWhiteDevicesById', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9c7a3b09-a69a-43f5-8bf2-84f7119810eb\\",\\n \\"DeviceId\\": \\"deviceabcde\\"\\n}","type":"json"}]', + 'title' => 'Query device ID by third-party device unique identifier', + 'summary' => 'Queries a device ID based on a third-party device unique identifier by calling DescribeDeviceIdByOuterInfo.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'UpdateOsBlackWhiteVersions' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'https', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'iovcc:DescribeDeviceIdByOuterInfo', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'DescribeDeviceInfo' => [ + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'update', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'WhiteVersions', + 'name' => 'DeviceId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '2.0.1-R-20180402.1208,3.0.1-R-20180402.1208', - ], + 'schema' => ['description' => 'The device ID.'."\n" + ."\n" + .'This parameter and **DeviceToken** cannot both be empty.', 'type' => 'string', 'required' => false, 'example' => '100', 'title' => ''], ], [ - 'name' => 'ProjectId', + 'name' => 'DeviceToken', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'P0VFCREU', - ], + 'schema' => ['description' => 'The device token.'."\n" + ."\n" + .'This parameter and **DeviceId** cannot both be empty.', 'type' => 'string', 'required' => false, 'example' => 'cn.xxxxxxx', 'title' => ''], ], [ - 'name' => 'VersionId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '12345', - ], - ], - [ - 'name' => 'BlackVersions', + 'name' => 'ProjectId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '2.0.1-R-20180402.1208,3.0.1-R-20180402.1208', - ], + 'schema' => ['description' => 'The project ID.', 'type' => 'string', 'required' => false, 'example' => 'projectTest', 'title' => ''], ], ], 'responses' => [ @@ -7583,228 +5021,295 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '6F25F67C-F411-499F-BCE2-67CA563CB064', + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '9c7a3b09-a69a-43f5-8bf2-84f7119810eb', 'title' => ''], + 'DeviceInfo' => [ + 'description' => 'The response content.', + 'type' => 'object', + 'properties' => [ + 'SerialNumber' => ['description' => 'The serial number of the device.', 'type' => 'string', 'example' => 'xxxxxxxx', 'title' => ''], + 'Status' => ['description' => 'The device status.', 'type' => 'string', 'example' => '1', 'title' => ''], + 'DeviceModelId' => ['description' => 'The device model ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''], + 'MacAddress' => ['description' => 'The MAC address.', 'type' => 'string', 'example' => '00:00:00:00:00:00', 'title' => ''], + 'DeviceId' => ['description' => 'The device ID.', 'type' => 'string', 'example' => 'cn.1234567890', 'title' => ''], + 'DeviceType' => ['description' => 'The device type.', 'type' => 'string', 'example' => '智能家居', 'title' => ''], + 'ProjectId' => ['description' => 'The project ID.', 'type' => 'string', 'example' => 'projectTest', 'title' => ''], + 'DeviceModel' => ['description' => 'The device model.', 'type' => 'string', 'example' => 'X1', 'title' => ''], + 'UsageType' => ['description' => 'The device usage type. Valid values:'."\n" + ."\n" + .'- **0**: Private device.'."\n" + .'- **1**: Business or shared device.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'Vin' => ['description' => 'The Vehicle Identification Number (VIN) of the device. This parameter is used for automotive products.', 'type' => 'string', 'example' => 'xxxxxxxx', 'title' => ''], + 'UsageTypeDesc' => ['description' => 'The description of the device usage type. Valid values:'."\n" + ."\n" + .'- **private**: Private device.'."\n" + .'- **business**: Business or shared device.', 'type' => 'string', 'example' => 'private', 'title' => ''], + 'Uuid' => ['description' => 'The device UUID.', 'type' => 'string', 'example' => 'xxxxxxxx', 'title' => ''], + 'HardwareId' => ['description' => 'The hardware ID.', 'type' => 'string', 'example' => 'xxxxxxx', 'title' => ''], + 'Region' => ['description' => 'The country code of the device location.', 'type' => 'string', 'example' => 'cn', 'title' => ''], + 'SoftwareId' => ['description' => 'The software ID.', 'type' => 'string', 'example' => 'xxxxxxxx', 'title' => ''], + 'Name' => ['description' => 'The nickname of the device.', 'type' => 'string', 'example' => '我的天猫精灵', 'title' => ''], + 'DeviceBrand' => ['description' => 'The device brand.', 'type' => 'string', 'example' => 'TmallGenuine', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"6F25F67C-F411-499F-BCE2-67CA563CB064\\"\\n}","errorExample":"{\\n \\"RequestId\\": \\"6F25F67C-F411-499F-BCE2-67CA563CB064\\",\\n \\"HostId\\": \\"iovcc.cn-shanghai.aliyuncs.com\\",\\n \\"Code\\": \\"NoPermissionToAccessProject\\",\\n \\"Message\\": \\"User is not authorized to access the specified project.\\"\\n}"},{"type":"xml","example":"<UpdateOsBlackWhiteVersionsResponse>\\r\\n\\t<RequestId>6F25F67C-F411-499F-BCE2-67CA563CB064</RequestId>\\r\\n</UpdateOsBlackWhiteVersionsResponse>","errorExample":""}]', - 'title' => 'UpdateOsBlackWhiteVersions', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9c7a3b09-a69a-43f5-8bf2-84f7119810eb\\",\\n \\"DeviceInfo\\": {\\n \\"SerialNumber\\": \\"xxxxxxxx\\",\\n \\"Status\\": \\"1\\",\\n \\"DeviceModelId\\": 10,\\n \\"MacAddress\\": \\"00:00:00:00:00:00\\",\\n \\"DeviceId\\": \\"cn.1234567890\\",\\n \\"DeviceType\\": \\"智能家居\\",\\n \\"ProjectId\\": \\"projectTest\\",\\n \\"DeviceModel\\": \\"X1\\",\\n \\"UsageType\\": 0,\\n \\"Vin\\": \\"xxxxxxxx\\",\\n \\"UsageTypeDesc\\": \\"private\\",\\n \\"Uuid\\": \\"xxxxxxxx\\",\\n \\"HardwareId\\": \\"xxxxxxx\\",\\n \\"Region\\": \\"cn\\",\\n \\"SoftwareId\\": \\"xxxxxxxx\\",\\n \\"Name\\": \\"我的天猫精灵\\",\\n \\"DeviceBrand\\": \\"TmallGenuine\\"\\n }\\n}","type":"json"}]', + 'title' => 'Retrieve device information', + 'summary' => 'Calls DescribeDeviceInfo to retrieve device information.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'UpdateOsVersion' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'https', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'iovcc:DescribeDeviceInfo', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'DescribeDeviceModel' => [ + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'update', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'IsMilestone', + 'name' => 'DeviceModelId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'Y', - ], + 'schema' => ['description' => 'The device model ID.'."\n" + ."\n" + .'This parameter and **DeviceModel** cannot both be empty.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], ], [ - 'name' => 'IsForceNightUpgrade', + 'name' => 'DeviceModel', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'N', - ], + 'schema' => ['description' => 'The device model name.'."\n" + ."\n" + .'This parameter and **DeviceModelId** cannot both be empty.', 'type' => 'string', 'required' => false, 'example' => 'X1', 'title' => ''], ], [ 'name' => 'ProjectId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'P0VFCREU', - ], - ], - [ - 'name' => 'DeviceModelId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '12', - ], - ], - [ - 'name' => 'SystemVersion', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '2.0.1-R-20180501.1208', - ], + 'schema' => ['description' => 'The project ID.', 'type' => 'string', 'required' => false, 'example' => 'projectTest', 'title' => ''], ], - [ - 'name' => 'ReleaseNote', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'DeviceModel' => [ + 'description' => 'The response content.', + 'type' => 'object', + 'properties' => [ + 'DeviceModelId' => ['description' => 'The model ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''], + 'HardwareType' => ['description' => 'The basis for generating device IDs.', 'type' => 'string', 'example' => 'sn', 'title' => ''], + 'DeviceName' => ['description' => 'The device name.', 'type' => 'string', 'example' => 'device', 'title' => ''], + 'DeviceType' => ['description' => 'The device type.', 'type' => 'string', 'example' => '智能家居', 'title' => ''], + 'CanCreateDeviceId' => ['description' => 'Indicates whether device IDs can be generated.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'ProjectId' => ['description' => 'The project ID.', 'type' => 'string', 'example' => 'projectTest', 'title' => ''], + 'OsPlatform' => ['description' => 'The operating system platform.', 'type' => 'string', 'example' => 'android', 'title' => ''], + 'DeviceModel' => ['description' => 'The device model name.', 'type' => 'string', 'example' => 'ROEWE RX5', 'title' => ''], + 'SecurityChip' => ['description' => 'Indicates whether chip ID2 authentication hardening is enabled.', 'type' => 'string', 'example' => '0', 'title' => ''], + 'DeviceLogoUrl' => ['description' => 'The device logo URL.', 'type' => 'string', 'example' => 'http://dis-cdn.aicc.aliyun.com/1151125281886341/375KZRO8TARYBQY7P0E4/2019-04-12/1555062240807.jpg', 'title' => ''], + 'Description' => ['description' => 'The device model description.', 'type' => 'string', 'example' => '荣威RX5', 'title' => ''], + 'ObjectKey' => ['description' => 'The OSS storage key.', 'type' => 'string', 'example' => '1151125281886341/375KZRO8TARYBQY7P0E4/2019-04-12/1555062240807.jpg', 'title' => ''], + 'InitUsageTypeDesc' => ['description' => 'The description of the device usage type.'."\n" + ."\n" + .'0 indicates a private device. 1 indicates an operational or shared device.', 'type' => 'string', 'example' => '0', 'title' => ''], + 'InitUsageType' => ['description' => 'The device usage type.'."\n" + ."\n" + .'0 indicates private. 1 indicates business. Default value: **0**.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'DeviceBrand' => ['description' => 'The device brand name.', 'type' => 'string', 'example' => 'ROEWE', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '9c7a3b09-a69a-43f5-8bf2-84f7119810eb', 'title' => ''], + ], 'description' => '', - 'type' => 'string', - 'required' => true, + 'title' => '', 'example' => '', ], ], - [ - 'name' => 'Remark', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"DeviceModel\\": {\\n \\"DeviceModelId\\": 10,\\n \\"HardwareType\\": \\"sn\\",\\n \\"DeviceName\\": \\"device\\",\\n \\"DeviceType\\": \\"智能家居\\",\\n \\"CanCreateDeviceId\\": 1,\\n \\"ProjectId\\": \\"projectTest\\",\\n \\"OsPlatform\\": \\"android\\",\\n \\"DeviceModel\\": \\"ROEWE RX5\\",\\n \\"SecurityChip\\": \\"0\\",\\n \\"DeviceLogoUrl\\": \\"http://dis-cdn.aicc.aliyun.com/1151125281886341/375KZRO8TARYBQY7P0E4/2019-04-12/1555062240807.jpg\\",\\n \\"Description\\": \\"荣威RX5\\",\\n \\"ObjectKey\\": \\"1151125281886341/375KZRO8TARYBQY7P0E4/2019-04-12/1555062240807.jpg\\",\\n \\"InitUsageTypeDesc\\": \\"0\\",\\n \\"InitUsageType\\": 0,\\n \\"DeviceBrand\\": \\"ROEWE\\"\\n },\\n \\"RequestId\\": \\"9c7a3b09-a69a-43f5-8bf2-84f7119810eb\\"\\n}","type":"json"}]', + 'title' => 'Retrieve device model information', + 'summary' => 'Retrieves device model information by model name or model ID.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'iovcc:DescribeDeviceModel', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + ], + 'DescribeDeviceOnlineInfo' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'IsForceUpgrade', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'N', - ], + 'AK' => [], ], + ], + 'operationType' => 'read', + 'systemTags' => ['operationType' => 'get'], + 'parameters' => [ [ - 'name' => 'BlackVersionList', + 'name' => 'ProjectId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '2.0.1-R-20180501.1208,2.0.1-R-20180501.1209', - ], + 'schema' => ['description' => 'The iovcc project ID.', 'type' => 'string', 'required' => true, 'example' => 'sghghshr', 'title' => ''], ], [ - 'name' => 'WhiteVersionList', + 'name' => 'Type', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '2.0.1-R-20180501.1208,2.0.1-R-20180501.1209', - ], + 'schema' => ['description' => 'The type of the query condition. Valid values:'."\n" + ."\n" + .'- deviceToken'."\n" + .'- deviceId'."\n" + .'- iasToken'."\n" + .'- iasId.', 'type' => 'string', 'required' => true, 'example' => 'deviceId', 'title' => ''], ], [ - 'name' => 'MaxClientVersion', + 'name' => 'Value', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '100', - ], + 'schema' => ['description' => 'The query object.'."\n" + ."\n" + .'The value that corresponds to the specified query condition type.', 'type' => 'string', 'required' => true, 'example' => 'c86b36f1d19c488f9ae3798f332b9fd5', 'title' => ''], ], - [ - 'name' => 'MinClientVersion', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '629586FE-CB2E-4742-995E-121F952CEB72', 'title' => ''], + 'Devices' => [ + 'description' => 'The list of device online status details.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'LoginTime' => ['description' => 'The most recent connection time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1525701500000', 'title' => ''], + 'DeviceId' => ['description' => 'The device ID in the dis system.', 'type' => 'string', 'example' => 'fc71429ddd9b473c81d7ef5f33ab10cc', 'title' => ''], + 'Online' => ['description' => 'Indicates whether the device is online.'."\n" + ."\n" + .'A value of 1 indicates online, 0 indicates offline, and -1 indicates that the device does not exist.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'ProjectId' => ['description' => 'The iovcc project ID.', 'type' => 'string', 'example' => 'gsgshhfs', 'title' => ''], + 'IasId' => ['description' => 'The account ID in the ias system.', 'type' => 'string', 'example' => '123xxxxxxxxxxx', 'title' => ''], + 'SystemVersion' => ['description' => 'The system version.', 'type' => 'string', 'example' => '5.3.0', 'title' => ''], + 'Terminal' => ['description' => 'The device model.', 'type' => 'string', 'example' => 'iphone7', 'title' => ''], + 'ClientVersion' => ['description' => 'The cmns client version.', 'type' => 'string', 'example' => '2.1.0.1.20170327', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '90', + 'title' => '', + 'example' => '', ], ], - [ - 'name' => 'NightUpgradeDownloadType', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '1', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"629586FE-CB2E-4742-995E-121F952CEB72\\",\\n \\"Devices\\": [\\n {\\n \\"LoginTime\\": 1525701500000,\\n \\"DeviceId\\": \\"fc71429ddd9b473c81d7ef5f33ab10cc\\",\\n \\"Online\\": 1,\\n \\"ProjectId\\": \\"gsgshhfs\\",\\n \\"IasId\\": \\"123xxxxxxxxxxx\\",\\n \\"SystemVersion\\": \\"5.3.0\\",\\n \\"Terminal\\": \\"iphone7\\",\\n \\"ClientVersion\\": \\"2.1.0.1.20170327\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'Query device online details', + 'summary' => 'Queries the online status details of a device by device ID or account ID (token).', + 'description' => '> When you specify a deviceId or deviceToken, you can determine whether a specific device is online.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'iovcc:DescribeDeviceOnlineInfo', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + ], + 'DescribeDeviceShadow' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'NightUpgradeIsShowTip', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'N', - ], + 'AK' => [], ], + ], + 'operationType' => 'read', + 'systemTags' => ['operationType' => 'get'], + 'parameters' => [ [ - 'name' => 'NightUpgradeIsAllowedCancel', + 'name' => 'ProjectId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'N', - ], + 'schema' => ['description' => 'The project ID.', 'type' => 'string', 'required' => true, 'example' => 'PIC3UA0V', 'title' => ''], ], [ - 'name' => 'RomList', + 'name' => 'DeviceId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '10|0|http://www.oss-server.com/file0.zip,11|123|http://www.oss-server.com/file1.zip,0|124|http://www.oss-server.com/file2.zip', - ], + 'schema' => ['description' => 'The device ID.', 'type' => 'string', 'required' => true, 'example' => '1ac5e182e9634252a02d442a4d5d16fc', 'title' => ''], ], [ - 'name' => 'Id', + 'name' => 'DeviceModel', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '123456', - ], + 'schema' => ['description' => 'The device model name.', 'type' => 'string', 'required' => false, 'example' => 'model_2nd', 'title' => ''], ], [ - 'name' => 'EnableMobileDownload', + 'name' => 'Path', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'Y', - ], + 'schema' => ['description' => 'The path to retrieve.', 'type' => 'string', 'required' => true, 'example' => '/', 'title' => ''], ], [ - 'name' => 'MobileDownloadMaxSize', + 'name' => 'ViewSubscribed', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '10', - ], + 'schema' => ['description' => 'Specifies whether to view only subscribed information.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], ], ], 'responses' => [ @@ -7812,68 +5317,73 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '6F25F67C-F411-499F-BCE2-67CA563CB064', + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '6F25F67C-F411-499F-BCE2-67CA563CB064', 'title' => ''], + 'DeviceShadow' => [ + 'description' => 'The device shadow information.', + 'type' => 'object', + 'properties' => [ + 'DeviceShadow' => ['description' => 'The additional device information.', 'type' => 'string', 'example' => '[{\\"id\\":10102,\\"name\\":\\"车门:车门\\",\\"open\\":true,\\"pId\\":101,\\"path\\":\\"/车身与HVAC/车门/车门\\"},{\\"id\\":10101,\\"name\\":\\"锁止状态:1\\",\\"open\\":true,\\"pId\\":101,\\"path\\":\\"/车身与HVAC/车门/锁止状态\\"}]', 'title' => ''], + 'DeviceInfo' => ['description' => 'The device information.', 'type' => 'string', 'example' => '{\\"schema版本\\":\\"1.0\\",\\"uuid\\":\\"002\\",\\"制造商\\":\\"0110446as34\\",\\"对内型号\\":\\"test_model_product\\",\\"对外型号\\":\\"test_model\\",\\"插件版本号\\":{\\"插件版本号\\":\\"1.0\\",\\"远程控制\\":\\"1.0\\",\\"远程诊断\\":\\"1.0\\"},\\"数据更新时间\\":\\"2018-09-14 22:00:01\\",\\"最近登录账号ID\\":\\"4***********\\",\\"系统版本号\\":\\"1.0.0\\",\\"设备品牌\\":\\"003\\",\\"设备描述\\":\\"sample desc1\\",\\"车架号\\":\\"001\\"}', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"6F25F67C-F411-499F-BCE2-67CA563CB064\\"\\n}","errorExample":"{\\n \\"RequestId\\": \\"6F25F67C-F411-499F-BCE2-67CA563CB064\\",\\n \\"HostId\\": \\"iovcc.cn-shanghai.aliyuncs.com\\",\\n \\"Code\\": \\"NoPermissionToAccessProject\\",\\n \\"Message\\": \\"User is not authorized to access the specified project.\\"\\n}"},{"type":"xml","example":"<UpdateOsVersionResponse>\\r\\n\\t<RequestId>6F25F67C-F411-499F-BCE2-67CA563CB064</RequestId>\\r\\n</UpdateOsVersionResponse>","errorExample":""}]', - 'title' => 'UpdateOsVersion', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6F25F67C-F411-499F-BCE2-67CA563CB064\\",\\n \\"DeviceShadow\\": {\\n \\"DeviceShadow\\": \\"[{\\\\\\\\\\\\\\"id\\\\\\\\\\\\\\":10102,\\\\\\\\\\\\\\"name\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"车门:车门\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"open\\\\\\\\\\\\\\":true,\\\\\\\\\\\\\\"pId\\\\\\\\\\\\\\":101,\\\\\\\\\\\\\\"path\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"/车身与HVAC/车门/车门\\\\\\\\\\\\\\"},{\\\\\\\\\\\\\\"id\\\\\\\\\\\\\\":10101,\\\\\\\\\\\\\\"name\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"锁止状态:1\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"open\\\\\\\\\\\\\\":true,\\\\\\\\\\\\\\"pId\\\\\\\\\\\\\\":101,\\\\\\\\\\\\\\"path\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"/车身与HVAC/车门/锁止状态\\\\\\\\\\\\\\"}]\\",\\n \\"DeviceInfo\\": \\"{\\\\\\\\\\\\\\"schema版本\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"1.0\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"uuid\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"002\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"制造商\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"0110446as34\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"对内型号\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"test_model_product\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"对外型号\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"test_model\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"插件版本号\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"插件版本号\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"1.0\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"远程控制\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"1.0\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"远程诊断\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"1.0\\\\\\\\\\\\\\"},\\\\\\\\\\\\\\"数据更新时间\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"2018-09-14 22:00:01\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"最近登录账号ID\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"4***********\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"系统版本号\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"1.0.0\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"设备品牌\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"003\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"设备描述\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"sample desc1\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"车架号\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"001\\\\\\\\\\\\\\"}\\"\\n }\\n}","type":"json"}]', + 'title' => 'Retrieve device shadow information', + 'summary' => 'Calls DescribeDeviceShadow to retrieve device shadow information.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'UpdateOsVersionReleaseNote' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'https', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'iovcc:DescribeDeviceShadow', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'DescribeDeviceValiditySchema' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'update', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'ProjectId', + 'name' => 'DeviceModel', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'P0VFCREU', - ], + 'schema' => ['description' => 'The device model information.', 'type' => 'string', 'required' => false, 'example' => 'model_2nd', 'title' => ''], ], [ - 'name' => 'VersionId', + 'name' => 'SchemaVersion', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '10023', - ], + 'schema' => ['description' => 'The schema version.', 'type' => 'string', 'required' => false, 'example' => '1.0', 'title' => ''], ], [ - 'name' => 'ReleaseNote', + 'name' => 'ProjectId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'new release note', - ], + 'schema' => ['description' => 'The project ID.', 'type' => 'string', 'required' => true, 'example' => 'PIC3UA0V', 'title' => ''], ], ], 'responses' => [ @@ -7881,68 +5391,85 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '6F25F67C-F411-499F-BCE2-67CA563CB064', + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '629586FE-CB2E-4742-995E-121F952CEB72', 'title' => ''], + 'ItemList' => [ + 'description' => 'The list of validation schemas.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Minimum' => ['description' => 'The minimum value.', 'type' => 'number', 'format' => 'float', 'example' => '5', 'title' => ''], + 'Type' => ['description' => 'The type.', 'type' => 'string', 'example' => 'string', 'title' => ''], + 'Maximum' => ['description' => 'The maximum value.', 'type' => 'number', 'format' => 'float', 'example' => '10', 'title' => ''], + 'ItemType' => ['description' => 'The data type.', 'type' => 'string', 'example' => 'boolean', 'title' => ''], + 'EnumListStr' => ['description' => 'The string information of enumeration values.', 'type' => 'string', 'example' => '[a,b]', 'title' => ''], + 'ExclusiveMinimum' => ['description' => 'Indicates whether the minimum value is excluded.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'MaxLength' => ['description' => 'The maximum length.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'Required' => ['description' => 'Indicates whether the field is required.', 'type' => 'string', 'example' => 'true', 'title' => ''], + 'Description' => ['description' => 'The description.', 'type' => 'string', 'example' => '机型验证信息', 'title' => ''], + 'ExclusiveMaximum' => ['description' => 'Indicates whether the maximum value is excluded.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'Path' => ['description' => 'The path.', 'type' => 'string', 'example' => '/havc/oil_level', 'title' => ''], + 'MinLength' => ['description' => 'The minimum length.', 'type' => 'integer', 'format' => 'int32', 'example' => '5', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"6F25F67C-F411-499F-BCE2-67CA563CB064\\"\\n}","errorExample":"{\\n \\"RequestId\\": \\"6F25F67C-F411-499F-BCE2-67CA563CB064\\",\\n \\"HostId\\": \\"iovcc.cn-shanghai.aliyuncs.com\\",\\n \\"Code\\": \\"NoPermissionToAccessProject\\",\\n \\"Message\\": \\"User is not authorized to access the specified project.\\"\\n}"},{"type":"xml","example":"<UpdateOsVersionReleaseNoteResponse>\\r\\n\\t<RequestId>6F25F67C-F411-499F-BCE2-67CA563CB064</RequestId>\\r\\n</UpdateOsVersionReleaseNoteResponse>","errorExample":""}]', - 'title' => 'UpdateOsVersionReleaseNote', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"629586FE-CB2E-4742-995E-121F952CEB72\\",\\n \\"ItemList\\": [\\n {\\n \\"Minimum\\": 5,\\n \\"Type\\": \\"string\\",\\n \\"Maximum\\": 10,\\n \\"ItemType\\": \\"boolean\\",\\n \\"EnumListStr\\": \\"[a,b]\\",\\n \\"ExclusiveMinimum\\": true,\\n \\"MaxLength\\": 10,\\n \\"Required\\": \\"true\\",\\n \\"Description\\": \\"机型验证信息\\",\\n \\"ExclusiveMaximum\\": false,\\n \\"Path\\": \\"/havc/oil_level\\",\\n \\"MinLength\\": 5\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'Retrieve validation schema by device model', + 'summary' => 'Calls DescribeDeviceValiditySchema to retrieve the validation schema based on the device model.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'UpdateOsVersionRemark' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'https', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'iovcc:DescribeDeviceValiditySchema', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'DescribeMessage' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'update', - ], + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'ProjectId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'P0VFCREU', - ], + 'schema' => ['description' => 'The ID of the IoVCC project.', 'type' => 'string', 'required' => true, 'example' => 'fsgtd5y5r', 'title' => ''], ], [ - 'name' => 'VersionId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '12304', - ], - ], - [ - 'name' => 'Remark', + 'name' => 'MessageId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'sample remark', - ], + 'schema' => ['description' => 'The message ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '455888', 'title' => ''], ], ], 'responses' => [ @@ -7950,68 +5477,110 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '6F25F67C-F411-499F-BCE2-67CA563CB064', + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'sfsgghdhh56666', 'title' => ''], + 'Message' => [ + 'description' => 'The message details.', + 'type' => 'object', + 'properties' => [ + 'Type' => ['description' => 'The message type.'."\n" + ."\n" + .'**1**: pass-through. **2**: notification.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''], + 'Action' => ['description' => 'The message listener channel.', 'type' => 'string', 'example' => 'com.aliyun.iovcc.test', 'title' => ''], + 'ProjectId' => ['description' => 'The ID of the IoVCC project.', 'type' => 'string', 'example' => 'ssgdghww', 'title' => ''], + 'PredictSendCnt' => ['description' => 'The expected number of devices to which the message is delivered.', 'type' => 'integer', 'format' => 'int32', 'example' => '3', 'title' => ''], + 'Uri' => ['description' => 'The URI specific to AliOS, used to locate the application that receives the message.', 'type' => 'string', 'example' => 'page://broadcast.alios.com', 'title' => ''], + 'Desc' => ['description' => 'The description of the notification content.', 'type' => 'string', 'example' => 'this is desc test', 'title' => ''], + 'AuditMsg' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'AppName' => ['description' => 'The name of the client application.', 'type' => 'string', 'example' => 'pushdemo', 'title' => ''], + 'AppKey' => ['description' => 'The identifier of the client application. This is the custom application AppKey under the project.', 'type' => 'string', 'example' => 'wTiRKC9m', 'title' => ''], + 'GmtCreateTime' => ['description' => 'The time when the message was created, in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1525681245000', 'title' => ''], + 'ExipiredTime' => ['description' => 'The expiration time, in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1525684245000', 'title' => ''], + 'AckCnt' => ['description' => 'The number of devices that received the message.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'Title' => ['description' => 'The notification title.', 'type' => 'string', 'example' => 'this is a title test', 'title' => ''], + 'Parameter' => ['description' => 'The message parameters.'."\n" + ."\n" + .'The value is a JSON string that combines pkgContent and customCent.', 'type' => 'string', 'example' => '{\\"package\\":\\"com.aliyun.iovcc.test\\",\\"key1\\":\\"value1\\"}"', 'title' => ''], + 'Audit' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + 'Id' => ['description' => 'The message ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '2231942', 'title' => ''], + 'SendStatus' => ['description' => 'The message status.'."\n" + ."\n" + .'**0**: sending. **1**: message sent. **2**: message expired.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"6F25F67C-F411-499F-BCE2-67CA563CB064\\"\\n}","errorExample":"{\\n \\"RequestId\\": \\"6F25F67C-F411-499F-BCE2-67CA563CB064\\",\\n \\"HostId\\": \\"iovcc.cn-shanghai.aliyuncs.com\\",\\n \\"Code\\": \\"NoPermissionToAccessProject\\",\\n \\"Message\\": \\"User is not authorized to access the specified project.\\"\\n}"},{"type":"xml","example":"<UpdateOsVersionRemarkResponse>\\r\\n\\t<RequestId>6F25F67C-F411-499F-BCE2-67CA563CB064</RequestId>\\r\\n</UpdateOsVersionRemarkResponse>","errorExample":""}]', - 'title' => 'UpdateOsVersionRemark', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"sfsgghdhh56666\\",\\n \\"Message\\": {\\n \\"Type\\": 2,\\n \\"Action\\": \\"com.aliyun.iovcc.test\\",\\n \\"ProjectId\\": \\"ssgdghww\\",\\n \\"PredictSendCnt\\": 3,\\n \\"Uri\\": \\"page://broadcast.alios.com\\",\\n \\"Desc\\": \\"this is desc test\\",\\n \\"AuditMsg\\": \\"\\",\\n \\"AppName\\": \\"pushdemo\\",\\n \\"AppKey\\": \\"wTiRKC9m\\",\\n \\"GmtCreateTime\\": 1525681245000,\\n \\"ExipiredTime\\": 1525684245000,\\n \\"AckCnt\\": 1,\\n \\"Title\\": \\"this is a title test\\",\\n \\"Parameter\\": \\"{\\\\\\\\\\\\\\"package\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"com.aliyun.iovcc.test\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"key1\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"value1\\\\\\\\\\\\\\"}\\\\\\"\\",\\n \\"Audit\\": 0,\\n \\"Id\\": 2231942,\\n \\"SendStatus\\": 0\\n }\\n}","type":"json"}]', + 'title' => 'Query message details', + 'summary' => 'Queries the details of a message by message ID. The details include the message body and message delivery status.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'UpdateOsVersionStatus' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [ + ['createdAt' => '2023-01-06T13:51:28.000Z', 'description' => 'Error codes changed'], + ], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'iovcc:DescribeMessage', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'DescribeOpenAccount' => [ + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'update', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'ProjectId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'P0VFCREU', - ], + 'schema' => ['description' => 'The project ID.', 'type' => 'string', 'required' => false, 'example' => 'projectTest', 'title' => ''], ], [ - 'name' => 'Id', + 'name' => 'IdentityId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '12304', - ], + 'schema' => ['description' => 'The cloud user ID.', 'type' => 'string', 'required' => false, 'example' => 'identityidtest', 'title' => ''], ], [ - 'name' => 'Status', + 'name' => 'Idp', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'PUBLISHED', - ], + 'schema' => ['description' => 'The account authentication provider.'."\n" + ."\n" + .'Either **IdentityId** or the combination of **IdToken** and **Idp** must be specified.', 'type' => 'string', 'required' => false, 'example' => 'ALIOS', 'title' => ''], + ], + [ + 'name' => 'IdToken', + 'in' => 'query', + 'schema' => ['description' => 'The account token.'."\n" + ."\n" + .'Either **IdentityId** or the combination of **IdToken** and **Idp** must be specified.', 'type' => 'string', 'required' => false, 'example' => 'idtokentest', 'title' => ''], + ], + [ + 'name' => 'OpenId', + 'in' => 'query', + 'schema' => ['description' => 'The third-party account platform ID.', 'type' => 'string', 'required' => false, 'example' => '12345', 'title' => ''], ], ], 'responses' => [ @@ -8019,58 +5588,81 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '6F25F67C-F411-499F-BCE2-67CA563CB064', + 'OpenAccount' => [ + 'description' => 'The response content.', + 'type' => 'object', + 'properties' => [ + 'Status' => ['description' => 'The status.'."\n" + ."\n" + .'**0** indicates Normal. **1** indicates disabled.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'Type' => ['description' => 'The type.'."\n" + ."\n" + .'**1** indicates a third-party linked account.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'DisplayName' => ['description' => 'The display name.', 'type' => 'string', 'example' => 'displaynametest', 'title' => ''], + 'CreateAccessKey' => ['description' => 'The AccessKey pair created for the account.', 'type' => 'string', 'example' => 'createaccesskeytest', 'title' => ''], + 'OpenId' => ['description' => 'The third-party platform account ID.', 'type' => 'string', 'example' => '12345', 'title' => ''], + 'Mobile' => ['description' => 'The mobile phone number.', 'type' => 'string', 'example' => '1390000****', 'title' => ''], + 'Region' => ['description' => 'The region.', 'type' => 'string', 'example' => 'cn', 'title' => ''], + 'IdentityId' => ['description' => 'The account ID.', 'type' => 'string', 'example' => 'identityidtest', 'title' => ''], + 'LoginId' => ['description' => 'The logon name.', 'type' => 'string', 'example' => 'loginidtest', 'title' => ''], + 'Idp' => ['description' => 'The short name of the third-party platform, such as ALIOS.', 'type' => 'string', 'example' => 'ALIOS', 'title' => ''], + 'AliyunId' => ['description' => 'The tenant ID.', 'type' => 'string', 'example' => 'aliyunidtest', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '9c7a3b09-a69a-43f5-8bf2-84f7119810eb', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"6F25F67C-F411-499F-BCE2-67CA563CB064\\"\\n}","errorExample":"{\\n \\"RequestId\\": \\"6F25F67C-F411-499F-BCE2-67CA563CB064\\",\\n \\"HostId\\": \\"iovcc.cn-shanghai.aliyuncs.com\\",\\n \\"Code\\": \\"NoPermissionToAccessProject\\",\\n \\"Message\\": \\"User is not authorized to access the specified project.\\"\\n}"},{"type":"xml","example":"<UpdateOsVersionStatusResponse>\\r\\n\\t<RequestId>6F25F67C-F411-499F-BCE2-67CA563CB064</RequestId>\\r\\n</UpdateOsVersionStatusResponse>","errorExample":""}]', - 'title' => 'UpdateOsVersionStatus', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"OpenAccount\\": {\\n \\"Status\\": 0,\\n \\"Type\\": 1,\\n \\"DisplayName\\": \\"displaynametest\\",\\n \\"CreateAccessKey\\": \\"createaccesskeytest\\",\\n \\"OpenId\\": \\"12345\\",\\n \\"Mobile\\": \\"1390000****\\",\\n \\"Region\\": \\"cn\\",\\n \\"IdentityId\\": \\"identityidtest\\",\\n \\"LoginId\\": \\"loginidtest\\",\\n \\"Idp\\": \\"ALIOS\\",\\n \\"AliyunId\\": \\"aliyunidtest\\"\\n },\\n \\"RequestId\\": \\"9c7a3b09-a69a-43f5-8bf2-84f7119810eb\\"\\n}","type":"json"}]', + 'title' => 'Retrieve account information', + 'summary' => 'Retrieves account information by calling DescribeOpenAccount.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'DescribeAppVersion' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'https', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'iovcc:DescribeOpenAccount', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'DescribeOsVersion' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'ProjectId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'P0VFCREU', - ], + 'schema' => ['description' => 'The project ID.', 'type' => 'string', 'required' => true, 'example' => 'P0VFCREU', 'title' => ''], ], [ 'name' => 'VersionId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '12345', - ], + 'schema' => ['description' => 'The version ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '12345', 'title' => ''], ], ], 'responses' => [ @@ -8078,243 +5670,136 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'AppVersion' => [ - 'description' => '', + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '6F25F67C-F411-499F-BCE2-67CA563CB064', 'title' => ''], + 'OsVersion' => [ + 'description' => 'The basic information about the version.', 'type' => 'object', 'properties' => [ - 'Status' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'PUBLISHED', - ], - 'IsAllowNewInstall' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Y', - ], - 'ReleaseNote' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'sample release note', - ], - 'PackageName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'com.aliyun.iovcc.ota', - ], - 'Remark' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'sample remark', - ], - 'StatusName' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'ApkMd5' => [ - 'description' => '', - 'type' => 'string', - 'example' => '34653456wertwe234653retwewer3456', - ], - 'RestartAppParam' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'k1:v1', - ], - 'WhiteVersionList' => [ - 'description' => '', - 'type' => 'string', - 'example' => '10,20,30', - ], - 'AppName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'iovcc-ota', - ], - 'AppId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '12', - ], - 'RestartAppType' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'activity', - ], - 'VersionCode' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '201', - ], - 'BlackVersionList' => [ - 'description' => '', - 'type' => 'string', - 'example' => '10,20,30', - ], - 'GmtModify' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2018-04-24 12:23:45', - ], - 'DownloadUrl' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'http://www.cdn-server.com/file.zip', - ], - 'Adapters' => [ - 'description' => '', + 'Status' => ['description' => 'The version status. Valid values:'."\n" + ."\n" + .'- **INITIAL**: initial state'."\n" + .'- **CREATING**: being created'."\n" + .'- **CREATE_FAILED**: creation failed'."\n" + .'- **CREATE_COMPLETED**: creation completed'."\n" + .'- **TESTING**: being tested'."\n" + .'- **TEST_PASSED**: test passed'."\n" + .'- **PREPUBLISHED**: pre-released'."\n" + .'- **PUBLISHED**: published'."\n" + .'- **UNUSED**: deprecated'."\n" + .'- **FROZEN**: frozen'."\n" + .'- **DOWN**: delisted.', 'type' => 'string', 'example' => 'PUBLISHED', 'title' => ''], + 'DeviceModelId' => ['description' => 'The device model ID.', 'type' => 'string', 'example' => '123', 'title' => ''], + 'BlackVersionList' => ['description' => 'The blacklist of OS versions, separated by commas.', 'type' => 'string', 'example' => '2.0.1,3.0.1', 'title' => ''], + 'IsMilestone' => ['description' => 'Indicates whether this is a milestone version. Valid values: Y or N.', 'type' => 'string', 'example' => 'Y', 'title' => ''], + 'GmtModify' => ['description' => 'The time when the version was created, in the `yyyy-MM-dd HH:mm:ss` format.', 'type' => 'string', 'example' => '2018-04-24 12:23:45', 'title' => ''], + 'ReleaseNote' => ['description' => 'The release note of the version.', 'type' => 'string', 'example' => '改用UI用户体验，提升系统稳定性', 'title' => ''], + 'Remark' => ['description' => 'The remarks.', 'type' => 'string', 'example' => '版本备注信息，终端设备不可见', 'title' => ''], + 'SystemVersion' => ['description' => 'The OS version number.', 'type' => 'string', 'example' => '2.0.1-R-20180506.0824', 'title' => ''], + 'StatusName' => ['description' => 'The Chinese name of the version status.', 'type' => 'string', 'example' => '已发布', 'title' => ''], + 'DeviceModelName' => ['description' => 'The device model name.', 'type' => 'string', 'example' => 'DM1', 'title' => ''], + 'WhiteVersionList' => ['description' => 'The whitelist of OS versions.', 'type' => 'string', 'example' => '2.0.1,3.0.1', 'title' => ''], + 'MaxClientVersion' => ['description' => 'The maximum version code of the OTA SDK that is allowed.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'RomList' => [ + 'description' => 'The list of upgrade packages.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'DeviceModelId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '123', - ], - 'MaxOsVersion' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2.0.1-R-20180412.0923', - ], - 'MinOsVersion' => [ - 'description' => '', - 'type' => 'string', - 'example' => '3.0.1-R-20180412.0923', - ], - 'VersionId' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '12345', - ], - 'Id' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1234', - ], - 'DeviceModelName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'DM1', - ], + 'GmtModify' => ['description' => 'The time when the upgrade package was last modified, in the `yyyy-MM-dd HH:mm:ss` format.', 'type' => 'string', 'example' => '2018-04-24 12:23:45', 'title' => ''], + 'SplitNum' => ['description' => 'The number of shards of the upgrade package. Each shard is 10 MB.', 'type' => 'string', 'example' => '10', 'title' => ''], + 'DownloadUrl' => ['description' => 'The download URL of the upgrade package.', 'type' => 'string', 'example' => 'https://www.cdn-server.com/file.zip', 'title' => ''], + 'Size' => ['description' => 'The size of the upgrade package, in bytes.', 'type' => 'string', 'example' => '10000', 'title' => ''], + 'GmtCreate' => ['description' => 'The time when the upgrade package was created, in the `yyyy-MM-dd HH:mm:ss` format.', 'type' => 'string', 'example' => '2018-04-24 12:23:45', 'title' => ''], + 'VersionId' => ['description' => 'The version ID to which the upgrade package belongs.', 'type' => 'integer', 'format' => 'int64', 'example' => '12345', 'title' => ''], + 'Md5' => ['description' => 'The MD5 hash of the upgrade package.', 'type' => 'string', 'example' => 'we3utrw4esdfgkhsdlfha', 'title' => ''], + 'BaseVersion' => ['description' => 'The baseline OS version. This value is empty if the package is a full package.', 'type' => 'string', 'example' => '2.0.1-R-20180502.1205', 'title' => ''], + 'Id' => ['description' => 'The upgrade package ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], + 'OriginalUrl' => ['description' => 'The original URL of the upgrade package.', 'type' => 'string', 'example' => 'http://www.oss-server.com/file.zip', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], - 'IsSilentUpgrade' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'N', - ], - 'InstallType' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'auto', - ], - 'IsNeedRestart' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'N', - ], - 'Size' => [ - 'description' => '', - 'type' => 'string', - 'example' => '1204560', - ], - 'RestartType' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'app', - ], - 'GmtCreate' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2018-04-24 12:23:45', - ], - 'Md5' => [ - 'description' => '', - 'type' => 'string', - 'example' => '345adsff2094asas2345et3', - ], - 'AppVersion' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2.0.1', - ], - 'IsForceUpgrade' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'N', - ], - 'Id' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '12345', - ], - 'OriginalUrl' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'http://www.oss-server.com/file.zip', + 'MinClientVersion' => ['description' => 'The minimum version code of the OTA SDK that is allowed.', 'type' => 'string', 'example' => '100', 'title' => ''], + 'NightUpgradeOption' => [ + 'description' => 'The night upgrade options.', + 'type' => 'object', + 'properties' => [ + 'DownloadType' => ['description' => 'The download type for night upgrades. Valid values:'."\n" + ."\n" + .'- **1**: download over Wi-Fi only.'."\n" + .'- **2**: download over any network.', 'type' => 'string', 'example' => '1', 'title' => ''], + 'IsAllowedCancel' => ['description' => 'Indicates whether the night upgrade can be canceled. Valid values: Y or N.', 'type' => 'string', 'example' => 'N', 'title' => ''], + 'IsShowTip' => ['description' => 'Indicates whether a prompt is displayed during the night upgrade. Valid values: Y or N.', 'type' => 'string', 'example' => 'N', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], + 'GmtCreate' => ['description' => 'The time when the version was created, in the `yyyy-MM-dd HH:mm:ss` format.', 'type' => 'string', 'example' => '2018-04-24 12:23:45', 'title' => ''], + 'IsForceNightUpgrade' => ['description' => 'Indicates whether a forced night upgrade is enabled. Valid values: Y or N. This value and the forced upgrade option cannot both be set to Y.', 'type' => 'string', 'example' => 'N', 'title' => ''], + 'MobileDownloadMaxSize' => ['description' => 'The maximum size of packages that can be downloaded over a mobile network, in MB. Packages that exceed this limit are not automatically downloaded even if mobile network download is enabled.', 'type' => 'string', 'example' => '10', 'title' => ''], + 'EnableMobileDownload' => ['description' => 'Indicates whether upgrade packages can be downloaded over a mobile network.', 'type' => 'string', 'example' => 'Y', 'title' => ''], + 'IsForceUpgrade' => ['description' => 'Indicates whether a forced upgrade is enabled. Valid values: Y or N.', 'type' => 'string', 'example' => 'N', 'title' => ''], + 'Id' => ['description' => 'The version ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '12345', 'title' => ''], ], - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '6F25F67C-F411-499F-BCE2-67CA563CB064', + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"6F25F67C-F411-499F-BCE2-67CA563CB064\\",\\n \\"AppVersion\\": {\\n \\"Status\\": \\"PUBLISHED\\",\\n \\"IsAllowNewInstall\\": \\"Y\\",\\n \\"ReleaseNote\\": \\"sample release note\\",\\n \\"PackageName\\": \\"com.aliyun.iovcc.ota\\",\\n \\"Remark\\": \\"sample remark\\",\\n \\"StatusName\\": \\"已发布\\",\\n \\"ApkMd5\\": \\"34653456wertwe234653retwewer3456\\",\\n \\"RestartAppParam\\": \\"k1:v1\\",\\n \\"WhiteVersionList\\": \\"10,20,30\\",\\n \\"AppName\\": \\"iovcc-ota\\",\\n \\"AppId\\": \\"12\\",\\n \\"RestartAppType\\": \\"activity\\",\\n \\"VersionCode\\": 201,\\n \\"GmtModify\\": \\"2018-04-24 12:23:45\\",\\n \\"BlackVersionList\\": \\"10,20,30\\",\\n \\"DownloadUrl\\": \\"http://www.cdn-server.com/file.zip\\",\\n \\"IsSilentUpgrade\\": \\"N\\",\\n \\"InstallType\\": \\"auto\\",\\n \\"IsNeedRestart\\": \\"N\\",\\n \\"Size\\": \\"1204560\\",\\n \\"RestartType\\": \\"app\\",\\n \\"GmtCreate\\": \\"2018-04-24 12:23:45\\",\\n \\"Md5\\": \\"345adsff2094asas2345et3\\",\\n \\"AppVersion\\": \\"2.0.1\\",\\n \\"IsForceUpgrade\\": \\"N\\",\\n \\"Id\\": 12345,\\n \\"OriginalUrl\\": \\"http://www.oss-server.com/file.zip\\",\\n \\"Adapters\\": [\\n {\\n \\"DeviceModelId\\": \\"123\\",\\n \\"MaxOsVersion\\": \\"2.0.1-R-20180412.0923\\",\\n \\"MinOsVersion\\": \\"3.0.1-R-20180412.0923\\",\\n \\"VersionId\\": 12345,\\n \\"Id\\": 1234,\\n \\"DeviceModelName\\": \\"DM1\\"\\n }\\n ]\\n }\\n}","errorExample":"{\\n \\"RequestId\\": \\"6F25F67C-F411-499F-BCE2-67CA563CB064\\",\\n \\"HostId\\": \\"iovcc.cn-shanghai.aliyuncs.com\\",\\n \\"Code\\": \\"NoPermissionToAccessProject\\",\\n \\"Message\\": \\"User is not authorized to access the specified project.\\"\\n}"},{"type":"xml","example":"<DescribeAppVersionResponse>\\r\\n\\t<AppVersion>\\r\\n\\t\\t<Adapters>\\r\\n\\t\\t\\t<DeviceModelId>10</DeviceModelId>\\r\\n\\t\\t\\t<Id>100010</Id>\\r\\n\\t\\t\\t<MaxOsVersion>3.0.1-R-20180412.0923</MaxOsVersion>\\r\\n\\t\\t\\t<MinOsVersion>2.0.1-R-20180412.0923</MinOsVersion>\\r\\n\\t\\t\\t<VersionId>123</VersionId>\\r\\n\\t\\t</Adapters>\\r\\n\\t\\t<ApkMd5>645adsff2094asas2345et8</ApkMd5>\\r\\n\\t\\t<AppId>12</AppId>\\r\\n\\t\\t<AppName>iovcc-ota</AppName>\\r\\n\\t\\t<AppVersion>2.0.1</AppVersion>\\r\\n\\t\\t<BlackVersionList></BlackVersionList>\\r\\n\\t\\t<DownloadUrl>http://www.cdn-server.com/file.zip</DownloadUrl>\\r\\n\\t\\t<GmtCreate>2018-04-24 12:23:45</GmtCreate>\\r\\n\\t\\t<GmtModify>2018-04-24 12:23:45</GmtModify>\\r\\n\\t\\t<Id>123</Id>\\r\\n\\t\\t<InstallType>auto</InstallType>\\r\\n\\t\\t<IsAllowNewInstall>N</IsAllowNewInstall>\\r\\n\\t\\t<IsDisableCheckMd5>N</IsDisableCheckMd5>\\r\\n\\t\\t<IsForceUpgrade>N</IsForceUpgrade>\\r\\n\\t\\t<IsNeedRestart>N</IsNeedRestart>\\r\\n\\t\\t<IsSilentUpgrade>N</IsSilentUpgrade>\\r\\n\\t\\t<Md5>345adsff2094asas2345et3</Md5>\\r\\n\\t\\t<OriginalUrl>http://www.oss-server.com/file.zip</OriginalUrl>\\r\\n\\t\\t<PackageName>com.aliyun.iovcc.ota</PackageName>\\r\\n\\t\\t<ReleaseNote>sample release note</ReleaseNote>\\r\\n\\t\\t<Remark>sample remark</Remark>\\r\\n\\t\\t<RestartAppParam>k1:v1</RestartAppParam>\\r\\n\\t\\t<RestartAppType>N</RestartAppType>\\r\\n\\t\\t<RestartType>system</RestartType>\\r\\n\\t\\t<Size>12234523</Size>\\r\\n\\t\\t<Status>PUBLISHED</Status>\\r\\n\\t\\t<StatusName>已发布</StatusName>\\r\\n\\t\\t<VersionCode>201</VersionCode>\\r\\n\\t\\t<WhiteVersionList></WhiteVersionList>\\r\\n\\t</AppVersion>\\r\\n\\t<RequestId>6F25F67C-F411-499F-BCE2-67CA563CB064</RequestId>\\r\\n</DescribeAppVersionResponse>","errorExample":""}]', - 'title' => 'DescribeAppVersion', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6F25F67C-F411-499F-BCE2-67CA563CB064\\",\\n \\"OsVersion\\": {\\n \\"Status\\": \\"PUBLISHED\\",\\n \\"DeviceModelId\\": \\"123\\",\\n \\"BlackVersionList\\": \\"2.0.1,3.0.1\\",\\n \\"IsMilestone\\": \\"Y\\",\\n \\"GmtModify\\": \\"2018-04-24 12:23:45\\",\\n \\"ReleaseNote\\": \\"改用UI用户体验，提升系统稳定性\\",\\n \\"Remark\\": \\"版本备注信息，终端设备不可见\\",\\n \\"SystemVersion\\": \\"2.0.1-R-20180506.0824\\",\\n \\"StatusName\\": \\"已发布\\",\\n \\"DeviceModelName\\": \\"DM1\\",\\n \\"WhiteVersionList\\": \\"2.0.1,3.0.1\\",\\n \\"MaxClientVersion\\": \\"200\\",\\n \\"RomList\\": [\\n {\\n \\"GmtModify\\": \\"2018-04-24 12:23:45\\",\\n \\"SplitNum\\": \\"10\\",\\n \\"DownloadUrl\\": \\"https://www.cdn-server.com/file.zip\\",\\n \\"Size\\": \\"10000\\",\\n \\"GmtCreate\\": \\"2018-04-24 12:23:45\\",\\n \\"VersionId\\": 12345,\\n \\"Md5\\": \\"we3utrw4esdfgkhsdlfha\\",\\n \\"BaseVersion\\": \\"2.0.1-R-20180502.1205\\",\\n \\"Id\\": 100,\\n \\"OriginalUrl\\": \\"http://www.oss-server.com/file.zip\\"\\n }\\n ],\\n \\"MinClientVersion\\": \\"100\\",\\n \\"NightUpgradeOption\\": {\\n \\"DownloadType\\": \\"1\\",\\n \\"IsAllowedCancel\\": \\"N\\",\\n \\"IsShowTip\\": \\"N\\"\\n },\\n \\"GmtCreate\\": \\"2018-04-24 12:23:45\\",\\n \\"IsForceNightUpgrade\\": \\"N\\",\\n \\"MobileDownloadMaxSize\\": \\"10\\",\\n \\"EnableMobileDownload\\": \\"Y\\",\\n \\"IsForceUpgrade\\": \\"N\\",\\n \\"Id\\": 12345\\n }\\n}","type":"json"}]', + 'title' => 'Retrieve details of a specific OS version', + 'summary' => 'Calls DescribeOsVersion to retrieve the details of a specific OS version.', + 'description' => 'Call this operation to retrieve the details of a specific OS version when you want to view version information.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'DescribeOsVersion' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'https', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'iovcc:DescribeOsVersion', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'DescribeProjectAppSecurity' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'ProjectId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'P0VFCREU', - ], + 'schema' => ['description' => 'The project ID.', 'type' => 'string', 'required' => true, 'example' => '11', 'title' => ''], ], [ - 'name' => 'VersionId', + 'name' => 'AppId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '12345', - ], + 'schema' => ['description' => 'The application ID.', 'type' => 'string', 'required' => true, 'example' => 'A3BU0HBO', 'title' => ''], ], ], 'responses' => [ @@ -8322,262 +5807,137 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '6F25F67C-F411-499F-BCE2-67CA563CB064', - ], - 'OsVersion' => [ - 'description' => '', + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'B030DF87-3AC0-4096-A50B-98B16C98B6CC', 'title' => ''], + 'ProjectAppSecurity' => [ + 'description' => 'The key information of the project application.', 'type' => 'object', 'properties' => [ - 'Status' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'PUBLISHED', - ], - 'DeviceModelId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '123', - ], - 'BlackVersionList' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2.0.1,3.0.1', - ], - 'IsMilestone' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Y', - ], - 'GmtModify' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2018-04-24 12:23:45', - ], - 'ReleaseNote' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'Remark' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'SystemVersion' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2.0.1-R-20180506.0824', - ], - 'StatusName' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'DeviceModelName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'DM1', - ], - 'WhiteVersionList' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2.0.1,3.0.1', - ], - 'MaxClientVersion' => [ - 'description' => '', - 'type' => 'string', - 'example' => '200', - ], - 'RomList' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'GmtModify' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2018-04-24 12:23:45', - ], - 'SplitNum' => [ - 'description' => '', - 'type' => 'string', - 'example' => '10', - ], - 'DownloadUrl' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'https://www.cdn-server.com/file.zip', - ], - 'Size' => [ - 'description' => '', - 'type' => 'string', - 'example' => '10000', - ], - 'GmtCreate' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2018-04-24 12:23:45', - ], - 'VersionId' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '12345', - ], - 'Md5' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'we3utrw4esdfgkhsdlfha', - ], - 'BaseVersion' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2.0.1-R-20180502.1205', - ], - 'Id' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'OriginalUrl' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'http://www.oss-server.com/file.zip', - ], - ], - ], - ], - 'MinClientVersion' => [ - 'description' => '', - 'type' => 'string', - 'example' => '100', - ], - 'NightUpgradeOption' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'DownloadType' => [ - 'description' => '', - 'type' => 'string', - 'example' => '1', - ], - 'IsAllowedCancel' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'N', - ], - 'IsShowTip' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'N', - ], - ], - ], - 'GmtCreate' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2018-04-24 12:23:45', - ], - 'IsForceNightUpgrade' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'N', - ], - 'MobileDownloadMaxSize' => [ - 'description' => '', - 'type' => 'string', - 'example' => '10', - ], - 'EnableMobileDownload' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Y', - ], - 'IsForceUpgrade' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'N', - ], - 'Id' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '12345', - ], + 'AppSecret' => ['description' => 'The AppSecret of the application.', 'type' => 'string', 'example' => '222222', 'title' => ''], + 'AppKey' => ['description' => 'The AppKey of the application.', 'type' => 'string', 'example' => '111111', 'title' => ''], + 'AppId' => ['description' => 'The application ID.', 'type' => 'string', 'example' => 'A3BU0HBO', 'title' => ''], + 'GmtCreate' => ['description' => 'The creation time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1508737512000', 'title' => ''], + 'GmtModified' => ['description' => 'The modification time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1508737512000', 'title' => ''], + 'Id' => ['description' => 'The primary key ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '4', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"6F25F67C-F411-499F-BCE2-67CA563CB064\\",\\n \\"OsVersion\\": {\\n \\"Status\\": \\"PUBLISHED\\",\\n \\"DeviceModelId\\": \\"123\\",\\n \\"GmtModify\\": \\"2018-04-24 12:23:45\\",\\n \\"IsMilestone\\": \\"Y\\",\\n \\"BlackVersionList\\": \\"2.0.1,3.0.1\\",\\n \\"ReleaseNote\\": \\"改用UI用户体验，提升系统稳定性\\",\\n \\"Remark\\": \\"版本备注信息，终端设备不可见\\",\\n \\"StatusName\\": \\"已发布\\",\\n \\"SystemVersion\\": \\"2.0.1-R-20180506.0824\\",\\n \\"DeviceModelName\\": \\"DM1\\",\\n \\"WhiteVersionList\\": \\"2.0.1,3.0.1\\",\\n \\"MaxClientVersion\\": \\"200\\",\\n \\"MinClientVersion\\": \\"100\\",\\n \\"GmtCreate\\": \\"2018-04-24 12:23:45\\",\\n \\"IsForceNightUpgrade\\": \\"N\\",\\n \\"MobileDownloadMaxSize\\": \\"10\\",\\n \\"EnableMobileDownload\\": \\"Y\\",\\n \\"IsForceUpgrade\\": \\"N\\",\\n \\"Id\\": 12345,\\n \\"RomList\\": [\\n {\\n \\"GmtModify\\": \\"2018-04-24 12:23:45\\",\\n \\"SplitNum\\": \\"10\\",\\n \\"DownloadUrl\\": \\"https://www.cdn-server.com/file.zip\\",\\n \\"Size\\": \\"10000\\",\\n \\"GmtCreate\\": \\"2018-04-24 12:23:45\\",\\n \\"VersionId\\": 12345,\\n \\"Md5\\": \\"we3utrw4esdfgkhsdlfha\\",\\n \\"BaseVersion\\": \\"2.0.1-R-20180502.1205\\",\\n \\"Id\\": 100,\\n \\"OriginalUrl\\": \\"http://www.oss-server.com/file.zip\\"\\n }\\n ],\\n \\"NightUpgradeOption\\": {\\n \\"IsAllowedCancel\\": \\"N\\",\\n \\"DownloadType\\": \\"1\\",\\n \\"IsShowTip\\": \\"N\\"\\n }\\n }\\n}","errorExample":"{\\n \\"RequestId\\": \\"6F25F67C-F411-499F-BCE2-67CA563CB064\\",\\n \\"HostId\\": \\"iovcc.cn-shanghai.aliyuncs.com\\",\\n \\"Code\\": \\"NoPermissionToAccessProject\\",\\n \\"Message\\": \\"User is not authorized to access the specified project.\\"\\n}"},{"type":"xml","example":"<DescribeOsVersionResponse>\\r\\n\\t<OsVersion>\\r\\n\\t\\t<BlackVersionList>2.0.1,3.0.1</BlackVersionList>\\r\\n\\t\\t<DeviceModelId>100</DeviceModelId>\\r\\n\\t\\t<DeviceModelName>DM1</DeviceModelName>\\r\\n\\t\\t<GmtCreate>2017-12-06 12:04:08</GmtCreate>\\r\\n\\t\\t<GmtModify>2017-12-06 13:04:06</GmtModify>\\r\\n\\t\\t<Id>123</Id>\\r\\n\\t\\t<IsDisableCheckMd5>N</IsDisableCheckMd5>\\r\\n\\t\\t<IsForceNightUpgrade>Y</IsForceNightUpgrade>\\r\\n\\t\\t<IsForceReboot>N</IsForceReboot>\\r\\n\\t\\t<IsForceUpgrade>N</IsForceUpgrade>\\r\\n\\t\\t<IsMilestone>N</IsMilestone>\\r\\n\\t\\t<IsSilentUpgrade>N</IsSilentUpgrade>\\r\\n\\t\\t<MaxClientVersion>200</MaxClientVersion>\\r\\n\\t\\t<MinClientVersion>100</MinClientVersion>\\r\\n\\t\\t<NightUpgradeOption>\\r\\n\\t\\t\\t<DownloadType>1</DownloadType>\\r\\n\\t\\t\\t<IsAllowedCancel>N</IsAllowedCancel>\\r\\n\\t\\t\\t<IsShowTip>N</IsShowTip>\\r\\n\\t\\t</NightUpgradeOption>\\r\\n\\t\\t<ReleaseNote>sample release note</ReleaseNote>\\r\\n\\t\\t<Remark>sample remark</Remark>\\r\\n\\t\\t<RomList>\\r\\n\\t\\t\\t<BaseVersion>1.0.1-R-20180409.0612</BaseVersion>\\r\\n\\t\\t\\t<DownloadUrl>http://www.cdn-server.com/file.zip</DownloadUrl>\\r\\n\\t\\t\\t<GmtCreate>2017-12-06 12:04:08</GmtCreate>\\r\\n\\t\\t\\t<GmtModify>2017-12-06 12:04:08</GmtModify>\\r\\n\\t\\t\\t<Id>123</Id>\\r\\n\\t\\t\\t<Md5>234der456ere56dhwer45ty6eghr570</Md5>\\r\\n\\t\\t\\t<OriginalUrl>http://www.oss-server.com/file.zip</OriginalUrl>\\r\\n\\t\\t\\t<Size>123456</Size>\\r\\n\\t\\t\\t<SplitNum>20</SplitNum>\\r\\n\\t\\t\\t<VersionId>234</VersionId>\\r\\n\\t\\t</RomList>\\r\\n\\t\\t<Status>PUBLISHED</Status>\\r\\n\\t\\t<StatusName>已发布</StatusName>\\r\\n\\t\\t<SystemVersion>2.0.1-R-20180502.1208</SystemVersion>\\r\\n\\t\\t<WhiteVersionList>2.0.1,3.0.1</WhiteVersionList>\\r\\n\\t</OsVersion>\\r\\n\\t<RequestId>6F25F67C-F411-499F-BCE2-67CA563CB064</RequestId>\\r\\n</DescribeOsVersionResponse>","errorExample":""}]', - 'title' => 'DescribeOsVersion', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B030DF87-3AC0-4096-A50B-98B16C98B6CC\\",\\n \\"ProjectAppSecurity\\": {\\n \\"AppSecret\\": \\"222222\\",\\n \\"AppKey\\": \\"111111\\",\\n \\"AppId\\": \\"A3BU0HBO\\",\\n \\"GmtCreate\\": 1508737512000,\\n \\"GmtModified\\": 1508737512000,\\n \\"Id\\": 4\\n }\\n}","type":"json"}]', + 'title' => 'Query key information of a specified application in a specified project', + 'summary' => 'Queries the key information of a specified application in a specified project by calling DescribeProjectAppSecurity.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'GetDeviceSystemUpdateFunnelEvents' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'https', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'iovcc:DescribeProjectAppSecurity', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'DescribeShadowSchema' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'OriginalId', + 'name' => 'DeviceModel', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '23452345234523452', - ], + 'schema' => ['description' => 'The device model.', 'type' => 'string', 'required' => true, 'example' => 'model_2nd', 'title' => ''], + ], + [ + 'name' => 'IsSimple', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to exclude description information from the response.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], ], [ 'name' => 'ProjectId', 'in' => 'query', + 'schema' => ['description' => 'The project ID.', 'type' => 'string', 'required' => true, 'example' => 'PIC3UA0V', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '629586FE-CB2E-4742-995E-121F952CEB72', 'title' => ''], + 'Schema' => ['description' => 'The schema information.', 'type' => 'string', 'example' => '[ { \\"id\\": 102, \\"name\\": \\"product:对内型号\\", \\"open\\": false, \\"pId\\": 1, \\"path\\": \\"/device_info/product\\" }, { \\"id\\": 101, \\"name\\": \\"manufacture:制造商\\", \\"open\\": false, \\"pId\\": 1, \\"path\\": \\"/device_info/manufacture\\" } ]', 'title' => ''], + ], 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'P0VFCREU', + 'title' => '', + 'example' => '', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"629586FE-CB2E-4742-995E-121F952CEB72\\",\\n \\"Schema\\": \\"[ { \\\\\\\\\\\\\\"id\\\\\\\\\\\\\\": 102, \\\\\\\\\\\\\\"name\\\\\\\\\\\\\\": \\\\\\\\\\\\\\"product:对内型号\\\\\\\\\\\\\\", \\\\\\\\\\\\\\"open\\\\\\\\\\\\\\": false, \\\\\\\\\\\\\\"pId\\\\\\\\\\\\\\": 1, \\\\\\\\\\\\\\"path\\\\\\\\\\\\\\": \\\\\\\\\\\\\\"/device_info/product\\\\\\\\\\\\\\" }, { \\\\\\\\\\\\\\"id\\\\\\\\\\\\\\": 101, \\\\\\\\\\\\\\"name\\\\\\\\\\\\\\": \\\\\\\\\\\\\\"manufacture:制造商\\\\\\\\\\\\\\", \\\\\\\\\\\\\\"open\\\\\\\\\\\\\\": false, \\\\\\\\\\\\\\"pId\\\\\\\\\\\\\\": 1, \\\\\\\\\\\\\\"path\\\\\\\\\\\\\\": \\\\\\\\\\\\\\"/device_info/manufacture\\\\\\\\\\\\\\" } ]\\"\\n}","type":"json"}]', + 'title' => 'Retrieve schema information by device model', + 'summary' => 'Calls DescribeShadowSchema to retrieve schema information based on the device model.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'iovcc:DescribeShadowSchema', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + ], + 'DescribeVersionDeviceGroup' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'TargetVersion', + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => ['operationType' => 'get'], + 'parameters' => [ + [ + 'name' => 'ProjectId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '2.0.1-R-20180412.0824', - ], + 'schema' => ['description' => 'The ID of the project.', 'type' => 'string', 'required' => true, 'example' => 'P0VFCREU', 'title' => ''], ], [ - 'name' => 'IdType', + 'name' => 'Id', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'hardware_id', - ], + 'schema' => ['description' => 'The ID of the group.', 'type' => 'string', 'required' => true, 'example' => '1', 'title' => ''], ], ], 'responses' => [ @@ -8585,172 +5945,107 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '6F25F67C-F411-499F-BCE2-67CA563CB064', - ], - 'EventList' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'DeviceId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'AS23DG23SA5D43GA34SD23GW456E', - ], - 'TargetVersion' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2.0.1-R-20180412.0824', - ], - 'Event' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'os_download_succ', - ], - 'ReportTimestamp' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '167845600000', - ], - 'ReportTime' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2018-02-14 14:20:18', - ], - 'TenantId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'P0VFCREU', - ], - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '6F25F67C-F411-499F-BCE2-67CA563CB064', 'title' => ''], + 'DeviceGroup' => [ + 'description' => 'The group details.', + 'type' => 'object', + 'properties' => [ + 'GmtModify' => ['description' => 'The modification time.', 'type' => 'string', 'example' => '2018-01-01 00:01:00', 'title' => ''], + 'Description' => ['description' => 'The description of the group.', 'type' => 'string', 'example' => '测试', 'title' => ''], + 'GmtCreate' => ['description' => 'The creation time.', 'type' => 'string', 'example' => '2018-01-01 00:00:00', 'title' => ''], + 'Name' => ['description' => 'The name of the group.', 'type' => 'string', 'example' => '升级分组', 'title' => ''], + 'Id' => ['description' => 'ID', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'MaxCount' => ['description' => 'The maximum number of devices in the device group.', 'type' => 'string', 'example' => '100', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"6F25F67C-F411-499F-BCE2-67CA563CB064\\",\\n \\"EventList\\": [\\n {\\n \\"DeviceId\\": \\"AS23DG23SA5D43GA34SD23GW456E\\",\\n \\"TargetVersion\\": \\"2.0.1-R-20180412.0824\\",\\n \\"Event\\": \\"os_download_succ\\",\\n \\"ReportTimestamp\\": 167845600000,\\n \\"ReportTime\\": \\"2018-02-14 14:20:18\\",\\n \\"TenantId\\": \\"P0VFCREU\\"\\n }\\n ]\\n}","errorExample":"{\\n \\"RequestId\\": \\"6F25F67C-F411-499F-BCE2-67CA563CB064\\",\\n \\"HostId\\": \\"iovcc.cn-shanghai.aliyuncs.com\\",\\n \\"Code\\": \\"NoPermissionToAccessProject\\",\\n \\"Message\\": \\"User is not authorized to access the specified project.\\"\\n}"},{"type":"xml","example":"<GetDeviceSystemUpdateFunnelEventsResponse>\\r\\n\\t<RequestId>6F25F67C-F411-499F-BCE2-67CA563CB064</RequestId>\\r\\n\\t<EventList>\\r\\n\\t\\t<TotalCount>25</TotalCount>\\r\\n\\t\\t<Items>\\r\\n\\t\\t\\t<TenantId>P0VFCREU</TenantId>\\r\\n\\t\\t\\t<DeviceId>AS23DG23SA5D43GA34SD23GW456E</DeviceId>\\r\\n\\t\\t\\t<TargetVersion>2.0.1-R-20180412.0824</TargetVersion>\\r\\n\\t\\t\\t<Event>os_download_succ</Event>\\r\\n\\t\\t\\t<ReportTime>2018-02-14 14:20:18</ReportTime>\\r\\n\\t\\t</Items>\\r\\n\\t</EventList>\\r\\n</GetDeviceSystemUpdateFunnelEventsResponse>","errorExample":""}]', - 'title' => 'GetDeviceSystemUpdateFunnelEvents', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6F25F67C-F411-499F-BCE2-67CA563CB064\\",\\n \\"DeviceGroup\\": {\\n \\"GmtModify\\": \\"2018-01-01 00:01:00\\",\\n \\"Description\\": \\"测试\\",\\n \\"GmtCreate\\": \\"2018-01-01 00:00:00\\",\\n \\"Name\\": \\"升级分组\\",\\n \\"Id\\": 1,\\n \\"MaxCount\\": \\"100\\"\\n }\\n}","type":"json"}]', + 'title' => 'Retrieve the details of a test device group', + 'summary' => 'Calls DescribeVersionDeviceGroup to retrieve the details of a test device group.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'DelayPublishOsVersion' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [ + ['createdAt' => '2024-06-18T02:20:31.000Z', 'description' => 'Error codes changed'], + ], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'iovcc:DescribeVersionDeviceGroup', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'DiagnosisVersion' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', - 'systemTags' => [ - 'operationType' => 'delete', - ], + 'operationType' => 'read', + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'VersionId', + 'name' => 'OriginalId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '12323', - ], + 'schema' => ['description' => 'The ID value corresponding to the specified ID type.', 'type' => 'string', 'required' => true, 'example' => 'b8fe2e24ff2b48e0a3aa4e49809fc1b3', 'title' => ''], ], [ 'name' => 'ProjectId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'SASUHQ', - ], + 'schema' => ['description' => 'The ID of the project to which the device belongs.', 'type' => 'string', 'required' => true, 'example' => 'P0VFCREU', 'title' => ''], ], [ - 'name' => 'PrepubTime', + 'name' => 'VersionType', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1570672685997', - ], + 'schema' => ['description' => 'The version type. Valid values:'."\n" + ."\n" + .'- **FOTA**: system version'."\n" + .'- **APP**: application version', 'type' => 'string', 'required' => true, 'example' => 'FOTA', 'title' => ''], ], [ - 'name' => 'PublishTime', + 'name' => 'VersionId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1570672685997', - ], + 'schema' => ['description' => 'The version ID.', 'type' => 'string', 'required' => true, 'example' => '1', 'title' => ''], ], [ - 'name' => 'DownTime', + 'name' => 'IdType', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1570672685997', - ], + 'schema' => ['description' => 'The type of OriginalId used for identification. Valid values: **device_id**, **sn**, **vin**, **hardware_id**, **uuid**.', 'type' => 'string', 'required' => true, 'example' => 'device_id', 'title' => ''], ], [ - 'name' => 'Email', + 'name' => 'DiagnoseStyle', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '12323232@qq.com', - ], + 'schema' => ['description' => 'The diagnosis type.', 'type' => 'string', 'required' => true, 'example' => '1', 'title' => ''], ], [ - 'name' => 'Description', + 'name' => 'StartTime', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '', - ], + 'schema' => ['description' => 'The start time of the query time range to be diagnosed.', 'type' => 'string', 'required' => false, 'example' => '2019-09-18 10:44', 'title' => ''], ], [ - 'name' => 'SendMessage', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '', - ], - ], - [ - 'name' => 'PrepublishCount', + 'name' => 'EndTime', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '1000', - ], + 'schema' => ['description' => 'The end time of the query time range to be diagnosed.', 'type' => 'string', 'required' => false, 'example' => '2019-09-18 14:44', 'title' => ''], ], ], 'responses' => [ @@ -8758,130 +6053,88 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '629586FE-CB2E-4742-995E-121F952CEB72', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '6F25F67C-F411-499F-BCE2-67CA563CB064', 'title' => ''], + 'DiagnosisResult' => ['description' => 'The diagnosis result.', 'type' => 'string', 'example' => 'Invalid instance type', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"629586FE-CB2E-4742-995E-121F952CEB72\\"\\n}","errorExample":""},{"type":"xml","example":"<RequestId>629586FE-CB2E-4742-995E-121F952CEB72</RequestId>","errorExample":""}]', - 'title' => 'DelayPublishOsVersion', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'FindOsVersions' => [ - 'methods' => [ - 'post', - 'get', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6F25F67C-F411-499F-BCE2-67CA563CB064\\",\\n \\"DiagnosisResult\\": \\"Invalid instance type\\"\\n}","type":"json"}]', + 'title' => 'Diagnose why a specific version cannot be found for a specific device', + 'summary' => 'Diagnoses the reason why a specific version cannot be found for a specific device.', + 'changeSet' => [ + ['createdAt' => '2024-06-18T02:20:31.000Z', 'description' => 'Error codes changed'], ], - 'schemes' => [ - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'iovcc:DiagnosisVersion', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + ], + 'FindAppVersions' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'ProjectId', + 'name' => 'Status', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'P0VFCREU', - ], + 'schema' => ['description' => 'The version status, such as **TESTING**, **TEST_PASSED**, **PREPUBLISH**, or **PUBLISHED**.', 'type' => 'string', 'required' => false, 'example' => 'PUBLISHED', 'title' => ''], ], [ - 'name' => 'PageIndex', + 'name' => 'ProjectId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '1', - ], + 'schema' => ['description' => 'The project ID.', 'type' => 'string', 'required' => true, 'example' => 'P0VFCREU', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '20', - ], + 'schema' => ['description' => 'The number of entries per page. Valid values: 20 and 50.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '20', 'title' => ''], ], [ 'name' => 'VersionId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '1205', - ], + 'schema' => ['description' => 'The version ID.', 'type' => 'string', 'required' => false, 'example' => '12345', 'title' => ''], ], [ 'name' => 'DeviceModelId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '123', - ], - ], - [ - 'name' => 'SystemVersion', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '2.0.1-R-20180402.1208', - ], + 'schema' => ['description' => 'The device model ID.', 'type' => 'string', 'required' => false, 'example' => '1230', 'title' => ''], ], [ - 'name' => 'Status', + 'name' => 'PageIndex', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'TESTING', - ], + 'schema' => ['description' => 'The page number. Pages start from page 1.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1', 'title' => ''], ], [ - 'name' => 'IsMilestone', + 'name' => 'AppId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'N', - ], + 'schema' => ['description' => 'The application ID.', 'type' => 'string', 'required' => false, 'example' => '123', 'title' => ''], ], [ 'name' => 'Remark', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '', - ], + 'schema' => ['description' => 'The remarks.', 'type' => 'string', 'required' => false, 'example' => 'sample remark', 'title' => ''], ], ], 'responses' => [ @@ -8889,214 +6142,136 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '6F25F67C-F411-499F-BCE2-67CA563CB064', - ], - 'OsVersionList' => [ - 'description' => '', + 'AppVersionList' => [ + 'description' => 'The version list information, including the versions on the current page and the total number of versions that match the specified conditions.', 'type' => 'object', 'properties' => [ 'Items' => [ - 'description' => '', + 'description' => 'The list of versions on the current page that match the specified conditions.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'Status' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'PUBLISHED', - ], - 'GmtCreateTimestamp' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '16754300000', - ], - 'DeviceModelId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '123', - ], - 'GmtModify' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2018-04-24 12:23:45', - ], - 'IsMilestone' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Y', - ], - 'Remark' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'SystemVersion' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2.0.1-R-20180506.0824', - ], - 'StatusName' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'IsForceReboot' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'N', - ], - 'DeviceModelName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'DM1', - ], - 'IsSilentUpgrade' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'N', - ], - 'GmtModifyTimestamp' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '16754300000', - ], - 'IsForceNightUpgrade' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'N', - ], - 'GmtCreate' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2018-04-24 12:23:45', - ], - 'IsForceUpgrade' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'N', - ], - 'Id' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '12004', - ], + 'Status' => ['description' => 'The version status. The status definitions are the same as those for system version upgrades.', 'type' => 'string', 'example' => 'PUBLISHED', 'title' => ''], + 'GmtCreateTimestamp' => ['description' => 'The timestamp when the version was created.', 'type' => 'integer', 'format' => 'int64', 'example' => '12432500000', 'title' => ''], + 'GmtModify' => ['description' => 'The time when the version was last modified.', 'type' => 'string', 'example' => '2018-04-24 12:23:45', 'title' => ''], + 'IsAllowNewInstall' => ['description' => 'Indicates whether the application can be newly installed when it does not exist on the client. This is equivalent to post-installation.', 'type' => 'string', 'example' => 'Y', 'title' => ''], + 'StatusName' => ['description' => 'The status name.', 'type' => 'string', 'example' => '已发布', 'title' => ''], + 'RestartAppParam' => ['description' => 'The application restart parameter. Valid values: Y and N.', 'type' => 'string', 'example' => 'N', 'title' => ''], + 'IsSilentUpgrade' => ['description' => 'Specifies whether silent installation is enabled. Valid values: Y and N.', 'type' => 'string', 'example' => 'N', 'title' => ''], + 'AppPackageName' => ['description' => 'The application package name.', 'type' => 'string', 'example' => 'com.aliyun.iovcc.ota', 'title' => ''], + 'GmtModifyTimestamp' => ['description' => 'The timestamp when the version was last modified.', 'type' => 'integer', 'format' => 'int64', 'example' => '12432500000', 'title' => ''], + 'AppName' => ['description' => 'The application name.', 'type' => 'string', 'example' => 'iovcc-ota', 'title' => ''], + 'InstallType' => ['description' => 'The client installation type for the version upgrade package. Valid values:'."\n" + ."\n" + .'- **auto**: automatic installation.'."\n" + .'- **customize**: custom installation.', 'type' => 'string', 'example' => 'auto', 'title' => ''], + 'IsNeedRestart' => ['description' => 'Specifies whether a restart is required. Valid values: Y and N.', 'type' => 'string', 'example' => 'N', 'title' => ''], + 'RestartAppType' => ['description' => 'The application restart type when restartType is set to application restart. Valid values:'."\n" + ."\n" + .'- **service**: Service restart.'."\n" + .'- **activity**: Activity restart.', 'type' => 'string', 'example' => 'service', 'title' => ''], + 'AppId' => ['description' => 'The application ID.', 'type' => 'string', 'example' => '20', 'title' => ''], + 'RestartType' => ['description' => 'The restart type after the application is installed. Valid values:'."\n" + ."\n" + .'- **system**: system restart.'."\n" + .'- **app**: application restart.', 'type' => 'string', 'example' => 'app', 'title' => ''], + 'GmtCreate' => ['description' => 'The time when the version was created.', 'type' => 'string', 'example' => '2018-04-24 12:23:45', 'title' => ''], + 'AppVersion' => ['description' => 'The application version number.', 'type' => 'string', 'example' => '2.0.2', 'title' => ''], + 'VersionCode' => ['description' => 'The application version code, which is used to compare version numbers during application upgrades.', 'type' => 'string', 'example' => '201', 'title' => ''], + 'IsForceUpgrade' => ['description' => 'Specifies whether a forced upgrade is required. Valid values: Y and N.', 'type' => 'string', 'example' => 'N', 'title' => ''], + 'Id' => ['description' => 'The version ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '12345', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], - 'TotalCount' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1000', - ], + 'TotalCount' => ['description' => 'The total number of records that match the specified conditions. You can use this value to calculate the total number of pages.', 'type' => 'integer', 'format' => 'int32', 'example' => '1000', 'title' => ''], ], + 'title' => '', + 'example' => '', ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '6F25F67C-F411-499F-BCE2-67CA563CB064', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"6F25F67C-F411-499F-BCE2-67CA563CB064\\",\\n \\"OsVersionList\\": {\\n \\"TotalCount\\": 1000,\\n \\"Items\\": [\\n {\\n \\"GmtCreateTimestamp\\": 16754300000,\\n \\"Status\\": \\"PUBLISHED\\",\\n \\"DeviceModelId\\": \\"123\\",\\n \\"IsMilestone\\": \\"Y\\",\\n \\"GmtModify\\": \\"2018-04-24 12:23:45\\",\\n \\"Remark\\": \\"测试\\",\\n \\"StatusName\\": \\"已发布\\",\\n \\"SystemVersion\\": \\"2.0.1-R-20180506.0824\\",\\n \\"IsForceReboot\\": \\"N\\",\\n \\"DeviceModelName\\": \\"DM1\\",\\n \\"IsSilentUpgrade\\": \\"N\\",\\n \\"GmtModifyTimestamp\\": 16754300000,\\n \\"IsForceNightUpgrade\\": \\"N\\",\\n \\"GmtCreate\\": \\"2018-04-24 12:23:45\\",\\n \\"IsForceUpgrade\\": \\"N\\",\\n \\"Id\\": 12004\\n }\\n ]\\n }\\n}","errorExample":"{\\n \\"RequestId\\": \\"6F25F67C-F411-499F-BCE2-67CA563CB064\\",\\n \\"HostId\\": \\"iovcc.cn-shanghai.aliyuncs.com\\",\\n \\"Code\\": \\"NoPermissionToAccessProject\\",\\n \\"Message\\": \\"User is not authorized to access the specified project.\\"\\n}"},{"type":"xml","example":"<FindOsVersionsResponse>\\r\\n\\t<OsVersionList>\\r\\n\\t\\t<Items>\\r\\n\\t\\t\\t<DeviceModelId>100</DeviceModelId>\\r\\n\\t\\t\\t<DeviceModelName>DM1</DeviceModelName>\\r\\n\\t\\t\\t<GmtCreate>2017-12-06 12:04:08</GmtCreate>\\r\\n\\t\\t\\t<GmtModify>2017-12-06 13:04:06</GmtModify>\\r\\n\\t\\t\\t<Id>123</Id>\\r\\n\\t\\t\\t<IsForceNightUpgrade>Y</IsForceNightUpgrade>\\r\\n\\t\\t\\t<IsForceReboot>N</IsForceReboot>\\r\\n\\t\\t\\t<IsForceUpgrade>N</IsForceUpgrade>\\r\\n\\t\\t\\t<IsMilestone>N</IsMilestone>\\r\\n\\t\\t\\t<IsSilentUpgrade>N</IsSilentUpgrade>\\r\\n\\t\\t\\t<Remark>测试</Remark>\\r\\n\\t\\t\\t<Status>PUBLISHED</Status>\\r\\n\\t\\t\\t<StatusName>已发布</StatusName>\\r\\n\\t\\t\\t<SystemVersion>2.0.1-R-20180502.1208</SystemVersion>\\r\\n\\t\\t</Items>\\r\\n\\t\\t<TotalCount>1000</TotalCount>\\r\\n\\t</OsVersionList>\\r\\n\\t<RequestId>6F25F67C-F411-499F-BCE2-67CA563CB064</RequestId>\\r\\n</FindOsVersionsResponse>","errorExample":""}]', - 'title' => 'FindOsVersions', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AppVersionList\\": {\\n \\"Items\\": [\\n {\\n \\"Status\\": \\"PUBLISHED\\",\\n \\"GmtCreateTimestamp\\": 12432500000,\\n \\"GmtModify\\": \\"2018-04-24 12:23:45\\",\\n \\"IsAllowNewInstall\\": \\"Y\\",\\n \\"StatusName\\": \\"已发布\\",\\n \\"RestartAppParam\\": \\"N\\",\\n \\"IsSilentUpgrade\\": \\"N\\",\\n \\"AppPackageName\\": \\"com.aliyun.iovcc.ota\\",\\n \\"GmtModifyTimestamp\\": 12432500000,\\n \\"AppName\\": \\"iovcc-ota\\",\\n \\"InstallType\\": \\"auto\\",\\n \\"IsNeedRestart\\": \\"N\\",\\n \\"RestartAppType\\": \\"service\\",\\n \\"AppId\\": \\"20\\",\\n \\"RestartType\\": \\"app\\",\\n \\"GmtCreate\\": \\"2018-04-24 12:23:45\\",\\n \\"AppVersion\\": \\"2.0.2\\",\\n \\"VersionCode\\": \\"201\\",\\n \\"IsForceUpgrade\\": \\"N\\",\\n \\"Id\\": 12345\\n }\\n ],\\n \\"TotalCount\\": 1000\\n },\\n \\"RequestId\\": \\"6F25F67C-F411-499F-BCE2-67CA563CB064\\"\\n}","type":"json"}]', + 'title' => 'Query application versions by page', + 'summary' => 'Queries a paginated list of application versions by calling FindAppVersions.', + 'description' => '**Supports multiple query conditions, such as device model and system version number.**.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'FindVersionWhiteDevices' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [ + ['createdAt' => '2024-06-18T02:20:30.000Z', 'description' => 'Error codes changed'], + ], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'iovcc:FindAppVersions', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'FindCustomizedFilters' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'ProjectId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'P0VFCREU', - ], + 'schema' => ['description' => 'The ID of the project.', 'type' => 'string', 'required' => true, 'example' => 'P0VFCREU', 'title' => ''], ], [ 'name' => 'VersionId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '12345', - ], + 'schema' => ['description' => 'The version ID.', 'type' => 'string', 'required' => true, 'example' => '1', 'title' => ''], ], [ - 'name' => 'VersionType', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'FOTA', - ], - ], - [ - 'name' => 'DeviceId', + 'name' => 'PageIndex', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'AS23DG23SA5D43GA34SD23GW456E', - ], + 'schema' => ['description' => 'The start index of the current page.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1', 'title' => ''], ], [ - 'name' => 'OriginalId', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '23452345234523452', - ], + 'schema' => ['description' => 'The page size.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '20', 'title' => ''], ], [ - 'name' => 'PageIndex', + 'name' => 'Name', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '1', - ], + 'schema' => ['description' => 'The name of the custom filter condition.', 'type' => 'string', 'required' => false, 'example' => 'AnotherFilter', 'title' => ''], ], [ - 'name' => 'PageSize', + 'name' => 'VersionType', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '20', - ], + 'schema' => ['description' => 'The version type. Valid values:'."\n" + ."\n" + .'- **FOTA**: system version'."\n" + .'- **APP**: application version.', 'type' => 'string', 'required' => true, 'example' => 'FOTA', 'title' => ''], ], ], 'responses' => [ @@ -9104,121 +6279,114 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '6F25F67C-F411-499F-BCE2-67CA563CB064', - ], - 'DeviceList' => [ - 'description' => '', + 'CustomizedFilterList' => [ + 'description' => 'The query result of custom filter conditions.', 'type' => 'object', 'properties' => [ 'Items' => [ - 'description' => '', + 'description' => 'The list of result details.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'GmtCreateTimestamp' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1868400000', - ], - 'OriginalId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '23452345234523452', - ], - 'DeviceId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'AS23DG23SA5D43GA34SD23GW456E', - ], - 'IdType' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'hardware_id', - ], - 'GmtCreate' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2018-02-14 14:20:18', - ], - 'Id' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '123', - ], + 'GmtModifyTimestamp' => ['description' => 'The modification timestamp.', 'type' => 'integer', 'format' => 'int64', 'example' => '12354350000', 'title' => ''], + 'GmtCreateTimestamp' => ['description' => 'The creation timestamp.', 'type' => 'integer', 'format' => 'int64', 'example' => '12354350000', 'title' => ''], + 'Value' => ['description' => 'The filter condition value.', 'type' => 'string', 'example' => '1,4', 'title' => ''], + 'GmtModify' => ['description' => 'The modification time.', 'type' => 'string', 'example' => '2018-01-01 00:01:00', 'title' => ''], + 'ValueCompareType' => ['description' => 'The comparison type of the value. Valid values: **NUMBER** (compared as a number), **STRING** (compared as a string).', 'type' => 'string', 'example' => 'NUMBER', 'title' => ''], + 'GmtCreate' => ['description' => 'The creation time.', 'type' => 'string', 'example' => '2018-01-01 00:00:00', 'title' => ''], + 'BlackWhiteType' => ['description' => 'The blacklist or whitelist type for comparison. Valid values: **BLACK** (blacklist), **WHITE** (whitelist).', 'type' => 'string', 'example' => 'BLACK', 'title' => ''], + 'Name' => ['description' => 'The filter condition name.', 'type' => 'string', 'example' => 'AnotherFilter', 'title' => ''], + 'Id' => ['description' => 'ID', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], - 'TotalCount' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '30', - ], + 'TotalCount' => ['description' => 'The total number of records that match the conditions.', 'type' => 'integer', 'format' => 'int32', 'example' => '30', 'title' => ''], ], + 'title' => '', + 'example' => '', ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '6F25F67C-F411-499F-BCE2-67CA563CB064', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"6F25F67C-F411-499F-BCE2-67CA563CB064\\",\\n \\"DeviceList\\": {\\n \\"TotalCount\\": 30,\\n \\"Items\\": [\\n {\\n \\"GmtCreateTimestamp\\": 1868400000,\\n \\"OriginalId\\": \\"23452345234523452\\",\\n \\"DeviceId\\": \\"AS23DG23SA5D43GA34SD23GW456E\\",\\n \\"IdType\\": \\"hardware_id\\",\\n \\"GmtCreate\\": \\"2018-02-14 14:20:18\\",\\n \\"Id\\": 123\\n }\\n ]\\n }\\n}","errorExample":"{\\n \\"RequestId\\": \\"6F25F67C-F411-499F-BCE2-67CA563CB064\\",\\n \\"HostId\\": \\"iovcc.cn-shanghai.aliyuncs.com\\",\\n \\"Code\\": \\"NoPermissionToAccessProject\\",\\n \\"Message\\": \\"User is not authorized to access the specified project.\\"\\n}"},{"type":"xml","example":"<FindVersionWhiteDevicesResponse>\\r\\n\\t<RequestId>6F25F67C-F411-499F-BCE2-67CA563CB064</RequestId>\\r\\n\\t<DeviceList>\\r\\n\\t\\t<TotalCount>25</TotalCount>\\r\\n\\t\\t<Items>\\r\\n\\t\\t\\t<Id>1</Id>\\r\\n\\t\\t\\t<DeviceId>AS23DG23SA5D43GA34SD23GW456E</DeviceId>\\r\\n\\t\\t\\t<IdType>hardware_id</IdType>\\r\\n\\t\\t\\t<OriginalId>23452345234523452</OriginalId>\\r\\n\\t\\t\\t<GmtCreate>2018-02-14 14:20:18</GmtCreate>\\r\\n\\t\\t</Items>\\r\\n\\t</DeviceList>\\r\\n</FindVersionWhiteDevicesResponse>","errorExample":""}]', - 'title' => 'FindVersionWhiteDevices', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"CustomizedFilterList\\": {\\n \\"Items\\": [\\n {\\n \\"GmtModifyTimestamp\\": 12354350000,\\n \\"GmtCreateTimestamp\\": 12354350000,\\n \\"Value\\": \\"1,4\\",\\n \\"GmtModify\\": \\"2018-01-01 00:01:00\\",\\n \\"ValueCompareType\\": \\"NUMBER\\",\\n \\"GmtCreate\\": \\"2018-01-01 00:00:00\\",\\n \\"BlackWhiteType\\": \\"BLACK\\",\\n \\"Name\\": \\"AnotherFilter\\",\\n \\"Id\\": 1\\n }\\n ],\\n \\"TotalCount\\": 30\\n },\\n \\"RequestId\\": \\"6F25F67C-F411-499F-BCE2-67CA563CB064\\"\\n}","type":"json"}]', + 'title' => 'Query custom filter conditions', + 'summary' => 'Queries custom filter conditions by paging. You can query by filter condition name.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'PublishOsVersion' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [ + ['createdAt' => '2024-06-18T02:20:30.000Z', 'description' => 'Error codes changed'], ], - 'schemes' => [ - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'iovcc:FindCustomizedFilters', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + ], + 'FindCustomizedProperties' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', - 'systemTags' => [ - 'operationType' => 'create', - ], + 'operationType' => 'read', + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'ProjectId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'P0VFCREU', - ], + 'schema' => ['description' => 'The ID of the project.', 'type' => 'string', 'required' => true, 'example' => 'P0VFCREU', 'title' => ''], ], [ 'name' => 'VersionId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '1', - ], + 'schema' => ['description' => 'The version ID.', 'type' => 'string', 'required' => true, 'example' => '1', 'title' => ''], ], [ - 'name' => 'SendMessage', + 'name' => 'PageIndex', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'boolean', - 'required' => true, - 'example' => 'false', - ], + 'schema' => ['description' => 'The start index of the current page.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '20', 'title' => ''], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => ['description' => 'The name of the custom property to query.', 'type' => 'string', 'required' => false, 'example' => 'AnotherWhiteList', 'title' => ''], + ], + [ + 'name' => 'VersionType', + 'in' => 'query', + 'schema' => ['description' => 'The version type. Valid values:'."\n" + .'- FOTA: system version'."\n" + .'- APP: application version.', 'type' => 'string', 'required' => true, 'example' => 'FOTA', 'title' => ''], ], ], 'responses' => [ @@ -9226,89 +6394,123 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '6F25F67C-F411-499F-BCE2-67CA563CB064', + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '6F25F67C-F411-499F-BCE2-67CA563CB064', 'title' => ''], + 'CustomizedPropertyList' => [ + 'description' => 'The query result of custom properties.', + 'type' => 'object', + 'properties' => [ + 'Items' => [ + 'description' => 'The list of returned records.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'GmtCreateTimestamp' => ['description' => 'The creation timestamp.', 'type' => 'integer', 'format' => 'int64', 'example' => '1324320000', 'title' => ''], + 'Value' => ['description' => 'The custom property value.', 'type' => 'string', 'example' => '1.0,2.0', 'title' => ''], + 'GmtCreate' => ['description' => 'The creation time.', 'type' => 'string', 'example' => '2018-01-01 00:00:00', 'title' => ''], + 'Name' => ['description' => 'The custom property name.', 'type' => 'string', 'example' => 'AnotherWhiteList', 'title' => ''], + 'Id' => ['description' => 'The custom property ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'TotalCount' => ['description' => 'The total number of records that match the specified conditions.', 'type' => 'integer', 'format' => 'int32', 'example' => '30', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"6F25F67C-F411-499F-BCE2-67CA563CB064\\"\\n}","errorExample":"{\\n \\"RequestId\\": \\"6F25F67C-F411-499F-BCE2-67CA563CB064\\",\\n \\"HostId\\": \\"iovcc.cn-shanghai.aliyuncs.com\\",\\n \\"Code\\": \\"NoPermissionToAccessProject\\",\\n \\"Message\\": \\"User is not authorized to access the specified project.\\"\\n}"},{"type":"xml","example":"<PublishOsVersionResponse>\\r\\n\\t<RequestId>6F25F67C-F411-499F-BCE2-67CA563CB064</RequestId>\\r\\n</PublishOsVersionResponse>","errorExample":""}]', - 'title' => 'PublishOsVersion', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6F25F67C-F411-499F-BCE2-67CA563CB064\\",\\n \\"CustomizedPropertyList\\": {\\n \\"Items\\": [\\n {\\n \\"GmtCreateTimestamp\\": 1324320000,\\n \\"Value\\": \\"1.0,2.0\\",\\n \\"GmtCreate\\": \\"2018-01-01 00:00:00\\",\\n \\"Name\\": \\"AnotherWhiteList\\",\\n \\"Id\\": 1\\n }\\n ],\\n \\"TotalCount\\": 30\\n }\\n}","type":"json"}]', + 'title' => 'Query custom properties', + 'summary' => 'Queries a list of custom properties by paging. You can search by custom property name.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'CreateShadowSchema' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [ + ['createdAt' => '2024-06-18T02:20:30.000Z', 'description' => 'Error codes changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'iovcc:FindCustomizedProperties', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + ], + 'FindOsVersions' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', - 'systemTags' => [ - 'operationType' => 'create', - ], + 'operationType' => 'read', + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ + 'name' => 'ProjectId', + 'in' => 'query', + 'schema' => ['description' => 'The project ID.', 'type' => 'string', 'required' => true, 'example' => 'P0VFCREU', 'title' => ''], + ], + [ + 'name' => 'PageIndex', + 'in' => 'query', + 'schema' => ['description' => 'The page number. Pages start from 1.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries per page. Valid values: 20, 50, and 100.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '20', 'title' => ''], + ], + [ + 'name' => 'VersionId', + 'in' => 'query', + 'schema' => ['description' => 'The version ID.', 'type' => 'string', 'required' => false, 'example' => '1205', 'title' => ''], + ], + [ 'name' => 'DeviceModelId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '120', - ], + 'schema' => ['description' => 'The device model ID.', 'type' => 'string', 'required' => false, 'example' => '123', 'title' => ''], ], [ - 'name' => 'AuthType', + 'name' => 'SystemVersion', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'The OS version number.', 'type' => 'string', 'required' => false, 'example' => '2.0.1-R-20180402.1208', 'title' => ''], ], [ - 'name' => 'Namespace', + 'name' => 'Status', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'b09e93ce436aaf0dcfc2fb2004c1fde8', - ], + 'schema' => ['description' => 'The version status, such as **TESTING**, **TEST_PASSED**, **PREPUBLISH**, or **PUBLISHED**.', 'type' => 'string', 'required' => false, 'example' => 'TESTING', 'title' => ''], ], [ - 'name' => 'ProjectId', + 'name' => 'IsMilestone', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'PIC3UA0V', - ], + 'schema' => ['description' => 'Specifies whether the version is a milestone. Valid values: Y and N.', 'type' => 'string', 'required' => false, 'example' => 'N', 'title' => ''], ], [ - 'name' => 'Schema', + 'name' => 'Remark', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '', - ], + 'schema' => ['description' => 'The version remarks.', 'type' => 'string', 'required' => false, 'example' => '备注', 'title' => ''], ], ], 'responses' => [ @@ -9316,59 +6518,115 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '629586FE-CB2E-4742-995E-121F952CEB72', + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '6F25F67C-F411-499F-BCE2-67CA563CB064', 'title' => ''], + 'OsVersionList' => [ + 'description' => 'The version list information, including the versions on the current page and the total number of versions that match the query conditions.', + 'type' => 'object', + 'properties' => [ + 'Items' => [ + 'description' => 'The list of versions on the current page that match the query conditions.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Status' => ['description' => 'The version status.', 'type' => 'string', 'example' => 'PUBLISHED', 'title' => ''], + 'GmtCreateTimestamp' => ['description' => 'The timestamp when the version was created.', 'type' => 'integer', 'format' => 'int64', 'example' => '16754300000', 'title' => ''], + 'DeviceModelId' => ['description' => 'The device model ID.', 'type' => 'string', 'example' => '123', 'title' => ''], + 'GmtModify' => ['description' => 'The time when the version was last modified.', 'type' => 'string', 'example' => '2018-04-24 12:23:45', 'title' => ''], + 'IsMilestone' => ['description' => 'Indicates whether the version is a milestone.', 'type' => 'string', 'example' => 'Y', 'title' => ''], + 'Remark' => ['description' => 'The version remarks.', 'type' => 'string', 'example' => '测试', 'title' => ''], + 'SystemVersion' => ['description' => 'The OS version number.', 'type' => 'string', 'example' => '2.0.1-R-20180506.0824', 'title' => ''], + 'StatusName' => ['description' => 'The status name.', 'type' => 'string', 'example' => '已发布', 'title' => ''], + 'IsForceReboot' => ['description' => 'Indicates whether a forced restart is required.', 'type' => 'string', 'example' => 'N', 'title' => ''], + 'DeviceModelName' => ['description' => 'The device model name.', 'type' => 'string', 'example' => 'DM1', 'title' => ''], + 'IsSilentUpgrade' => ['description' => 'Indicates whether silent upgrade is enabled.', 'type' => 'string', 'example' => 'N', 'title' => ''], + 'GmtModifyTimestamp' => ['description' => 'The timestamp when the version was last modified.', 'type' => 'integer', 'format' => 'int64', 'example' => '16754300000', 'title' => ''], + 'IsForceNightUpgrade' => ['description' => 'Indicates whether forced nighttime upgrade is enabled.', 'type' => 'string', 'example' => 'N', 'title' => ''], + 'GmtCreate' => ['description' => 'The time when the version was created.', 'type' => 'string', 'example' => '2018-04-24 12:23:45', 'title' => ''], + 'IsForceUpgrade' => ['description' => 'Indicates whether forced upgrade is enabled.', 'type' => 'string', 'example' => 'N', 'title' => ''], + 'Id' => ['description' => 'The version ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '12004', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'TotalCount' => ['description' => 'The total number of entries that match the query conditions. You can use this value to calculate the total number of pages.', 'type' => 'integer', 'format' => 'int32', 'example' => '1000', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"629586FE-CB2E-4742-995E-121F952CEB72\\"\\n}","errorExample":"{\\n \\"RequestId\\": \\"6F25F67C-F411-499F-BCE2-67CA563CB064\\",\\n \\"HostId\\": \\"iovcc.cn-shanghai.aliyuncs.com\\",\\n \\"Code\\": \\"InvalidTenant\\",\\n \\"Message\\": \\"User is not a valid tenant\\"\\n}"},{"type":"xml","example":"<CreateShadowSchemaResponse>\\r\\n<RequestId>6F25F67C-F411-499F-BCE2-67CA563CB064</RequestId>\\r\\n</CreateShadowSchemaResponse>","errorExample":""}]', - 'title' => 'CreateShadowSchema', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6F25F67C-F411-499F-BCE2-67CA563CB064\\",\\n \\"OsVersionList\\": {\\n \\"Items\\": [\\n {\\n \\"Status\\": \\"PUBLISHED\\",\\n \\"GmtCreateTimestamp\\": 16754300000,\\n \\"DeviceModelId\\": \\"123\\",\\n \\"GmtModify\\": \\"2018-04-24 12:23:45\\",\\n \\"IsMilestone\\": \\"Y\\",\\n \\"Remark\\": \\"测试\\",\\n \\"SystemVersion\\": \\"2.0.1-R-20180506.0824\\",\\n \\"StatusName\\": \\"已发布\\",\\n \\"IsForceReboot\\": \\"N\\",\\n \\"DeviceModelName\\": \\"DM1\\",\\n \\"IsSilentUpgrade\\": \\"N\\",\\n \\"GmtModifyTimestamp\\": 16754300000,\\n \\"IsForceNightUpgrade\\": \\"N\\",\\n \\"GmtCreate\\": \\"2018-04-24 12:23:45\\",\\n \\"IsForceUpgrade\\": \\"N\\",\\n \\"Id\\": 12004\\n }\\n ],\\n \\"TotalCount\\": 1000\\n }\\n}","type":"json"}]', + 'title' => 'Query OS versions by page', + 'summary' => 'Queries a paginated list of OS versions by calling FindOsVersions.', + 'description' => '> This operation supports multiple query conditions, such as device model and OS version number.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'DeleteShadowSchema' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [ + ['createdAt' => '2024-06-18T02:20:30.000Z', 'description' => 'Error codes changed'], + ], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'iovcc:FindOsVersions', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'FindPrepublishPassedDevices' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', - 'systemTags' => [ - 'operationType' => 'delete', - ], + 'operationType' => 'read', + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'Id', + 'name' => 'PrepublishId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '12', - ], + 'schema' => ['description' => 'The pre-release ID.', 'type' => 'string', 'required' => true, 'example' => '1', 'title' => ''], ], [ 'name' => 'ProjectId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'PIC3UA0V', - ], + 'schema' => ['description' => 'The ID of the project.', 'type' => 'string', 'required' => true, 'example' => 'P0VFCREU', 'title' => ''], + ], + [ + 'name' => 'PageIndex', + 'in' => 'query', + 'schema' => ['description' => 'The start index of the current page.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => 'The page size.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '20', 'title' => ''], + ], + [ + 'name' => 'DeviceId', + 'in' => 'query', + 'schema' => ['description' => 'The cloud device ID.', 'type' => 'string', 'required' => false, 'example' => 'b8fe2e24ff2b48e0a3aa4e49809fc1b3', 'title' => ''], ], ], 'responses' => [ @@ -9376,99 +6634,86 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '6F25F67C-F411-499F-BCE2-67CA563CB064', + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '6F25F67C-F411-499F-BCE2-67CA563CB064', 'title' => ''], + 'DeviceList' => [ + 'description' => 'The queried device information.', + 'type' => 'object', + 'properties' => [ + 'Items' => [ + 'description' => 'The device list.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'GmtCreateTimestamp' => ['description' => 'The query timestamp.', 'type' => 'integer', 'format' => 'int64', 'example' => '124643600000', 'title' => ''], + 'DeviceId' => ['description' => 'The cloud device ID.', 'type' => 'string', 'example' => 'b8fe2e24ff2b48e0a3aa4e49809fc1b3', 'title' => ''], + 'GmtCreate' => ['description' => 'The query time.', 'type' => 'string', 'example' => '2018-01-01 00:00:00', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'TotalCount' => ['description' => 'The total number of records that match the conditions.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"6F25F67C-F411-499F-BCE2-67CA563CB064\\"\\n}","errorExample":"{\\n \\"RequestId\\": \\"6F25F67C-F411-499F-BCE2-67CA563CB064\\",\\n \\"HostId\\": \\"iovcc.cn-shanghai.aliyuncs.com\\",\\n \\"Code\\": \\"InvalidTenant\\",\\n \\"Message\\": \\"User is not a valid tenant\\"\\n}"},{"type":"xml","example":"<DeleteShadowSchemaResponse>\\r\\n<RequestId>6F25F67C-F411-499F-BCE2-67CA563CB064</RequestId>\\r\\n</DeleteShadowSchemaResponse>","errorExample":""}]', - 'title' => 'DeleteShadowSchema', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6F25F67C-F411-499F-BCE2-67CA563CB064\\",\\n \\"DeviceList\\": {\\n \\"Items\\": [\\n {\\n \\"GmtCreateTimestamp\\": 124643600000,\\n \\"DeviceId\\": \\"b8fe2e24ff2b48e0a3aa4e49809fc1b3\\",\\n \\"GmtCreate\\": \\"2018-01-01 00:00:00\\"\\n }\\n ],\\n \\"TotalCount\\": 2\\n }\\n}","type":"json"}]', + 'title' => 'Query cloud device ID list', + 'summary' => 'Performs a paged query for the list of cloud device IDs of queried devices under a specified pre-release.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'UpdateShadowSchema' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [ + ['createdAt' => '2024-06-18T02:20:29.000Z', 'description' => 'Error codes changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'iovcc:FindPrepublishPassedDevices', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + ], + 'FindPrepublishesByParentId' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', - 'systemTags' => [ - 'operationType' => 'update', - ], + 'operationType' => 'read', + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'DeviceModelId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '120', - ], - ], - [ - 'name' => 'AuthType', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '1', - ], - ], - [ - 'name' => 'Namespace', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'b09e93ce436aaf0dcfc2fb2004c1fde8', - ], - ], - [ 'name' => 'ProjectId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'PIC3UA0V', - ], - ], - [ - 'name' => 'Schema', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '', - ], + 'schema' => ['description' => 'The ID of the project.', 'type' => 'string', 'required' => true, 'example' => 'P0VFCREU', 'title' => ''], ], [ - 'name' => 'Id', + 'name' => 'ParentId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '12', - ], + 'schema' => ['description' => 'The ID of the parent pre-release.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1', 'title' => ''], ], ], 'responses' => [ @@ -9476,48 +6721,106 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '629586FE-CB2E-4742-995E-121F952CEB72', + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '6F25F67C-F411-499F-BCE2-67CA563CB064', 'title' => ''], + 'PrepublishList' => [ + 'description' => 'The list of pre-release query results.', + 'type' => 'object', + 'properties' => [ + 'Items' => [ + 'description' => 'The list of returned records.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'GmtCreateTimestamp' => ['description' => 'The creation timestamp.', 'type' => 'integer', 'format' => 'int64', 'example' => '165465000000', 'title' => ''], + 'DeviceModelId' => ['description' => 'The device model ID.', 'type' => 'string', 'example' => '12', 'title' => ''], + 'GmtModify' => ['description' => 'The modification time.', 'type' => 'string', 'example' => '2018-01-01 00:01:00', 'title' => ''], + 'IsActive' => ['description' => 'Indicates whether the pre-release is active.', 'type' => 'string', 'example' => 'Y', 'title' => ''], + 'VersionId' => ['description' => 'The version ID.', 'type' => 'string', 'example' => '1', 'title' => ''], + 'BarrierCount' => ['description' => 'The number of devices allowed for the pre-release.', 'type' => 'string', 'example' => '1000', 'title' => ''], + 'IsTotalPrepublish' => ['description' => 'Indicates whether the pre-release is a total pre-release.', 'type' => 'string', 'example' => 'N', 'title' => ''], + 'GmtModifyTimestamp' => ['description' => 'The update timestamp.', 'type' => 'integer', 'format' => 'int64', 'example' => '165465000000', 'title' => ''], + 'ParentId' => ['description' => 'The ID of the parent pre-release. A value of 0 indicates that the pre-release is a parent pre-release.', 'type' => 'string', 'example' => '1', 'title' => ''], + 'GmtCreate' => ['description' => 'The creation time.', 'type' => 'string', 'example' => '2018-01-01 00:00:00', 'title' => ''], + 'Name' => ['description' => 'The name of the pre-release.', 'type' => 'string', 'example' => '第一次预发布', 'title' => ''], + 'Id' => ['description' => 'ID', 'type' => 'integer', 'format' => 'int64', 'example' => '2', 'title' => ''], + 'VersionType' => ['description' => 'The version type. Valid values:'."\n" + .'- FOTA: system version.'."\n" + .'- APP: application version.', 'type' => 'string', 'example' => 'FOTA', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'TotalCount' => ['description' => 'The total number of records that match the conditions.', 'type' => 'integer', 'format' => 'int32', 'example' => '30', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"629586FE-CB2E-4742-995E-121F952CEB72\\"\\n}","errorExample":"{\\n \\"RequestId\\": \\"6F25F67C-F411-499F-BCE2-67CA563CB064\\",\\n \\"HostId\\": \\"iovcc.cn-shanghai.aliyuncs.com\\",\\n \\"Code\\": \\"InvalidTenant\\",\\n \\"Message\\": \\"User is not a valid tenant\\"\\n}"},{"type":"xml","example":"<UpdateShadowSchemaResponse>\\r\\n<RequestId>6F25F67C-F411-499F-BCE2-67CA563CB064</RequestId>\\r\\n</UpdateShadowSchemaResponse>","errorExample":""}]', - 'title' => 'UpdateShadowSchema', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6F25F67C-F411-499F-BCE2-67CA563CB064\\",\\n \\"PrepublishList\\": {\\n \\"Items\\": [\\n {\\n \\"GmtCreateTimestamp\\": 165465000000,\\n \\"DeviceModelId\\": \\"12\\",\\n \\"GmtModify\\": \\"2018-01-01 00:01:00\\",\\n \\"IsActive\\": \\"Y\\",\\n \\"VersionId\\": \\"1\\",\\n \\"BarrierCount\\": \\"1000\\",\\n \\"IsTotalPrepublish\\": \\"N\\",\\n \\"GmtModifyTimestamp\\": 165465000000,\\n \\"ParentId\\": \\"1\\",\\n \\"GmtCreate\\": \\"2018-01-01 00:00:00\\",\\n \\"Name\\": \\"第一次预发布\\",\\n \\"Id\\": 2,\\n \\"VersionType\\": \\"FOTA\\"\\n }\\n ],\\n \\"TotalCount\\": 30\\n }\\n}","type":"json"}]', + 'title' => 'Query child pre-releases under a parent pre-release', + 'summary' => 'Queries the child pre-releases under a parent pre-release by calling FindPrepublishesByParentId.', + 'description' => 'Applicable to pre-releases of application versions. Each pre-release that is created is a parent pre-release, and a child pre-release is created for each compatible device model.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'ListShadowSchemaDeviceModels' => [ - 'methods' => [ - 'get', + 'changeSet' => [ + ['createdAt' => '2024-06-18T02:20:29.000Z', 'description' => 'Error codes changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'iovcc:FindPrepublishesByParentId', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + ], + 'FindPrepublishesByVersionId' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'ProjectId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'PIC3UA0V', - ], + 'schema' => ['description' => 'The ID of the project.', 'type' => 'string', 'required' => true, 'example' => 'P0VFCREU', 'title' => ''], + ], + [ + 'name' => 'VersionId', + 'in' => 'query', + 'schema' => ['description' => 'The version ID.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'VersionType', + 'in' => 'query', + 'schema' => ['description' => 'The version type. Valid values:'."\n" + .'- FOTA: system version.'."\n" + .'- APP: application version.', 'type' => 'string', 'required' => true, 'example' => 'FOTA', 'title' => ''], ], ], 'responses' => [ @@ -9525,164 +6828,119 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'ModelList' => [ - 'description' => '', + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '6F25F67C-F411-499F-BCE2-67CA563CB064', 'title' => ''], + 'PrepublishList' => [ + 'description' => 'The list of pre-release query results.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'DeviceModelId' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '208', - ], - 'HardwareType' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'sn', - ], - 'DeviceType' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'car_auto', - ], - 'CanCreateDeviceId' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'ProjectId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'PIC3UA0V', - ], - 'OsPlatform' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'linux', - ], - 'DeviceModel' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'model_2nd', - ], - 'SecurityChip' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'Description' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'description', - ], - 'InitUsageTypeDesc' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'private', - ], - 'InitUsageType' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'DeviceBrand' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'brand_2nd', - ], + 'GmtCreateTimestamp' => ['description' => 'The creation timestamp.', 'type' => 'integer', 'format' => 'int64', 'example' => '1684530000000', 'title' => ''], + 'DeviceModelId' => ['description' => 'The device model ID.', 'type' => 'string', 'example' => '12', 'title' => ''], + 'GmtModify' => ['description' => 'The modification time.', 'type' => 'string', 'example' => '2018-01-01 00:01:00', 'title' => ''], + 'IsActive' => ['description' => 'Indicates whether the pre-release is active.', 'type' => 'string', 'example' => 'Y', 'title' => ''], + 'VersionId' => ['description' => 'The version ID.', 'type' => 'string', 'example' => '1', 'title' => ''], + 'BarrierCount' => ['description' => 'The number of devices allowed for the pre-release.', 'type' => 'string', 'example' => '1000', 'title' => ''], + 'DeviceModelName' => ['description' => 'The device model name.', 'type' => 'string', 'example' => 'DM1', 'title' => ''], + 'IsTotalPrepublish' => ['description' => 'Indicates whether this is a total pre-release.', 'type' => 'string', 'example' => 'N', 'title' => ''], + 'GmtModifyTimestamp' => ['description' => 'The modification timestamp.', 'type' => 'integer', 'format' => 'int64', 'example' => '1684530000000', 'title' => ''], + 'ParentId' => ['description' => 'The parent pre-release ID. A value of 0 indicates that this pre-release is a parent pre-release.', 'type' => 'string', 'example' => '0', 'title' => ''], + 'GmtCreate' => ['description' => 'The creation time.', 'type' => 'string', 'example' => '2018-01-01 00:00:00', 'title' => ''], + 'Name' => ['description' => 'The pre-release name.', 'type' => 'string', 'example' => '第一次预发布', 'title' => ''], + 'Id' => ['description' => 'ID', 'type' => 'string', 'example' => '1', 'title' => ''], + 'VersionType' => ['description' => 'The version type. Valid values:'."\n" + .'- FOTA: system version.'."\n" + .'- APP: application version.', 'type' => 'string', 'example' => 'FOTA', 'title' => ''], + 'PassedCount' => ['description' => 'The number of devices that have been queried.', 'type' => 'string', 'example' => '0', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '4F501674-4FE3-47F9-ADAD-A1875A325798', + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"4F501674-4FE3-47F9-ADAD-A1875A325798\\",\\n \\"ModelList\\": [\\n {\\n \\"DeviceModelId\\": 208,\\n \\"HardwareType\\": \\"sn\\",\\n \\"DeviceType\\": \\"car_auto\\",\\n \\"CanCreateDeviceId\\": 1,\\n \\"ProjectId\\": \\"PIC3UA0V\\",\\n \\"OsPlatform\\": \\"linux\\",\\n \\"DeviceModel\\": \\"model_2nd\\",\\n \\"SecurityChip\\": 0,\\n \\"Description\\": \\"description\\",\\n \\"InitUsageTypeDesc\\": \\"private\\",\\n \\"InitUsageType\\": 1,\\n \\"DeviceBrand\\": \\"brand_2nd\\"\\n }\\n ]\\n}","errorExample":"{\\n \\"RequestId\\": \\"6F25F67C-F411-499F-BCE2-67CA563CB064\\",\\n \\"HostId\\": \\"iovcc.cn-shanghai.aliyuncs.com\\",\\n \\"Code\\": \\"InvalidTenant\\",\\n \\"Message\\": \\"User is not a valid tenant\\"\\n}"},{"type":"xml","example":"<ListShadowSchemaDeviceModelsResponse>\\r\\n\\t<ModelList>\\r\\n\\t\\t<DeviceModel>model_2nd</DeviceModel>\\r\\n\\t\\t<DeviceType>car_auto</DeviceType>\\r\\n\\t\\t<HardwareType>sn</HardwareType>\\r\\n\\t\\t<InitUsageType>0</InitUsageType>\\r\\n\\t\\t<DeviceBrand>brand_2nd</DeviceBrand>\\r\\n\\t\\t<ProjectId>PIC3UA0V</ProjectId>\\r\\n\\t\\t<DeviceModelId>208</DeviceModelId>\\r\\n\\t\\t<SecurityChip>0</SecurityChip>\\r\\n\\t\\t<InitUsageTypeDesc>private</InitUsageTypeDesc>\\r\\n\\t\\t<CanCreateDeviceId>1</CanCreateDeviceId>\\r\\n\\t</ModelList>\\r\\n\\t<RequestId>4F501674-4FE3-47F9-ADAD-A1875A325798</RequestId>\\r\\n</ListShadowSchemaDeviceModelsResponse>","errorExample":""}]', - 'title' => 'ListShadowSchemaDeviceModels', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6F25F67C-F411-499F-BCE2-67CA563CB064\\",\\n \\"PrepublishList\\": [\\n {\\n \\"GmtCreateTimestamp\\": 1684530000000,\\n \\"DeviceModelId\\": \\"12\\",\\n \\"GmtModify\\": \\"2018-01-01 00:01:00\\",\\n \\"IsActive\\": \\"Y\\",\\n \\"VersionId\\": \\"1\\",\\n \\"BarrierCount\\": \\"1000\\",\\n \\"DeviceModelName\\": \\"DM1\\",\\n \\"IsTotalPrepublish\\": \\"N\\",\\n \\"GmtModifyTimestamp\\": 1684530000000,\\n \\"ParentId\\": \\"0\\",\\n \\"GmtCreate\\": \\"2018-01-01 00:00:00\\",\\n \\"Name\\": \\"第一次预发布\\",\\n \\"Id\\": \\"1\\",\\n \\"VersionType\\": \\"FOTA\\",\\n \\"PassedCount\\": \\"0\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'Query pre-releases by version ID', + 'summary' => 'Queries the list of pre-releases under a specified version by calling FindPrepublishesByVersionId.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'ListShadowSchemas' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [ + ['createdAt' => '2024-06-18T02:20:29.000Z', 'description' => 'Error codes changed'], + ], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'iovcc:FindPrepublishesByVersionId', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'FindVersionBlackDevices' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'ProjectId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'PIC3UA0V', - ], + 'schema' => ['description' => 'The project ID.', 'type' => 'string', 'required' => true, 'example' => 'P0VFCREU', 'title' => ''], ], [ - 'name' => 'QueryType', + 'name' => 'VersionId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'deviceModelId', - ], + 'schema' => ['description' => 'The version ID.', 'type' => 'string', 'required' => true, 'example' => '12345', 'title' => ''], ], [ - 'name' => 'QueryValue', + 'name' => 'VersionType', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '120', - ], + 'schema' => ['description' => 'The version type. Valid values:'."\n" + ."\n" + .'- **FOTA**: system upgrade.'."\n" + .'- **APP**: application upgrade.', 'type' => 'string', 'required' => true, 'example' => 'FOTA', 'title' => ''], + ], + [ + 'name' => 'DeviceId', + 'in' => 'query', + 'schema' => ['description' => 'The device ID. Fuzzy match is supported.', 'type' => 'string', 'required' => false, 'example' => 'AS23DG23SA5D43GA34SD23GW456E', 'title' => ''], + ], + [ + 'name' => 'OriginalId', + 'in' => 'query', + 'schema' => ['description' => 'The original device ID. Fuzzy match is supported.', 'type' => 'string', 'required' => false, 'example' => '23452345234523452', 'title' => ''], ], [ 'name' => 'PageIndex', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'The page number, starting from 1.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], + 'schema' => ['description' => 'The number of entries per page. Valid values: 10, 20, and 50.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '20', 'title' => ''], ], ], 'responses' => [ @@ -9690,243 +6948,114 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '629586FE-CB2E-4742-995E-121F952CEB72', - ], - 'PageList' => [ - 'description' => '', + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '6F25F67C-F411-499F-BCE2-67CA563CB064', 'title' => ''], + 'DeviceList' => [ + 'description' => 'The device list information.', 'type' => 'object', 'properties' => [ - 'Pagination' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'PageIndex' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'TotalPageCount' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'TotalCount' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'SimpleSign' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'false', - ], - 'HasNextPage' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'false', - ], - ], - ], - 'List' => [ - 'description' => '', + 'Items' => [ + 'description' => 'The devices on the current page.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'AuthTypeDesc' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'DeviceModelId' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '120', - ], - 'AuthType' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'ProjectId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'PIC3UA0V', - ], - 'GmtCreate' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1537255499517', - ], - 'Namespace' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'b09e93ce436aaf0dcfc2fb2004c1fde8', - ], - 'DeviceModel' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'model_2nd', - ], - 'GmtModified' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1537255499517', - ], - 'ModuleSchema' => [ - 'description' => '', - 'type' => 'string', - 'example' => '{"a":"b"}', - ], - 'Id' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '12', - ], + 'GmtCreateTimestamp' => ['description' => 'The creation timestamp.', 'type' => 'integer', 'format' => 'int64', 'example' => '168566700000', 'title' => ''], + 'OriginalId' => ['description' => 'The original device ID.', 'type' => 'string', 'example' => '23452345234523452', 'title' => ''], + 'DeviceId' => ['description' => 'The device ID.', 'type' => 'string', 'example' => 'AS23DG23SA5D43GA34SD23GW456E', 'title' => ''], + 'IdType' => ['description' => 'The device ID type. Valid values:'."\n" + ."\n" + .'- **device_id**: hardware ID.'."\n" + .'- **sn**: serial number.'."\n" + .'- **vin**: vehicle identification number.'."\n" + .'- **hardware_id**: hardware ID.', 'type' => 'string', 'example' => 'hardware_id', 'title' => ''], + 'GmtCreate' => ['description' => 'The time when the device was added.', 'type' => 'string', 'example' => '2018-02-14 14:20:18', 'title' => ''], + 'Id' => ['description' => 'The ID. This is the primary key.', 'type' => 'integer', 'format' => 'int64', 'example' => '123', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], + 'TotalCount' => ['description' => 'The total number of devices that match the specified conditions.', 'type' => 'integer', 'format' => 'int32', 'example' => '25', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"629586FE-CB2E-4742-995E-121F952CEB72\\",\\n \\"PageList\\": {\\n \\"List\\": [\\n {\\n \\"AuthTypeDesc\\": \\"基于账号\\",\\n \\"DeviceModelId\\": 120,\\n \\"AuthType\\": 0,\\n \\"ProjectId\\": \\"PIC3UA0V\\",\\n \\"GmtCreate\\": 1537255499517,\\n \\"Namespace\\": \\"b09e93ce436aaf0dcfc2fb2004c1fde8\\",\\n \\"DeviceModel\\": \\"model_2nd\\",\\n \\"GmtModified\\": 1537255499517,\\n \\"ModuleSchema\\": \\"{\\\\\\"a\\\\\\":\\\\\\"b\\\\\\"}\\",\\n \\"Id\\": 12\\n }\\n ],\\n \\"Pagination\\": {\\n \\"PageIndex\\": 1,\\n \\"TotalPageCount\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 10,\\n \\"SimpleSign\\": false,\\n \\"HasNextPage\\": false\\n }\\n }\\n}","errorExample":"{\\n \\"RequestId\\": \\"6F25F67C-F411-499F-BCE2-67CA563CB064\\",\\n \\"HostId\\": \\"iovcc.cn-shanghai.aliyuncs.com\\",\\n \\"Code\\": \\"InvalidTenant\\",\\n \\"Message\\": \\"User is not a valid tenant\\"\\n}"},{"type":"xml","example":"<ListShadowSchemasResponse>\\r\\n\\t<RequestId>973C5884-2CB8-40B4-9D9F-F92BA38BD85F</RequestId>\\r\\n\\t<PageList>\\r\\n\\t\\t<Pagination>\\r\\n\\t\\t\\t<TotalPageCount>1</TotalPageCount>\\r\\n\\t\\t\\t<TotalCount>1</TotalCount>\\r\\n\\t\\t\\t<PageSize>10</PageSize>\\r\\n\\t\\t\\t<PageIndex>1</PageIndex>\\r\\n\\t\\t\\t<HasNextPage>true</HasNextPage>\\r\\n\\t\\t</Pagination>\\r\\n\\t\\t<List>\\r\\n\\t\\t\\t<DeviceModel>model_2nd</DeviceModel>\\r\\n\\t\\t\\t<GmtCreate>1537255499517</GmtCreate>\\r\\n\\t\\t\\t<ModuleSchema>{"ecu": {"node_desc": "动力系统", "brake_controll": {"handbrake": "手刹状态", "node_desc": "驻车制动", "brake_fluid": "制动液", "brake_lining": "制动衬片", "brake_status": "刹车状态", "brake_auxiliary": "辅助制动", "brake_emergency": "应急制动", "brake_pedal_strength": "刹车踏板强度"}}, "device_info": {"vin": "车架号", "uuid": "uuid", "brand": "设备品牌", "product": "对内型号", "version": "schema版本", "node_desc": "设备描述", "manufacture": "制造商", "device_model": "对外型号", "plugin_version": {"ra": "远程诊断", "control": "远程控制", "node_desc": "插件版本号", "yundevice": "yundevice版本号"}, "system_version": "系统版本号"}, "car_body_hvac": {"door": {"node_desc": "车门", "bonnet_ststus": "引擎盖状态", "vehicle_rl_door": {"node_desc": "后左侧门", "door_status": "开合状态"}, "vehicle_rr_door": {"node_desc": "后右侧门", "door_status": "开合状态"}, "vehicle_driver_door": {"node_desc": "驾驶员车门", "door_status": "开合状态"}, "vehicle_locked_status": "锁止状态", "vehicle_passenger_door": {"node_desc": "副驾驶车门", "door_status": "开合状态"}}, "hvac": {"ac": {"ac_type": "控温模式", "ac_switch": "AC开启", "node_desc": "空调系统", "ac_engine_status": "压缩机运转状态", "ac_setting_temperature": "空调设定温度"}, "node_desc": "通风与空气调节", "air_temperature": "车内温度", "ventilation_system": {"air_rate": "风速", "node_desc": "通风系统", "air_recirc": "空气循环方式", "air_direction": "风向"}}, "chair": {"node_desc": "座椅", "chair_memory": {"node_desc": "座椅记忆", "chair_driver_hight": "驾驶位座椅高度", "chair_driver_header": "驾驶位座椅头枕", "chair_driver_shifting": "驾驶位座椅位移", "chair_passenger_hight": "副驾驶位座椅高度", "chair_passenger_header": "副驾驶位座椅头枕", "chair_passenger_shifting": "副驾驶位座椅位移"}, "seat_heating": {"node_desc": "座椅加热", "seat_heating_driver_gear": "主驾驶座加热档位", "seat_heating_passenger_gear": "副驾驶座加热档位"}}, "light": {"fog_light": {"node_desc": "雾灯", "fog_fl_light": "前左雾灯", "fog_fr_light": "前右雾灯", "fog_rear_light": "后雾灯"}, "node_desc": "灯光", "foot_light": "脚灯", "read_light": {"node_desc": "阅读灯", "read_fl_light": "左前阅读灯", "read_fr_light": "右前阅读灯", "read_rl_light": "右前阅读灯", "read_rr_light": "右后阅读灯"}, "tail_light": {"node_desc": "尾灯", "tail_l_light": "左尾灯", "tail_r_light": "右尾灯"}, "turn_light": {"node_desc": "转向灯", "turn_l_light": "左侧转向灯", "turn_r_light": "左侧转向灯", "turn_fl_light": "左前转向灯", "turn_fr_light": "右前转向灯", "turn_rl_light": "左后转向灯", "turn_rr_light": "右后转向灯"}, "brake_light": {"node_desc": "刹车灯", "brake_h_light": "高位刹车灯", "brake_l_light": "左刹车灯", "brake_r_light": "右刹车灯"}, "trunk_light": "后备箱灯", "backup_light": "倒车灯", "hazard_light": "警示灯", "license_light": "牌照灯", "welcome_light": {"node_desc": "迎宾灯", "welcome_fl_light": "左前迎宾灯", "welcome_fr_light": "右前迎宾灯", "welcome_rl_light": "左后迎宾灯", "welcome_rr_light": "右后迎宾灯"}, "cosmetic_light": {"node_desc": "化妆灯", "cosmetic_fl_light": "左前化妆灯", "cosmetic_fr_light": "右后化妆灯", "cosmetic_rl_light": "左后化妆灯"}, "glovebox_light": "手套箱灯", "clearance_light": "示廓灯", "rear_view_ground": "后视镜照地灯", "head_light_status": "大灯照明模式"}, "radar": {"node_desc": "雷达", "raer_radar": {"node_desc": "后雷达", "rear_radar_status": "后雷达状态", "rear_radar_interval": "后方障碍物距离"}, "front_radar": {"node_desc": "前雷达", "front_radar_status": "前雷达状态", "front_radar_interval": "前方障碍物距离"}}, "cooling": {"coolant": "冷却液", "node_desc": "冷却系统", "water_pump": "水泵", "water_tank": "水箱", "cooling_fan": "风扇", "cooling_radiator": "散热器", "water_temperature": "水温"}, "steering": {"node_desc": "方向盘", "steering_wheel_angle": "打转角度"}, "node_desc": "车身与HVAC", "lubricating": {"oil_pump": "机油泵", "node_desc": "润滑系统", "oil_ducts": "油道", "oil_level": "机油油位", "oil_filter": "机油滤清器", "pressure_plug": "感压塞", "oil_gather_colander": "集滤器", "pressure_limiting_valve": "限压阀"}, "cigar_lighter": {"node_desc": "点烟器", "cigar_lighter_rear": "后点烟器", "cigar_lighter_temp": "点烟器温度", "cigar_lighter_driver": "前点烟器"}, "cleaning_fluid": "清洗液"}}</ModuleSchema>\\r\\n\\t\\t\\t<GmtModified>1537255499517</GmtModified>\\r\\n\\t\\t\\t<ProjectId>PIC3UA0V</ProjectId>\\r\\n\\t\\t\\t<AuthTypeDesc>用户模式</AuthTypeDesc>\\r\\n\\t\\t\\t<Id>53</Id>\\r\\n\\t\\t\\t<DeviceModelId>208</DeviceModelId>\\r\\n\\t\\t\\t<AuthType>101</AuthType>\\r\\n\\t\\t\\t<Namespace>b09e93ce436aaf0dcfc2fb2004c1fde8</Namespace>\\r\\n\\t\\t</List>\\r\\n\\t</PageList>\\r\\n</ListShadowSchemasResponse>","errorExample":""}]', - 'title' => 'ListShadowSchemas', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6F25F67C-F411-499F-BCE2-67CA563CB064\\",\\n \\"DeviceList\\": {\\n \\"Items\\": [\\n {\\n \\"GmtCreateTimestamp\\": 168566700000,\\n \\"OriginalId\\": \\"23452345234523452\\",\\n \\"DeviceId\\": \\"AS23DG23SA5D43GA34SD23GW456E\\",\\n \\"IdType\\": \\"hardware_id\\",\\n \\"GmtCreate\\": \\"2018-02-14 14:20:18\\",\\n \\"Id\\": 123\\n }\\n ],\\n \\"TotalCount\\": 25\\n }\\n}","type":"json"}]', + 'title' => 'Retrieve device blacklist for a system or application version', + 'summary' => 'Retrieves the device blacklist of a system version or application version with pagination.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'DescribeDefaultSchema' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [ + ['createdAt' => '2024-06-18T02:20:29.000Z', 'description' => 'Error codes changed'], + ], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'iovcc:FindVersionBlackDevices', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'FindVersionDeviceGroups' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'ProjectId', + 'name' => 'DeviceId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'PIC3UA0V', - ], + 'schema' => ['description' => 'The cloud device ID.', 'type' => 'string', 'required' => false, 'example' => 'b8fe2e24ff2b48e0a3aa4e49809fc1b3', 'title' => ''], ], [ - 'name' => 'DeviceModelId', + 'name' => 'OriginalId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '120', - ], + 'schema' => ['description' => 'The source device ID.', 'type' => 'string', 'required' => false, 'example' => '23452345234523452', 'title' => ''], ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '6F25F67C-F411-499F-BCE2-67CA563CB064', - ], - 'Schema' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - ], - ], - ], - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Schema\\": \\"{\\\\\\"ecu\\\\\\":{\\\\\\"node_desc\\\\\\":\\\\\\"动力系统\\\\\\",\\\\\\"brake_controll\\\\\\":{\\\\\\"handbrake\\\\\\":\\\\\\"手刹状态\\\\\\"}},\\\\\\"device_info\\\\\\":{\\\\\\"vin\\\\\\":\\\\\\"车架号\\\\\\",\\\\\\"uuid\\\\\\":\\\\\\"uuid\\\\\\",\\\\\\"brand\\\\\\":\\\\\\"设备品牌\\\\\\",\\\\\\"plugin_version\\\\\\":{\\\\\\"ra\\\\\\":\\\\\\"远程诊断\\\\\\",\\\\\\"control\\\\\\":\\\\\\"远程控制\\\\\\",\\\\\\"node_desc\\\\\\":\\\\\\"插件版本号\\\\\\",\\\\\\"yundevice\\\\\\":\\\\\\"yundevice版本号\\\\\\"},\\\\\\"system_version\\\\\\":\\\\\\"系统版本号\\\\\\"},\\\\\\"car_body_hvac\\\\\\":{\\\\\\"node_desc\\\\\\":\\\\\\"车身与HVAC\\\\\\",\\\\\\"cigar_lighter\\\\\\":{\\\\\\"node_desc\\\\\\":\\\\\\"点烟器\\\\\\"},\\\\\\"cleaning_fluid\\\\\\":\\\\\\"清洗液\\\\\\"}}\\",\\n \\"RequestId\\": \\"6F25F67C-F411-499F-BCE2-67CA563CB064\\"\\n}","errorExample":"{\\n \\"RequestId\\": \\"6F25F67C-F411-499F-BCE2-67CA563CB064\\",\\n \\"HostId\\": \\"iovcc.cn-shanghai.aliyuncs.com\\",\\n \\"Code\\": \\"InvalidTenant\\",\\n \\"Message\\": \\"User is not a valid tenant\\"\\n}"},{"type":"xml","example":"<DescribeDefaultSchemaResponse>\\r\\n\\t<RequestId>6F25F67C-F411-499F-BCE2-67CA563CB064</RequestId>\\r\\n\\t<Schema>{"ecu":{"node_desc":"动力系统","brake_controll":{"handbrake":"手刹状态"}},"device_info":{"vin":"车架号","uuid":"uuid","brand":"设备品牌","plugin_version":{"ra":"远程诊断","control":"远程控制","node_desc":"插件版本号","yundevice":"yundevice版本号"},"system_version":"系统版本号"},"car_body_hvac":{"node_desc":"车身与HVAC","cigar_lighter":{"node_desc":"点烟器"},"cleaning_fluid":"清洗液"}}</Schema>\\r\\n</DescribeDefaultSchemaResponse>","errorExample":""}]', - 'title' => 'DescribeDefaultSchema', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'DescribeDeviceValiditySchema' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ [ - 'AK' => [], + 'name' => 'PageIndex', + 'in' => 'query', + 'schema' => ['description' => 'The start index of the current page.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1', 'title' => ''], ], - ], - 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - ], - 'parameters' => [ [ - 'name' => 'DeviceModel', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'model_2nd', - ], + 'schema' => ['description' => 'The page size.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '20', 'title' => ''], ], [ - 'name' => 'SchemaVersion', + 'name' => 'Name', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '1.0', - ], + 'schema' => ['description' => 'The group name.', 'type' => 'string', 'required' => false, 'example' => '升级', 'title' => ''], ], [ 'name' => 'ProjectId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'PIC3UA0V', - ], + 'schema' => ['description' => 'The ID of the project to which the group belongs.', 'type' => 'string', 'required' => true, 'example' => 'P0VFCREU', 'title' => ''], ], ], 'responses' => [ @@ -9934,142 +7063,111 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '629586FE-CB2E-4742-995E-121F952CEB72', - ], - 'ItemList' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Minimum' => [ - 'description' => '', - 'type' => 'number', - 'format' => 'float', - 'example' => '5', - ], - 'Type' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'string', - ], - 'Maximum' => [ - 'description' => '', - 'type' => 'number', - 'format' => 'float', - 'example' => '10', - ], - 'ItemType' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'boolean', - ], - 'EnumListStr' => [ - 'description' => '', - 'type' => 'string', - 'example' => '[a,b]', - ], - 'ExclusiveMinimum' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'MaxLength' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'Required' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'true', - ], - 'Description' => [ + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '6F25F67C-F411-499F-BCE2-67CA563CB064', 'title' => ''], + 'DeviceGroupList' => [ + 'description' => 'The query result list.', + 'type' => 'object', + 'properties' => [ + 'Items' => [ + 'description' => 'The list of returned records.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'GmtModifyTimestamp' => ['description' => 'The modification UNIX timestamp.', 'type' => 'integer', 'format' => 'int64', 'example' => '16834654000000', 'title' => ''], + 'GmtCreateTimestamp' => ['description' => 'The creation UNIX timestamp.', 'type' => 'integer', 'format' => 'int64', 'example' => '16834654000000', 'title' => ''], + 'GmtModify' => ['description' => 'The modification time.', 'type' => 'string', 'example' => '2018-01-01 00:01:00', 'title' => ''], + 'Description' => ['description' => 'The group description.', 'type' => 'string', 'example' => '测试', 'title' => ''], + 'GmtCreate' => ['description' => 'The creation time.', 'type' => 'string', 'example' => '2018-01-01 00:00:00', 'title' => ''], + 'Name' => ['description' => 'The group name.', 'type' => 'string', 'example' => '升级分组', 'title' => ''], + 'Id' => ['description' => 'ID', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'MaxCount' => ['description' => 'The maximum number of devices.', 'type' => 'string', 'example' => '100', 'title' => ''], + ], 'description' => '', - 'type' => 'string', + 'title' => '', 'example' => '', ], - 'ExclusiveMaximum' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'false', - ], - 'Path' => [ - 'description' => '', - 'type' => 'string', - 'example' => '/havc/oil_level', - ], - 'MinLength' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '5', - ], + 'title' => '', + 'example' => '', ], + 'TotalCount' => ['description' => 'The total number of records that match the specified conditions.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"629586FE-CB2E-4742-995E-121F952CEB72\\",\\n \\"ItemList\\": [\\n {\\n \\"Type\\": \\"string\\",\\n \\"Minimum\\": 5,\\n \\"Maximum\\": 10,\\n \\"ItemType\\": \\"boolean\\",\\n \\"ExclusiveMinimum\\": true,\\n \\"EnumListStr\\": \\"[a,b]\\",\\n \\"MaxLength\\": 10,\\n \\"Required\\": \\"true\\",\\n \\"Description\\": \\"机型验证信息\\",\\n \\"ExclusiveMaximum\\": false,\\n \\"Path\\": \\"/havc/oil_level\\",\\n \\"MinLength\\": 5\\n }\\n ]\\n}","errorExample":"{\\n \\"RequestId\\": \\"6F25F67C-F411-499F-BCE2-67CA563CB064\\",\\n \\"HostId\\": \\"iovcc.cn-shanghai.aliyuncs.com\\",\\n \\"Code\\": \\"InvalidTenant\\",\\n \\"Message\\": \\"User is not a valid tenant\\"\\n}"},{"type":"xml","example":"<DescribeDeviceValiditySchemaResponse>\\r\\n\\t<RequestId>E94C9864-56FB-44AD-AC0C-A1CEFB332254</RequestId>\\r\\n\\t<ItemList>\\r\\n\\t\\t<description>开机时长</description>\\r\\n\\t\\t<enumListStr />\\r\\n\\t\\t<exclusiveMaximum />\\r\\n\\t\\t<exclusiveMinimum />\\r\\n\\t\\t<itemType />\\r\\n\\t\\t<maxLength />\\r\\n\\t\\t<maximum />\\r\\n\\t\\t<minLength />\\r\\n\\t\\t<minimum />\\r\\n\\t\\t<path>/system/environment_variables/system_runtime</path>\\r\\n\\t\\t<required>false</required>\\r\\n\\t\\t<type>string</type>\\r\\n\\t</ItemList>\\r\\n\\t<ItemList>\\r\\n\\t\\t<description>客户端Ip</description>\\r\\n\\t\\t<enumListStr />\\r\\n\\t\\t<exclusiveMaximum />\\r\\n\\t\\t<exclusiveMinimum />\\r\\n\\t\\t<itemType />\\r\\n\\t\\t<maxLength />\\r\\n\\t\\t<maximum />\\r\\n\\t\\t<minLength />\\r\\n\\t\\t<minimum />\\r\\n\\t\\t<path>/system/environment_variables/ip</path>\\r\\n\\t\\t<required>false</required>\\r\\n\\t\\t<type>string</type>\\r\\n\\t</ItemList>\\r\\n</DescribeDeviceValiditySchemaResponse>","errorExample":""}]', - 'title' => 'DescribeDeviceValiditySchema', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6F25F67C-F411-499F-BCE2-67CA563CB064\\",\\n \\"DeviceGroupList\\": {\\n \\"Items\\": [\\n {\\n \\"GmtModifyTimestamp\\": 16834654000000,\\n \\"GmtCreateTimestamp\\": 16834654000000,\\n \\"GmtModify\\": \\"2018-01-01 00:01:00\\",\\n \\"Description\\": \\"测试\\",\\n \\"GmtCreate\\": \\"2018-01-01 00:00:00\\",\\n \\"Name\\": \\"升级分组\\",\\n \\"Id\\": 1,\\n \\"MaxCount\\": \\"100\\"\\n }\\n ],\\n \\"TotalCount\\": 10\\n }\\n}","type":"json"}]', + 'title' => 'Query test device groups', + 'summary' => 'Queries test device groups by using paging. You can filter by group name or cloud device ID contained in the group.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'DescribeShadowSchema' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [ + ['createdAt' => '2024-06-18T02:20:29.000Z', 'description' => 'Error codes changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'iovcc:FindVersionDeviceGroups', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + ], + 'FindVersionGroupDevices' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'DeviceModel', + 'name' => 'ProjectId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'model_2nd', - ], + 'schema' => ['description' => 'The ID of the project.', 'type' => 'string', 'required' => true, 'example' => 'P0VFCREU', 'title' => ''], ], [ - 'name' => 'IsSimple', + 'name' => 'OriginalId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], + 'schema' => ['description' => 'The source device ID.', 'type' => 'string', 'required' => false, 'example' => '23452345234523452', 'title' => ''], ], [ - 'name' => 'ProjectId', + 'name' => 'PageIndex', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'PIC3UA0V', - ], + 'schema' => ['description' => 'The start index of the current page.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '20', 'title' => ''], + ], + [ + 'name' => 'DeviceGroupId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the test device group.', 'type' => 'string', 'required' => true, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'DeviceId', + 'in' => 'query', + 'schema' => ['description' => 'The cloud device ID.', 'type' => 'string', 'required' => false, 'example' => 'b8fe2e24ff2b48e0a3aa4e49809fc1b3', 'title' => ''], ], ], 'responses' => [ @@ -10077,74 +7175,120 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '629586FE-CB2E-4742-995E-121F952CEB72', - ], - 'Schema' => [ - 'description' => '', - 'type' => 'string', + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '6F25F67C-F411-499F-BCE2-67CA563CB064', 'title' => ''], + 'GroupDeviceList' => [ + 'description' => 'The device list.', + 'type' => 'object', + 'properties' => [ + 'Items' => [ + 'description' => 'The device data on the current page.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'GmtCreateTimestamp' => ['description' => 'The creation timestamp.', 'type' => 'integer', 'format' => 'int64', 'example' => '18635800000', 'title' => ''], + 'OriginalId' => ['description' => 'The source device ID.', 'type' => 'string', 'example' => '23452345234523452', 'title' => ''], + 'DeviceId' => ['description' => 'The device ID.', 'type' => 'string', 'example' => 'AS23DG23SA5D43GA34SD23GW456E', 'title' => ''], + 'IdType' => ['description' => 'The device ID type. Valid values:'."\n" + ."\n" + .'- **device_id**: hardware ID.'."\n" + .'- **sn**: serial number.'."\n" + .'- **vin**: vehicle identification number.'."\n" + .'- **hardware_id**: hardware ID.', 'type' => 'string', 'example' => 'device_id', 'title' => ''], + 'GmtCreate' => ['description' => 'The time when the device was added.', 'type' => 'string', 'example' => '2018-02-14 14:20:18', 'title' => ''], + 'Id' => ['description' => 'ID', 'type' => 'string', 'example' => '123', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'TotalCount' => ['description' => 'The total number of device records.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''], + ], + 'title' => '', 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Schema\\": \\"[ { \\\\\\\\\\\\\\"id\\\\\\\\\\\\\\": 102, \\\\\\\\\\\\\\"name\\\\\\\\\\\\\\": \\\\\\\\\\\\\\"product:对内型号\\\\\\\\\\\\\\", \\\\\\\\\\\\\\"open\\\\\\\\\\\\\\": false, \\\\\\\\\\\\\\"pId\\\\\\\\\\\\\\": 1, \\\\\\\\\\\\\\"path\\\\\\\\\\\\\\": \\\\\\\\\\\\\\"/device_info/product\\\\\\\\\\\\\\" }, { \\\\\\\\\\\\\\"id\\\\\\\\\\\\\\": 101, \\\\\\\\\\\\\\"name\\\\\\\\\\\\\\": \\\\\\\\\\\\\\"manufacture:制造商\\\\\\\\\\\\\\", \\\\\\\\\\\\\\"open\\\\\\\\\\\\\\": false, \\\\\\\\\\\\\\"pId\\\\\\\\\\\\\\": 1, \\\\\\\\\\\\\\"path\\\\\\\\\\\\\\": \\\\\\\\\\\\\\"/device_info/manufacture\\\\\\\\\\\\\\" } ]\\",\\n \\"RequestId\\": \\"629586FE-CB2E-4742-995E-121F952CEB72\\"\\n}","errorExample":"{\\n \\"RequestId\\": \\"6F25F67C-F411-499F-BCE2-67CA563CB064\\",\\n \\"HostId\\": \\"iovcc.cn-shanghai.aliyuncs.com\\",\\n \\"Code\\": \\"InvalidTenant\\",\\n \\"Message\\": \\"User is not a valid tenant\\"\\n}"},{"type":"xml","example":"<DescribeShadowSchemaResponse>\\r\\n <RequestId>195D7F63-0904-49ED-854B-13C7BB37F764</RequestId>\\r\\n\\t<Schema>[{"path":"/device_info/product","name":"product:对内型号","pId":1,"id":102,"open":false},{"path":"/device_info/manufacture","name":"manufacture:制造商","pId":1,"id":101,"open":false}]</Schema>\\r\\n</DescribeShadowSchemaResponse>","errorExample":""}]', - 'title' => 'DescribeShadowSchema', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6F25F67C-F411-499F-BCE2-67CA563CB064\\",\\n \\"GroupDeviceList\\": {\\n \\"Items\\": [\\n {\\n \\"GmtCreateTimestamp\\": 18635800000,\\n \\"OriginalId\\": \\"23452345234523452\\",\\n \\"DeviceId\\": \\"AS23DG23SA5D43GA34SD23GW456E\\",\\n \\"IdType\\": \\"device_id\\",\\n \\"GmtCreate\\": \\"2018-02-14 14:20:18\\",\\n \\"Id\\": \\"123\\"\\n }\\n ],\\n \\"TotalCount\\": 2\\n }\\n}","type":"json"}]', + 'title' => 'Query device list in a specified group', + 'summary' => 'Queries the list of devices in a specified group by cloud device ID with paging.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'AddUploadedFunctionFileInfo' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [ + ['createdAt' => '2024-06-18T02:20:29.000Z', 'description' => 'Error codes changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'iovcc:FindVersionGroupDevices', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + ], + 'FindVersionMessageSendRecords' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', - 'systemTags' => [ - 'operationType' => 'create', - ], + 'operationType' => 'read', + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ + 'name' => 'VersionType', + 'in' => 'query', + 'schema' => ['description' => 'The version type. Valid values:'."\n" + ."\n" + .'- FOTA: system version.'."\n" + .'- APP: application version.', 'type' => 'string', 'required' => false, 'example' => 'FOTA', 'title' => ''], + ], + [ 'name' => 'ProjectId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'PE9FQC48', - ], + 'schema' => ['description' => 'The ID of the project.', 'type' => 'string', 'required' => true, 'example' => 'P0VFCREU', 'title' => ''], ], [ - 'name' => 'ObjectKey', + 'name' => 'PageIndex', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'function/file/1288127240930711/PE9FQC48/B1226EA3-2518-4164-8D2D-82B91A077020/hello.zip', - ], + 'schema' => ['description' => 'The start index of the current page.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1', 'title' => ''], ], [ - 'name' => 'FileName', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'hello.zip', - ], + 'schema' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '20', 'title' => ''], + ], + [ + 'name' => 'MessageType', + 'in' => 'query', + 'schema' => ['description' => 'The message type. Valid values:'."\n" + ."\n" + .'- **SYSTEM_UPDATE**: push notification for a system version release.'."\n" + .'- **APP_VERSION_UPDATE**: push notification for an application self-upgrade release.', 'type' => 'string', 'required' => false, 'example' => 'SYSTEM_UPDATE', 'title' => ''], + ], + [ + 'name' => 'VersionId', + 'in' => 'query', + 'schema' => ['description' => 'The version ID.', 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''], ], ], 'responses' => [ @@ -10152,131 +7296,137 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '629586FE-CB2E-4742-995E-121F952CEB72', + 'MessageSendRecordList' => [ + 'description' => 'The queried message sending records.', + 'type' => 'object', + 'properties' => [ + 'Items' => [ + 'description' => 'The details of the sending records.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'GmtCreateTimestamp' => ['description' => 'The creation timestamp.', 'type' => 'integer', 'format' => 'int64', 'example' => '1645460000', 'title' => ''], + 'MessageType' => ['description' => 'The message type. Valid values:'."\n" + .' '."\n" + .'- **SYSTEM_UPDATE**: push notification for a system version release.'."\n" + .'- **APP_VERSION_UPDATE**: push notification for an application self-upgrade release.', 'type' => 'string', 'example' => 'SYSTEM_UPDATE', 'title' => ''], + 'FailedCount' => ['description' => 'The number of failed messages.', 'type' => 'string', 'example' => '0', 'title' => ''], + 'SkippedCount' => ['description' => 'The number of skipped messages.', 'type' => 'string', 'example' => '0', 'title' => ''], + 'Result' => ['description' => 'The message sending result.', 'type' => 'string', 'example' => 'SUCCESS', 'title' => ''], + 'SucceededCount' => ['description' => 'The number of succeeded messages.', 'type' => 'string', 'example' => '100', 'title' => ''], + 'GmtCreate' => ['description' => 'The creation time.', 'type' => 'string', 'example' => '2018-01-01 00:00:00', 'title' => ''], + 'VersionId' => ['description' => 'The version ID.', 'type' => 'string', 'example' => '1', 'title' => ''], + 'ResultDesc' => ['description' => 'The description of the message sending result.', 'type' => 'string', 'example' => '发送成功', 'title' => ''], + 'TargetId' => ['description' => 'The target ID.', 'type' => 'string', 'example' => '1', 'title' => ''], + 'Id' => ['description' => 'ID', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'TotalCount' => ['description' => 'The total number of records that match the query conditions.', 'type' => 'integer', 'format' => 'int32', 'example' => '30', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '6F25F67C-F411-499F-BCE2-67CA563CB064', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"629586FE-CB2E-4742-995E-121F952CEB72\\"\\n}","errorExample":"{\\n \\"RequestId\\": \\"6F25F67C-F411-499F-BCE2-67CA563CB064\\",\\n \\"HostId\\": \\"iovcc.cn-shanghai.aliyuncs.com\\",\\n \\"Code\\": \\"InvalidTenant\\",\\n \\"Message\\": \\"User is not a valid tenant\\"\\n}"},{"type":"xml","example":"<AddUploadedFunctionFileInfoResponse>\\r\\n<RequestId>6F25F67C-F411-499F-BCE2-67CA563CB064</RequestId>\\r\\n</AddUploadedFunctionFileInfoResponse>","errorExample":""}]', - 'title' => 'AddUploadedFunctionFileInfo', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"MessageSendRecordList\\": {\\n \\"Items\\": [\\n {\\n \\"GmtCreateTimestamp\\": 1645460000,\\n \\"MessageType\\": \\"SYSTEM_UPDATE\\",\\n \\"FailedCount\\": \\"0\\",\\n \\"SkippedCount\\": \\"0\\",\\n \\"Result\\": \\"SUCCESS\\",\\n \\"SucceededCount\\": \\"100\\",\\n \\"GmtCreate\\": \\"2018-01-01 00:00:00\\",\\n \\"VersionId\\": \\"1\\",\\n \\"ResultDesc\\": \\"发送成功\\",\\n \\"TargetId\\": \\"1\\",\\n \\"Id\\": 1\\n }\\n ],\\n \\"TotalCount\\": 30\\n },\\n \\"RequestId\\": \\"6F25F67C-F411-499F-BCE2-67CA563CB064\\"\\n}","type":"json"}]', + 'title' => 'Query mass messaging records', + 'summary' => 'Queries mass messaging records under a version. This operation only queries message records that are sent by device model.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'DeleteFunctionFile' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [ + ['createdAt' => '2024-06-18T02:20:29.000Z', 'description' => 'Error codes changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'iovcc:FindVersionMessageSendRecords', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + ], + 'FindVersionMessages' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', - 'systemTags' => [ - 'operationType' => 'delete', - ], + 'operationType' => 'read', + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'ProjectId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'PE9FQC48', - ], + 'schema' => ['description' => 'The ID of the project.', 'type' => 'string', 'required' => true, 'example' => 'P0VFCREU', 'title' => ''], ], [ - 'name' => 'FileName', + 'name' => 'PageIndex', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'hello.zip', - ], + 'schema' => ['description' => 'The start index of the current page.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1', 'title' => ''], ], [ - 'name' => 'FileType', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'The page size.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '20', 'title' => ''], ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '629586FE-CB2E-4742-995E-121F952CEB72', - ], - ], - ], + [ + 'name' => 'MessageType', + 'in' => 'query', + 'schema' => ['description' => 'Valid values:'."\n" + ."\n" + .'- **VERSION_TEST**: system version test message push'."\n" + .'- **SYSTEM_UPDATE**: system version release message push'."\n" + .'- **APP_VERSION_TEST**: application self-upgrade test message push'."\n" + .'- **APP_VERSION_UPDATE**: application self-upgrade release message push.', 'type' => 'string', 'required' => false, 'example' => 'VERSION_TEST', 'title' => ''], ], - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"629586FE-CB2E-4742-995E-121F952CEB72\\"\\n}","errorExample":"{\\n \\"RequestId\\": \\"6F25F67C-F411-499F-BCE2-67CA563CB064\\",\\n \\"HostId\\": \\"iovcc.cn-shanghai.aliyuncs.com\\",\\n \\"Code\\": \\"InvalidTenant\\",\\n \\"Message\\": \\"User is not a valid tenant\\"\\n}"},{"type":"xml","example":"<DeleteFunctionFileResponse>\\r\\n <RequestId>629586FE-CB2E-4742-995E-121F952CEB72</RequestId>\\r\\n</DeleteFunctionFileResponse>","errorExample":""}]', - 'title' => 'DeleteFunctionFile', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'ListDeployedFunctions' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ [ - 'AK' => [], + 'name' => 'TestId', + 'in' => 'query', + 'schema' => ['description' => 'The test ID.', 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''], ], - ], - 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - ], - 'parameters' => [ [ - 'name' => 'ProjectId', + 'name' => 'VersionId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'PE9FQC48', - ], + 'schema' => ['description' => 'The version ID.', 'type' => 'string', 'required' => true, 'example' => '1', 'title' => ''], ], [ - 'name' => 'FileId', + 'name' => 'SendRecordId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1', - ], + 'schema' => ['description' => 'The mass messaging record ID.', 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'DeviceId', + 'in' => 'query', + 'schema' => ['description' => 'The cloud device ID.', 'type' => 'string', 'required' => false, 'example' => 'b8fe2e24ff2b48e0a3aa4e49809fc1b3', 'title' => ''], + ], + [ + 'name' => 'VersionType', + 'in' => 'query', + 'schema' => ['description' => 'The version type. Valid values: FOTA (system version) and APP (application version).', 'type' => 'string', 'required' => true, 'example' => 'FOTA', 'title' => ''], ], ], 'responses' => [ @@ -10284,146 +7434,112 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '629586FE-CB2E-4742-995E-121F952CEB72', - ], - 'Functions' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'ProjectId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'PE9FQC48', - ], - 'GmtCreate' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1535604251000', - ], - 'Name' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'someFunc', - ], - 'GmtModified' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1535872636000', - ], - 'Id' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'FileId' => [ + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '6F25F67C-F411-499F-BCE2-67CA563CB064', 'title' => ''], + 'MessageList' => [ + 'description' => 'The queried message results.', + 'type' => 'object', + 'properties' => [ + 'Items' => [ + 'description' => 'The result list.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'GmtModifyTimestamp' => ['description' => 'The modification timestamp.', 'type' => 'integer', 'format' => 'int64', 'example' => '18974500000', 'title' => ''], + 'GmtCreateTimestamp' => ['description' => 'The creation timestamp.', 'type' => 'integer', 'format' => 'int64', 'example' => '18974500000', 'title' => ''], + 'Status' => ['description' => 'The sending status.', 'type' => 'string', 'example' => 'SUCCESS', 'title' => ''], + 'GmtModify' => ['description' => 'The modification time.', 'type' => 'string', 'example' => '2018-01-01 00:01:00', 'title' => ''], + 'MessageId' => ['description' => 'The ID of the sent message.', 'type' => 'string', 'example' => '1', 'title' => ''], + 'DeviceId' => ['description' => 'The cloud device ID.', 'type' => 'string', 'example' => 'b8fe2e24ff2b48e0a3aa4e49809fc1b3', 'title' => ''], + 'GmtCreate' => ['description' => 'The creation time.', 'type' => 'string', 'example' => '2018-01-01 00:00:00', 'title' => ''], + 'VersionId' => ['description' => 'The version ID.', 'type' => 'string', 'example' => '1', 'title' => ''], + 'StatusDesc' => ['description' => 'The description of the sending status.', 'type' => 'string', 'example' => '发送成功', 'title' => ''], + 'TestId' => ['description' => 'The test ID.', 'type' => 'string', 'example' => '1', 'title' => ''], + 'Id' => ['description' => 'ID', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + ], 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], + 'TotalCount' => ['description' => 'The total number of records that match the conditions.', 'type' => 'integer', 'format' => 'int32', 'example' => '5', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"629586FE-CB2E-4742-995E-121F952CEB72\\",\\n \\"Functions\\": [\\n {\\n \\"ProjectId\\": \\"PE9FQC48\\",\\n \\"GmtCreate\\": 1535604251000,\\n \\"Name\\": \\"someFunc\\",\\n \\"GmtModified\\": 1535872636000,\\n \\"Id\\": 1,\\n \\"FileId\\": 1\\n }\\n ]\\n}","errorExample":"{\\n \\"RequestId\\": \\"6F25F67C-F411-499F-BCE2-67CA563CB064\\",\\n \\"HostId\\": \\"iovcc.cn-shanghai.aliyuncs.com\\",\\n \\"Code\\": \\"InvalidTenant\\",\\n \\"Message\\": \\"User is not a valid tenant\\"\\n}"},{"type":"xml","example":"<ListDeployedFunctionsResponse>\\r\\n\\t<Functions>\\r\\n\\t\\t<FileId>46</FileId>\\r\\n\\t\\t<GmtCreate>1536201206000</GmtCreate>\\r\\n\\t\\t<GmtModified>1536201206000</GmtModified>\\r\\n\\t\\t<Id>35</Id>\\r\\n\\t\\t<Name>someFunc</Name>\\r\\n\\t\\t<ProjectId>PE9FQC48</ProjectId>\\r\\n\\t</Functions>\\r\\n\\t<RequestId>629586FE-CB2E-4742-995E-121F952CEB72</RequestId>\\r\\n</ListDeployedFunctionsResponse>","errorExample":""}]', - 'title' => 'ListDeployedFunctions', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6F25F67C-F411-499F-BCE2-67CA563CB064\\",\\n \\"MessageList\\": {\\n \\"Items\\": [\\n {\\n \\"GmtModifyTimestamp\\": 18974500000,\\n \\"GmtCreateTimestamp\\": 18974500000,\\n \\"Status\\": \\"SUCCESS\\",\\n \\"GmtModify\\": \\"2018-01-01 00:01:00\\",\\n \\"MessageId\\": \\"1\\",\\n \\"DeviceId\\": \\"b8fe2e24ff2b48e0a3aa4e49809fc1b3\\",\\n \\"GmtCreate\\": \\"2018-01-01 00:00:00\\",\\n \\"VersionId\\": \\"1\\",\\n \\"StatusDesc\\": \\"发送成功\\",\\n \\"TestId\\": \\"1\\",\\n \\"Id\\": 1\\n }\\n ],\\n \\"TotalCount\\": 5\\n }\\n}","type":"json"}]', + 'title' => 'Query message sending status', + 'summary' => 'Queries the message sending status under a specific version, test, or mass messaging record.', + 'description' => '> The target type to query is determined by the MessageType parameter.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'ListFunctionExecuteLog' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [ + ['createdAt' => '2024-06-18T02:20:29.000Z', 'description' => 'Error codes changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'iovcc:FindVersionMessages', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'FindVersionTests' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'ProjectId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'PE9FQC48', - ], - ], - [ - 'name' => 'FileId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1', - ], + 'schema' => ['description' => 'The ID of the project.', 'type' => 'string', 'required' => true, 'example' => 'P0VFCREU', 'title' => ''], ], [ - 'name' => 'FunctionName', + 'name' => 'PageIndex', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'someFunc', - ], + 'schema' => ['description' => 'The start index of the current page.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1', 'title' => ''], ], [ - 'name' => 'Env', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '0', - ], + 'schema' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '20', 'title' => ''], ], [ - 'name' => 'PageIndex', + 'name' => 'VersionId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'The version ID.', 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''], ], [ - 'name' => 'PageSize', + 'name' => 'VersionType', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], + 'schema' => ['description' => 'The version type. Valid values:'."\n" + .'- FOTA: system version.'."\n" + .'- APP: application version.', 'type' => 'string', 'required' => false, 'example' => 'FOTA', 'title' => ''], ], ], 'responses' => [ @@ -10431,130 +7547,127 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'LogList' => [ - 'description' => '', + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '6F25F67C-F411-499F-BCE2-67CA563CB064', 'title' => ''], + 'VersionTestList' => [ + 'description' => 'The query results of version tests.', 'type' => 'object', 'properties' => [ - 'Pagination' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'PageIndex' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'HasNextPage' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - ], - ], - 'Logs' => [ - 'description' => '', + 'Items' => [ + 'description' => 'The list of returned records.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2018-08-21T03:28:50.267Z 5f541c0a-2175-7651-7b7e-c8a0bff5cb7e [info] This is output of console.log', - ], - 'BackEndRequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '5f541c0a-2175-7651-7b7e-c8a0bff5cb7e', - ], + 'GmtCreateTimestamp' => ['description' => 'The creation timestamp.', 'type' => 'integer', 'format' => 'int64', 'example' => '1685450000', 'title' => ''], + 'GmtModify' => ['description' => 'The modification time.', 'type' => 'string', 'example' => '2018-01-01 00:01:00', 'title' => ''], + 'VersionId' => ['description' => 'The version ID.', 'type' => 'string', 'example' => '1', 'title' => ''], + 'GmtModifyTimestamp' => ['description' => 'The modification timestamp.', 'type' => 'integer', 'format' => 'int64', 'example' => '1685450000', 'title' => ''], + 'FailedCount' => ['description' => 'The number of failed messages.', 'type' => 'string', 'example' => '0', 'title' => ''], + 'DeviceGroupId' => ['description' => 'The ID of the test device group.', 'type' => 'string', 'example' => '1', 'title' => ''], + 'SkippedCount' => ['description' => 'The number of skipped messages.', 'type' => 'string', 'example' => '0', 'title' => ''], + 'Description' => ['description' => 'The test description.', 'type' => 'string', 'example' => '测试描述', 'title' => ''], + 'SucceededCount' => ['description' => 'The number of successful messages.', 'type' => 'string', 'example' => '100', 'title' => ''], + 'DeviceGroupName' => ['description' => 'The name of the test device group.', 'type' => 'string', 'example' => '测试分组', 'title' => ''], + 'GmtCreate' => ['description' => 'The creation time.', 'type' => 'string', 'example' => '2018-01-01 00:00:00', 'title' => ''], + 'Name' => ['description' => 'The test name.', 'type' => 'string', 'example' => '第一次测试', 'title' => ''], + 'Id' => ['description' => 'The test ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'VersionType' => ['description' => 'The version type. Valid values:'."\n" + .'- FOTA: system version.'."\n" + .'- APP: application version.', 'type' => 'string', 'example' => 'FOTA', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], + 'TotalCount' => ['description' => 'The total number of records that match the specified conditions.', 'type' => 'integer', 'format' => 'int32', 'example' => '30', 'title' => ''], ], - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '629586FE-CB2E-4742-995E-121F952CEB72', + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"629586FE-CB2E-4742-995E-121F952CEB72\\",\\n \\"LogList\\": {\\n \\"Logs\\": [\\n {\\n \\"Message\\": \\"2018-08-21T03:28:50.267Z 5f541c0a-2175-7651-7b7e-c8a0bff5cb7e [info] This is output of console.log\\",\\n \\"BackEndRequestId\\": \\"5f541c0a-2175-7651-7b7e-c8a0bff5cb7e\\"\\n }\\n ],\\n \\"Pagination\\": {\\n \\"PageIndex\\": 1,\\n \\"PageSize\\": 10,\\n \\"HasNextPage\\": true\\n }\\n }\\n}","errorExample":"{\\n \\"RequestId\\": \\"6F25F67C-F411-499F-BCE2-67CA563CB064\\",\\n \\"HostId\\": \\"iovcc.cn-shanghai.aliyuncs.com\\",\\n \\"Code\\": \\"InvalidTenant\\",\\n \\"Message\\": \\"User is not a valid tenant\\"\\n}"},{"type":"xml","example":"<ListFunctionExecuteLogResponse>\\r\\n\\t<LogList>\\r\\n\\t\\t<Logs>\\r\\n\\t\\t\\t<BackEndRequestId>5f541c0a-2175-7651-7b7e-c8a0bff5cb7e</BackEndRequestId>\\r\\n\\t\\t <Message>2018-08-21T03:28:50.267Z 5f541c0a-2175-7651-7b7e-c8a0bff5cb7e [info] This is output of console.log</Message>\\r\\n\\t </Logs>\\r\\n\\t<Pagination>\\r\\n\\t\\t<HasNextPage>false</HasNextPage>\\r\\n\\t\\t<PageIndex>1</PageIndex>\\r\\n\\t\\t<PageSize>10</PageSize>\\r\\n\\t</Pagination>\\r\\n </LogList>\\r\\n <RequestId>629586FE-CB2E-4742-995E-121F952CEB72</RequestId>\\r\\n</ListFunctionExecuteLogResponse>","errorExample":""}]', - 'title' => 'ListFunctionExecuteLog', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6F25F67C-F411-499F-BCE2-67CA563CB064\\",\\n \\"VersionTestList\\": {\\n \\"Items\\": [\\n {\\n \\"GmtCreateTimestamp\\": 1685450000,\\n \\"GmtModify\\": \\"2018-01-01 00:01:00\\",\\n \\"VersionId\\": \\"1\\",\\n \\"GmtModifyTimestamp\\": 1685450000,\\n \\"FailedCount\\": \\"0\\",\\n \\"DeviceGroupId\\": \\"1\\",\\n \\"SkippedCount\\": \\"0\\",\\n \\"Description\\": \\"测试描述\\",\\n \\"SucceededCount\\": \\"100\\",\\n \\"DeviceGroupName\\": \\"测试分组\\",\\n \\"GmtCreate\\": \\"2018-01-01 00:00:00\\",\\n \\"Name\\": \\"第一次测试\\",\\n \\"Id\\": 1,\\n \\"VersionType\\": \\"FOTA\\"\\n }\\n ],\\n \\"TotalCount\\": 30\\n }\\n}","type":"json"}]', + 'title' => 'Query version test list with paging', + 'summary' => 'Calls FindVersionTests to query the version test list by using paging.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'ListFunctionFiles' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [ + ['createdAt' => '2024-06-18T02:20:29.000Z', 'description' => 'Error codes changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'iovcc:FindVersionTests', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + ], + 'FindVersionWhiteDevices' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'ProjectId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'PE9FQC48', - ], + 'schema' => ['description' => 'The project ID.', 'type' => 'string', 'required' => true, 'example' => 'P0VFCREU', 'title' => ''], ], [ - 'name' => 'FileType', + 'name' => 'VersionId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '1', - ], + 'schema' => ['description' => 'The version ID.', 'type' => 'string', 'required' => true, 'example' => '12345', 'title' => ''], + ], + [ + 'name' => 'VersionType', + 'in' => 'query', + 'schema' => ['description' => 'The version type. Valid values:'."\n" + ."\n" + .'- **FOTA**: system upgrade'."\n" + .'- **APP**: application upgrade.', 'type' => 'string', 'required' => true, 'example' => 'FOTA', 'title' => ''], + ], + [ + 'name' => 'DeviceId', + 'in' => 'query', + 'schema' => ['description' => 'The device ID. Fuzzy match is supported.', 'type' => 'string', 'required' => false, 'example' => 'AS23DG23SA5D43GA34SD23GW456E', 'title' => ''], + ], + [ + 'name' => 'OriginalId', + 'in' => 'query', + 'schema' => ['description' => 'The original device ID. Fuzzy match is supported.', 'type' => 'string', 'required' => false, 'example' => '23452345234523452', 'title' => ''], ], [ 'name' => 'PageIndex', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'The page number, starting from 1.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], + 'schema' => ['description' => 'The number of entries per page. Valid values: 10, 20, and 50.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '20', 'title' => ''], ], ], 'responses' => [ @@ -10562,180 +7675,94 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '629586FE-CB2E-4742-995E-121F952CEB72', - ], - 'FileList' => [ - 'description' => '', + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '6F25F67C-F411-499F-BCE2-67CA563CB064', 'title' => ''], + 'DeviceList' => [ + 'description' => 'The device list information.', 'type' => 'object', 'properties' => [ - 'Pagination' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'PageIndex' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'TotalPageCount' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - 'PageSize' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'TotalCount' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '11', - ], - ], - ], - 'Files' => [ - 'description' => '', + 'Items' => [ + 'description' => 'The device data on the current page.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'Status' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'ProductionDeployTime' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1535604251000', - ], - 'ProductionDeployStatus' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'Description' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'This is description', - ], - 'SandboxDeployTime' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1535604251000', - ], - 'GmtCreate' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1535604251000', - ], - 'SandboxDeployStatus' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'GmtModified' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1535604251000', - ], - 'Name' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'hello.zip', - ], - 'ContentId' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'Id' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], + 'GmtCreateTimestamp' => ['description' => 'The creation timestamp.', 'type' => 'integer', 'format' => 'int64', 'example' => '1868400000', 'title' => ''], + 'OriginalId' => ['description' => 'The original device ID.', 'type' => 'string', 'example' => '23452345234523452', 'title' => ''], + 'DeviceId' => ['description' => 'The device ID.', 'type' => 'string', 'example' => 'AS23DG23SA5D43GA34SD23GW456E', 'title' => ''], + 'IdType' => ['description' => 'The device ID type. Valid values:'."\n" + ."\n" + .'- **device_id**: hardware ID'."\n" + .'- **sn**: serial number'."\n" + .'- **vin**: vehicle identification number'."\n" + .'- **hardware_id**: hardware ID.', 'type' => 'string', 'example' => 'hardware_id', 'title' => ''], + 'GmtCreate' => ['description' => 'The time when the device was added.', 'type' => 'string', 'example' => '2018-02-14 14:20:18', 'title' => ''], + 'Id' => ['description' => 'The whitelist ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '123', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], + 'TotalCount' => ['description' => 'The total number of devices that match the conditions.', 'type' => 'integer', 'format' => 'int32', 'example' => '30', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"629586FE-CB2E-4742-995E-121F952CEB72\\",\\n \\"FileList\\": {\\n \\"Files\\": [\\n {\\n \\"Status\\": 0,\\n \\"ProductionDeployTime\\": 1535604251000,\\n \\"ProductionDeployStatus\\": 1,\\n \\"Description\\": \\"This is description\\",\\n \\"SandboxDeployTime\\": 1535604251000,\\n \\"GmtCreate\\": 1535604251000,\\n \\"SandboxDeployStatus\\": 1,\\n \\"GmtModified\\": 1535604251000,\\n \\"Name\\": \\"hello.zip\\",\\n \\"ContentId\\": 1,\\n \\"Id\\": 1\\n }\\n ],\\n \\"Pagination\\": {\\n \\"PageIndex\\": 1,\\n \\"TotalPageCount\\": 2,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 11\\n }\\n }\\n}","errorExample":"{\\n \\"RequestId\\": \\"6F25F67C-F411-499F-BCE2-67CA563CB064\\",\\n \\"HostId\\": \\"iovcc.cn-shanghai.aliyuncs.com\\",\\n \\"Code\\": \\"InvalidTenant\\",\\n \\"Message\\": \\"User is not a valid tenant\\"\\n}"},{"type":"xml","example":"<ListFunctionFilesResponse>\\r\\n\\t<FileList>\\r\\n\\t\\t<Files>\\r\\n\\t\\t\\t<ContentId>5</ContentId>\\r\\n\\t\\t\\t<GmtCreate>1509422113000</GmtCreate>\\r\\n\\t\\t\\t<GmtModified>1510150180000</GmtModified>\\r\\n\\t\\t\\t<Id>17</Id>\\r\\n\\t\\t\\t<Name>hello.zip</Name>\\r\\n\\t\\t\\t<ProductionDeployStatus>0</ProductionDeployStatus>\\r\\n\\t\\t\\t<SandboxDeployStatus>1</SandboxDeployStatus>\\r\\n\\t\\t\\t<SandboxDeployTime>1509422113000</SandboxDeployTime>\\r\\n\\t\\t\\t<Status>0</Status>\\r\\n\\t\\t</Files>\\r\\n\\t\\t<Files>\\r\\n\\t\\t\\t<ContentId>29</ContentId>\\r\\n\\t\\t\\t<Description>This is Desciption</Description>\\r\\n\\t\\t\\t<GmtCreate>1534739368000</GmtCreate>\\r\\n\\t\\t\\t<GmtModified>1534739368000</GmtModified>\\r\\n\\t\\t\\t<Id>41</Id>\\r\\n\\t\\t\\t<Name>hello.zip</Name>\\r\\n\\t\\t\\t<ProductionDeployStatus>1</ProductionDeployStatus>\\r\\n\\t\\t\\t<ProductionDeployTime>1509422113000</ProductionDeployTime>\\r\\n\\t\\t\\t<SandboxDeployStatus>1</SandboxDeployStatus>\\r\\n\\t\\t\\t<SandboxDeployTime>1509422113000</SandboxDeployTime>\\r\\n\\t\\t\\t<Status>0</Status>\\r\\n\\t\\t</Files>\\r\\n\\t\\t<Pagination>\\r\\n\\t\\t\\t<PageIndex>1</PageIndex>\\r\\n\\t\\t\\t<PageSize>10</PageSize>\\r\\n\\t\\t\\t<TotalCount>15</TotalCount>\\r\\n\\t\\t\\t<TotalPageCount>2</TotalPageCount>\\r\\n\\t\\t</Pagination>\\r\\n\\t</FileList>\\r\\n\\t<RequestId>629586FE-CB2E-4742-995E-121F952CEB72</RequestId>\\r\\n</ListFunctionFilesResponse>","errorExample":""}]', - 'title' => 'ListFunctionFiles', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6F25F67C-F411-499F-BCE2-67CA563CB064\\",\\n \\"DeviceList\\": {\\n \\"Items\\": [\\n {\\n \\"GmtCreateTimestamp\\": 1868400000,\\n \\"OriginalId\\": \\"23452345234523452\\",\\n \\"DeviceId\\": \\"AS23DG23SA5D43GA34SD23GW456E\\",\\n \\"IdType\\": \\"hardware_id\\",\\n \\"GmtCreate\\": \\"2018-02-14 14:20:18\\",\\n \\"Id\\": 123\\n }\\n ],\\n \\"TotalCount\\": 30\\n }\\n}","type":"json"}]', + 'title' => 'Query device whitelist by page for a system or application version', + 'summary' => 'Queries the device whitelist of a system version or application version by page by calling FindVersionWhiteDevices.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'ListFunctionFilesByProjectId' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [ + ['createdAt' => '2024-06-18T02:20:29.000Z', 'description' => 'Error codes changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'iovcc:FindVersionWhiteDevices', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + ], + 'GenerateFunctionFileUploadMeta' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'ProjectId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'PE9FQC48', - ], - ], - [ - 'name' => 'PageIndex', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'The project ID.', 'type' => 'string', 'required' => true, 'example' => 'PE9FQC48', 'title' => ''], ], [ - 'name' => 'PageSize', + 'name' => 'FileName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], + 'schema' => ['description' => 'The file name.', 'type' => 'string', 'required' => true, 'example' => 'hello.zip', 'title' => ''], ], ], 'responses' => [ @@ -10743,109 +7770,84 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '629586FE-CB2E-4742-995E-121F952CEB72', - ], - 'Files' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Type' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'Status' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'GmtCreate' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1535604251000', - ], - 'GmtModified' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1535872636000', - ], - 'Name' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'hello.zip', - ], - 'Id' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'ContentId' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '629586FE-CB2E-4742-995E-121F952CEB72', 'title' => ''], + 'UploadMeta' => [ + 'description' => 'The upload metadata of the file.', + 'type' => 'object', + 'properties' => [ + 'PostObjectPolicy' => [ + 'description' => 'The input parameters for uploading the file. For more information, see [PostObject](https://help.aliyun.com/document_detail/31988.html) in the OSS documentation.', + 'type' => 'object', + 'properties' => [ + 'Signature' => ['description' => 'The signature information. For more information, see [Post Signature](https://help.aliyun.com/document_detail/31988.html?spm=a2c4g.11186623.4.5.3d774382LHt5Uz#h2-url-3).', 'type' => 'string', 'example' => 'XuG0kIHhWPbztVfDGA1HhzdKPJI=', 'title' => ''], + 'Host' => ['description' => 'The destination address for the file upload.', 'type' => 'string', 'example' => 'https://iovcc-yunfunction-qa.oss-cn-shanghai.aliyuncs.com', 'title' => ''], + 'Policy' => ['description' => 'The Base64-encoded [PostPolicy](https://help.aliyun.com/document_detail/31988.html?spm=a2c4g.11186623.4.5.3d774382LHt5Uz#h2-url-2) information.', 'type' => 'string', 'example' => 'eyJleHBpcmF0aW9uIjoiMjAxOC0wOS0xOFQwMjoxMToyNy4wODZaIiwiY29uZGl0aW9ucyI6W1siY29udGVudC1sZW5ndGgtcmFuZ2UiLDAsMTA0ODU3NjAwXSxbInN0YXJ0cy13aXRoIiwiJGtleSIsImZ1bmN0aW9uL2ZpbGUvMTI4ODEyNzI0MDkzMDcxMS9QRTlGUUM0OCJdXX0=', 'title' => ''], + 'Expire' => ['description' => 'The expiration duration of the PostPolicy, in milliseconds.', 'type' => 'string', 'example' => '1537236687', 'title' => ''], + 'AccessId' => ['description' => 'The temporary access ID.', 'type' => 'string', 'example' => 'STS.NHm36Gt3rEesnNGi7spRPCMeD', 'title' => ''], ], + 'title' => '', + 'example' => '', ], + 'SecurityToken' => ['description' => 'The STS token for RAM role assumption. For more information, see [STS temporary authorization](https://help.aliyun.com/document_detail/32016.html).', 'type' => 'string', 'example' => 'CAIStQN1q6Ft5B2yfSjIr4vYeIzzmexT8qeYbGj2jTcmfN18rIjOpjz2IHFIeHRoBeocs/42n25S6/gSlokqEMRvGxCVNeJctboL2CqPSdWYl5Llx+Qp2MyLMDO/JUYlCllp1aGrIunGc9KBNnpA/00amMl0HFfPdlihNoLzxvwDR98LXw6+QCNbDdNNXGVLo9MbMn2jUpTINQXx0FLNEG1iuAd3lRmkgMbZ+MCH7QfEh1DX0/Ico5+LQqKpdM5xJpxyISncvsx/fbGT1zVLuVoYtvV3i7JP8nLWo9eTHl9a/xSBNa/N+5phMQlyeqk9HelKrfzx0qQi6ryKzdutl04cZrkKCn2YfK3x7vLvRLPLFN8ybuT8IG+fkILNZJjyrQgvJGMGMg1XfdE9K3h2TAUlDT/HLKS7+VfMJQmiT6XCiftmgcMvkA+0pYvRfwfWGvKh/Hc2A7RgPwRqFWZPhDG4K/VbKVwVIwM5XOrMd+gpMkAC85GPlBbJSyhtwktQu/DDfP7MssgdE96uAs4bidZHPskc6jB0FQmpG6jVi0AKf2d+Xa1fy7LwPJKg8r6ZzfV+qBVC8Ubq0BqAAWxX+0Nwa5DhRemsT1hWIFHzz7zvt8mvHXE42bOQsmHAlThYrG27r1IJ4PeiL17aiTPK0nW5aXpvjaskg+b42mR/YsI0T7v7xMuMj6btceXEBBMl3a82lDryxBtj6+N49U5Wn+bKXXAtz5/ti7LWHALboNLIOyJLWZeWOOMzyA63', 'title' => ''], + 'ObjectKey' => ['description' => 'The identifier of the uploaded file.', 'type' => 'string', 'example' => 'function/file/1288127240930711/PE9FQC48/B1226EA3-2518-4164-8D2D-82B91A077020/hello.zip', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"629586FE-CB2E-4742-995E-121F952CEB72\\",\\n \\"Files\\": [\\n {\\n \\"Type\\": 1,\\n \\"Status\\": 0,\\n \\"GmtCreate\\": 1535604251000,\\n \\"GmtModified\\": 1535872636000,\\n \\"Name\\": \\"hello.zip\\",\\n \\"Id\\": 1,\\n \\"ContentId\\": 1\\n }\\n ]\\n}","errorExample":"{\\n \\"RequestId\\": \\"6F25F67C-F411-499F-BCE2-67CA563CB064\\",\\n \\"HostId\\": \\"iovcc.cn-shanghai.aliyuncs.com\\",\\n \\"Code\\": \\"InvalidTenant\\",\\n \\"Message\\": \\"User is not a valid tenant\\"\\n}"},{"type":"xml","example":"<ListFunctionFilesByProjectIdResponse>\\r\\n\\t<Files>\\r\\n\\t\\t<ContentId>17</ContentId>\\r\\n\\t\\t<GmtCreate>1536201185000</GmtCreate>\\r\\n\\t\\t<GmtModified>1536633019000</GmtModified>\\r\\n\\t\\t<Id>46</Id>\\r\\n\\t\\t<Name>hello.zip</Name>\\r\\n\\t\\t<Status>0</Status>\\r\\n\\t\\t<Type>1</Type>\\r\\n\\t</Files>\\r\\n\\t<RequestId>629586FE-CB2E-4742-995E-121F952CEB72</RequestId>\\r\\n</ListFunctionFilesByProjectIdResponse>","errorExample":""}]', - 'title' => 'ListFunctionFilesByProjectId', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"629586FE-CB2E-4742-995E-121F952CEB72\\",\\n \\"UploadMeta\\": {\\n \\"PostObjectPolicy\\": {\\n \\"Signature\\": \\"XuG0kIHhWPbztVfDGA1HhzdKPJI=\\",\\n \\"Host\\": \\"https://iovcc-yunfunction-qa.oss-cn-shanghai.aliyuncs.com\\",\\n \\"Policy\\": \\"eyJleHBpcmF0aW9uIjoiMjAxOC0wOS0xOFQwMjoxMToyNy4wODZaIiwiY29uZGl0aW9ucyI6W1siY29udGVudC1sZW5ndGgtcmFuZ2UiLDAsMTA0ODU3NjAwXSxbInN0YXJ0cy13aXRoIiwiJGtleSIsImZ1bmN0aW9uL2ZpbGUvMTI4ODEyNzI0MDkzMDcxMS9QRTlGUUM0OCJdXX0=\\",\\n \\"Expire\\": \\"1537236687\\",\\n \\"AccessId\\": \\"STS.NHm36Gt3rEesnNGi7spRPCMeD\\"\\n },\\n \\"SecurityToken\\": \\"CAIStQN1q6Ft5B2yfSjIr4vYeIzzmexT8qeYbGj2jTcmfN18rIjOpjz2IHFIeHRoBeocs/42n25S6/gSlokqEMRvGxCVNeJctboL2CqPSdWYl5Llx+Qp2MyLMDO/JUYlCllp1aGrIunGc9KBNnpA/00amMl0HFfPdlihNoLzxvwDR98LXw6+QCNbDdNNXGVLo9MbMn2jUpTINQXx0FLNEG1iuAd3lRmkgMbZ+MCH7QfEh1DX0/Ico5+LQqKpdM5xJpxyISncvsx/fbGT1zVLuVoYtvV3i7JP8nLWo9eTHl9a/xSBNa/N+5phMQlyeqk9HelKrfzx0qQi6ryKzdutl04cZrkKCn2YfK3x7vLvRLPLFN8ybuT8IG+fkILNZJjyrQgvJGMGMg1XfdE9K3h2TAUlDT/HLKS7+VfMJQmiT6XCiftmgcMvkA+0pYvRfwfWGvKh/Hc2A7RgPwRqFWZPhDG4K/VbKVwVIwM5XOrMd+gpMkAC85GPlBbJSyhtwktQu/DDfP7MssgdE96uAs4bidZHPskc6jB0FQmpG6jVi0AKf2d+Xa1fy7LwPJKg8r6ZzfV+qBVC8Ubq0BqAAWxX+0Nwa5DhRemsT1hWIFHzz7zvt8mvHXE42bOQsmHAlThYrG27r1IJ4PeiL17aiTPK0nW5aXpvjaskg+b42mR/YsI0T7v7xMuMj6btceXEBBMl3a82lDryxBtj6+N49U5Wn+bKXXAtz5/ti7LWHALboNLIOyJLWZeWOOMzyA63\\",\\n \\"ObjectKey\\": \\"function/file/1288127240930711/PE9FQC48/B1226EA3-2518-4164-8D2D-82B91A077020/hello.zip\\"\\n }\\n}","type":"json"}]', + 'title' => 'Generate function file upload metadata', + 'summary' => 'Calls GenerateFunctionFileUploadMeta to generate upload metadata for a function file.', + 'description' => '> After you obtain the upload metadata, you can upload the function file to OSS. For more information, see [Server-side signing for direct upload](https://help.aliyun.com/document_detail/31926.html) in the OSS documentation.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'GenerateFunctionFileUploadMeta' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [ + ['createdAt' => '2024-06-18T02:20:29.000Z', 'description' => 'Error codes changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'iovcc:GenerateFunctionFileUploadMeta', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + ], + 'GenerateOssUploadMeta' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'ProjectId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'PE9FQC48', - ], + 'schema' => ['description' => 'The project ID.', 'type' => 'string', 'required' => true, 'example' => '11', 'title' => ''], ], [ - 'name' => 'FileName', + 'name' => 'Ext', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'hello.zip', - ], + 'schema' => ['description' => 'The file name extension.', 'type' => 'string', 'required' => true, 'example' => 'rsa', 'title' => ''], ], ], 'responses' => [ @@ -10853,138 +7855,93 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '629586FE-CB2E-4742-995E-121F952CEB72', - ], - 'UploadMeta' => [ - 'description' => '', + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '7676B259-FFA5-4971-A9D7-7B3F48D1DEEB', 'title' => ''], + 'OssUploadMeta' => [ + 'description' => 'The credential information required for uploading files to OSS.', 'type' => 'object', 'properties' => [ - 'PostObjectPolicy' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Signature' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'XuG0kIHhWPbztVfDGA1HhzdKPJI=', - ], - 'Host' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'https://iovcc-yunfunction-qa.oss-cn-shanghai.aliyuncs.com', - ], - 'Policy' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'eyJleHBpcmF0aW9uIjoiMjAxOC0wOS0xOFQwMjoxMToyNy4wODZaIiwiY29uZGl0aW9ucyI6W1siY29udGVudC1sZW5ndGgtcmFuZ2UiLDAsMTA0ODU3NjAwXSxbInN0YXJ0cy13aXRoIiwiJGtleSIsImZ1bmN0aW9uL2ZpbGUvMTI4ODEyNzI0MDkzMDcxMS9QRTlGUUM0OCJdXX0=', - ], - 'Expire' => [ - 'description' => '', - 'type' => 'string', - 'example' => '1537236687', - ], - 'AccessId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'STS.NHm36Gt3rEesnNGi7spRPCMeD', - ], - ], - ], - 'SecurityToken' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'CAIStQN1q6Ft5B2yfSjIr4vYeIzzmexT8qeYbGj2jTcmfN18rIjOpjz2IHFIeHRoBeocs/42n25S6/gSlokqEMRvGxCVNeJctboL2CqPSdWYl5Llx+Qp2MyLMDO/JUYlCllp1aGrIunGc9KBNnpA/00amMl0HFfPdlihNoLzxvwDR98LXw6+QCNbDdNNXGVLo9MbMn2jUpTINQXx0FLNEG1iuAd3lRmkgMbZ+MCH7QfEh1DX0/Ico5+LQqKpdM5xJpxyISncvsx/fbGT1zVLuVoYtvV3i7JP8nLWo9eTHl9a/xSBNa/N+5phMQlyeqk9HelKrfzx0qQi6ryKzdutl04cZrkKCn2YfK3x7vLvRLPLFN8ybuT8IG+fkILNZJjyrQgvJGMGMg1XfdE9K3h2TAUlDT/HLKS7+VfMJQmiT6XCiftmgcMvkA+0pYvRfwfWGvKh/Hc2A7RgPwRqFWZPhDG4K/VbKVwVIwM5XOrMd+gpMkAC85GPlBbJSyhtwktQu/DDfP7MssgdE96uAs4bidZHPskc6jB0FQmpG6jVi0AKf2d+Xa1fy7LwPJKg8r6ZzfV+qBVC8Ubq0BqAAWxX+0Nwa5DhRemsT1hWIFHzz7zvt8mvHXE42bOQsmHAlThYrG27r1IJ4PeiL17aiTPK0nW5aXpvjaskg+b42mR/YsI0T7v7xMuMj6btceXEBBMl3a82lDryxBtj6+N49U5Wn+bKXXAtz5/ti7LWHALboNLIOyJLWZeWOOMzyA63', - ], - 'ObjectKey' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'function/file/1288127240930711/PE9FQC48/B1226EA3-2518-4164-8D2D-82B91A077020/hello.zip', - ], + 'SecurityToken' => ['description' => 'The STS authorization access token.', 'type' => 'string', 'example' => 'xxxxxxxxxxxxxxxxx+YHAPgNwi7yfRecMFydL2uPOgBI7LDio0RkbYLmJfIxHM2nGBPdml7kYEOXmJp2aDhbvvwVYIyt/8iES/R6N208wQh0Pk2bu+/9dvalp6wOHF4gkFGhhTVFMuTDRhQlNDU0pWTXVLZzVVMXZGRHciBTQzMjc0KgVhbGljZTCpnJjwySk6BlJzYU1ENUJuCgExGmkKBUFsbG93Eh8KDEFjdGlvbkVxdWFscxIGQWN0aW9uGgcKBW9zczoqEj8KDlJlc291cmNlRXF1YWxzEghSZXNvdXJjZRojCiFhY3M6b3NzOio6NDMyNzQ6c2FtcGxlYm94L2FsaWNlLyo=', 'title' => ''], + 'ObjectKey' => ['description' => 'The full name of the file stored in OSS.', 'type' => 'string', 'example' => '1768723179523459/11/2018-05-07/cert.rsa', 'title' => ''], + 'AccessKeySecret' => ['description' => 'The temporary AccessKey secret.', 'type' => 'string', 'example' => 'xxxxxxxxxxxxxxxxx', 'title' => ''], + 'AccessKeyId' => ['description' => 'The temporary AccessKey ID.', 'type' => 'string', 'example' => 'STS.xxxxxxxxxxxxxxxxx', 'title' => ''], + 'Bucket' => ['description' => 'The bucket to which the file is uploaded.', 'type' => 'string', 'example' => 'xxxx', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"629586FE-CB2E-4742-995E-121F952CEB72\\",\\n \\"UploadMeta\\": {\\n \\"SecurityToken\\": \\"CAIStQN1q6Ft5B2yfSjIr4vYeIzzmexT8qeYbGj2jTcmfN18rIjOpjz2IHFIeHRoBeocs/42n25S6/gSlokqEMRvGxCVNeJctboL2CqPSdWYl5Llx+Qp2MyLMDO/JUYlCllp1aGrIunGc9KBNnpA/00amMl0HFfPdlihNoLzxvwDR98LXw6+QCNbDdNNXGVLo9MbMn2jUpTINQXx0FLNEG1iuAd3lRmkgMbZ+MCH7QfEh1DX0/Ico5+LQqKpdM5xJpxyISncvsx/fbGT1zVLuVoYtvV3i7JP8nLWo9eTHl9a/xSBNa/N+5phMQlyeqk9HelKrfzx0qQi6ryKzdutl04cZrkKCn2YfK3x7vLvRLPLFN8ybuT8IG+fkILNZJjyrQgvJGMGMg1XfdE9K3h2TAUlDT/HLKS7+VfMJQmiT6XCiftmgcMvkA+0pYvRfwfWGvKh/Hc2A7RgPwRqFWZPhDG4K/VbKVwVIwM5XOrMd+gpMkAC85GPlBbJSyhtwktQu/DDfP7MssgdE96uAs4bidZHPskc6jB0FQmpG6jVi0AKf2d+Xa1fy7LwPJKg8r6ZzfV+qBVC8Ubq0BqAAWxX+0Nwa5DhRemsT1hWIFHzz7zvt8mvHXE42bOQsmHAlThYrG27r1IJ4PeiL17aiTPK0nW5aXpvjaskg+b42mR/YsI0T7v7xMuMj6btceXEBBMl3a82lDryxBtj6+N49U5Wn+bKXXAtz5/ti7LWHALboNLIOyJLWZeWOOMzyA63\\",\\n \\"ObjectKey\\": \\"function/file/1288127240930711/PE9FQC48/B1226EA3-2518-4164-8D2D-82B91A077020/hello.zip\\",\\n \\"PostObjectPolicy\\": {\\n \\"Signature\\": \\"XuG0kIHhWPbztVfDGA1HhzdKPJI=\\",\\n \\"Host\\": \\"https://iovcc-yunfunction-qa.oss-cn-shanghai.aliyuncs.com\\",\\n \\"Policy\\": \\"eyJleHBpcmF0aW9uIjoiMjAxOC0wOS0xOFQwMjoxMToyNy4wODZaIiwiY29uZGl0aW9ucyI6W1siY29udGVudC1sZW5ndGgtcmFuZ2UiLDAsMTA0ODU3NjAwXSxbInN0YXJ0cy13aXRoIiwiJGtleSIsImZ1bmN0aW9uL2ZpbGUvMTI4ODEyNzI0MDkzMDcxMS9QRTlGUUM0OCJdXX0=\\",\\n \\"Expire\\": \\"1537236687\\",\\n \\"AccessId\\": \\"STS.NHm36Gt3rEesnNGi7spRPCMeD\\"\\n }\\n }\\n}","errorExample":"{\\n \\"RequestId\\": \\"6F25F67C-F411-499F-BCE2-67CA563CB064\\",\\n \\"HostId\\": \\"iovcc.cn-shanghai.aliyuncs.com\\",\\n \\"Code\\": \\"InvalidTenant\\",\\n \\"Message\\": \\"User is not a valid tenant\\"\\n}"},{"type":"xml","example":"<GenerateFunctionFileUploadMetaResponse>\\r\\n\\t<RequestId>6F25F67C-F411-499F-BCE2-67CA563CB064</RequestId>\\r\\n\\t<UploadMeta>\\r\\n\\t\\t<ObjectKey>function/file/1288127239930711/PE9FQC48/6F25F67C-F411-499F-BCE2-67CA563CB064/hello.zip</ObjectKey>\\r\\n\\t\\t<PostObjectPolicy>\\r\\n\\t\\t\\t<AccessId>STS.NHm36Gt3rEesnNGi7spRPCMeD</AccessId>\\r\\n\\t\\t\\t<Expire>1537236687</Expire>\\r\\n\\t\\t\\t<Host>https://iovcc-yunfunction-online.oss-cn-shanghai.aliyuncs.com</Host>\\r\\n\\t\\t\\t<Policy>eyJleHBpcmF0aW9uIjoiMjAxOC0wOS0xOFQwMjoxMToyNy4wODZaIiwiY29uZGl0aW9ucyI6W1siY29udGVudC1sZW5ndGgtcmFuZ2UiLDAsMTA0ODU3NjAwXSxbInN0YXJ0cy13aXRoIiwiJGtleSIsImZ1bmN0aW9uL2ZpbGUvMTI4ODEyNzI0MDkzMDcxMS9QRTlGUUM0OCJdXX0=</Policy>\\r\\n\\t\\t\\t<Signature>XuG0kIHhWPbztVfDGA1HhzdKPJI=</Signature>\\r\\n\\t\\t</PostObjectPolicy>\\r\\n\\t\\t<SecurityToken>CAIStQN1q6Ft5B2yfSjIr4vYeIzzmexT8qeYbGj2jTcmfN18rIjOpjz2IHFIeHRoBeocs/42n25S6/gSlokqEMRvGxCVNeJctboL2CqPSdWYl5Llx+Qp2MyLMDO/JUYlCllp1aGrIunGc9KBNnpA/00amMl0HFfPdlihNoLzxvwDR98LXw6+QCNbDdNNXGVLo9MbMn2jUpTINQXx0FLNEG1iuAd3lRmkgMbZ+MCH7QfEh1DX0/Ico5+LQqKpdM5xJpxyISncvsx/fbGT1zVLuVoYtvV3i7JP8nLWo9eTHl9a/xSBNa/N+5phMQlyeqk9HelKrfzx0qQi6ryKzdutl04cZrkKCn2YfK3x7vLvRLPLFN8ybuT8IG+fkILNZJjyrQgvJGMGMg1XfdE9K3h2TAUlDT/HLKS7+VfMJQmiT6XCiftmgcMvkA+0pYvRfwfWGvKh/Hc2A7RgPwRqFWZPhDG4K/VbKVwVIwM5XOrMd+gpMkAC85GPlBbJSyhtwktQu/DDfP7MssgdE96uAs4bidZHPskc6jB0FQmpG6jVi0AKf2d+Xa1fy7LwPJKg8r6ZzfV+qBVC8Ubq0BqAAWxX+0Nwa5DhRemsT1hWIFHzz7zvt8mvHXE42bOQsmHAlThYrG27r1IJ4PeiL17aiTPK0nW5aXpvjaskg+b42mR/YsI0T7v7xMuMj6btceXEBBMl3a82lDryxBtj6+N49U5Wn+bKXXAtz5/ti7LWHALboNLIOyJLWZeWOOMzyA63</SecurityToken>\\r\\n\\t</UploadMeta>\\r\\n</GenerateFunctionFileUploadMetaResponse>","errorExample":""}]', - 'title' => 'GenerateFunctionFileUploadMeta', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7676B259-FFA5-4971-A9D7-7B3F48D1DEEB\\",\\n \\"OssUploadMeta\\": {\\n \\"SecurityToken\\": \\"xxxxxxxxxxxxxxxxx+YHAPgNwi7yfRecMFydL2uPOgBI7LDio0RkbYLmJfIxHM2nGBPdml7kYEOXmJp2aDhbvvwVYIyt/8iES/R6N208wQh0Pk2bu+/9dvalp6wOHF4gkFGhhTVFMuTDRhQlNDU0pWTXVLZzVVMXZGRHciBTQzMjc0KgVhbGljZTCpnJjwySk6BlJzYU1ENUJuCgExGmkKBUFsbG93Eh8KDEFjdGlvbkVxdWFscxIGQWN0aW9uGgcKBW9zczoqEj8KDlJlc291cmNlRXF1YWxzEghSZXNvdXJjZRojCiFhY3M6b3NzOio6NDMyNzQ6c2FtcGxlYm94L2FsaWNlLyo=\\",\\n \\"ObjectKey\\": \\"1768723179523459/11/2018-05-07/cert.rsa\\",\\n \\"AccessKeySecret\\": \\"xxxxxxxxxxxxxxxxx\\",\\n \\"AccessKeyId\\": \\"STS.xxxxxxxxxxxxxxxxx\\",\\n \\"Bucket\\": \\"xxxx\\"\\n }\\n}","type":"json"}]', + 'title' => 'Retrieve OSS upload credentials', + 'summary' => 'Retrieves temporary credentials for uploading files to OSS. The credentials have a limited validity period and are granted restricted permissions.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'InvokeFunction' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [ + ['createdAt' => '2024-06-18T02:20:28.000Z', 'description' => 'Error codes changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'iovcc:GenerateOssUploadMeta', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + ], + 'GenerateSdkDownloadInfo' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', - 'systemTags' => [ - 'operationType' => 'create', - ], + 'operationType' => 'read', + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'ProjectId', + 'name' => 'Sdks', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'PE9FQC48', - ], + 'schema' => ['description' => 'The SDKs that you want to download. Separate multiple SDKs with commas (,).', 'type' => 'string', 'required' => true, 'example' => 'AiCCSDK-FOTA,AiCCSDK-CMNS', 'title' => ''], ], [ - 'name' => 'FileId', + 'name' => 'AppId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1', - ], + 'schema' => ['description' => 'The ID of the custom application.', 'type' => 'string', 'required' => true, 'example' => 'A3BU0HBO', 'title' => ''], ], [ - 'name' => 'FunctionName', + 'name' => 'OsType', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'someFunc', - ], + 'schema' => ['description' => 'The operating system type. Valid values: 1: Android.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1', 'title' => ''], ], [ - 'name' => 'Env', + 'name' => 'PkgName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '0', - ], + 'schema' => ['description' => 'The package name of the custom application.', 'type' => 'string', 'required' => true, 'example' => 'com.test.app', 'title' => ''], ], [ - 'name' => 'Parameters', + 'name' => 'ProjectId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '{"key":"value"}', - ], + 'schema' => ['description' => 'The project ID.', 'type' => 'string', 'required' => true, 'example' => '11', 'title' => ''], + ], + [ + 'name' => 'CertFileObjectKey', + 'in' => 'query', + 'schema' => ['description' => 'The full name of the RSA certificate file in Object Storage Service (OSS) after the file is uploaded to OSS.', 'type' => 'string', 'required' => true, 'example' => '1768723179523459/11/2018-05-07/1525699039841.rsa', 'title' => ''], ], ], 'responses' => [ @@ -10992,86 +7949,92 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '629586FE-CB2E-4742-995E-121F952CEB72', - ], - 'Result' => [ - 'description' => '', + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'F3BAE77D-1954-48C5-95F6-D4937B29E2F4', 'title' => ''], + 'SdkDownloadInfo' => [ + 'description' => 'The SDK download information.', 'type' => 'object', 'properties' => [ - 'Output' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'hello, bla bla bla...', - ], - 'BackEndRequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '54117932-59f1-4955-7a26-0c96962fd645', - ], + 'Url' => ['description' => 'The download URL.', 'type' => 'string', 'example' => 'http://iovcc-pm-tenant.oss-cn-shanghai.aliyuncs.com/1768723179523459/11/2018-05-07/aicc-sdk-1525699039841.zip?OSSAccessKeyId=nz2pc56s936**9l&Expires=1141889120&Signature=vjbyPxybdZaNmGa%2ByT272YEAiv4%3D', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"629586FE-CB2E-4742-995E-121F952CEB72\\",\\n \\"Result\\": {\\n \\"Output\\": \\"hello, bla bla bla...\\",\\n \\"BackEndRequestId\\": \\"54117932-59f1-4955-7a26-0c96962fd645\\"\\n }\\n}","errorExample":"{\\n \\"RequestId\\": \\"6F25F67C-F411-499F-BCE2-67CA563CB064\\",\\n \\"HostId\\": \\"iovcc.cn-shanghai.aliyuncs.com\\",\\n \\"Code\\": \\"InvalidTenant\\",\\n \\"Message\\": \\"User is not a valid tenant\\"\\n}"},{"type":"xml","example":"<InvokeFunctionResponse>\\r\\n\\t<RequestId>629586FE-CB2E-4742-995E-121F952CEB72</RequestId>\\r\\n\\t<Result>\\r\\n\\t\\t<BackEndRequestId>2b500332-5a7b-9b5b-b92e-38685b95efaa</BackEndRequestId>\\r\\n\\t\\t<Output>succeed</Output>\\r\\n\\t</Result>\\r\\n</InvokeFunctionResponse>","errorExample":""}]', - 'title' => 'InvokeFunction', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F3BAE77D-1954-48C5-95F6-D4937B29E2F4\\",\\n \\"SdkDownloadInfo\\": {\\n \\"Url\\": \\"http://iovcc-pm-tenant.oss-cn-shanghai.aliyuncs.com/1768723179523459/11/2018-05-07/aicc-sdk-1525699039841.zip?OSSAccessKeyId=nz2pc56s936**9l&Expires=1141889120&Signature=vjbyPxybdZaNmGa%2ByT272YEAiv4%3D\\"\\n }\\n}","type":"json"}]', + 'title' => 'Retrieve SDK download information', + 'summary' => 'Calls GenerateSdkDownloadInfo to retrieve SDK download information.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'DeployFunctionFile' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [ + ['createdAt' => '2024-06-18T02:20:28.000Z', 'description' => 'Error codes changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'iovcc:GenerateSdkDownloadInfo', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + ], + 'GenerateSysAppDownloadInfo' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', - 'systemTags' => [ - 'operationType' => 'update', - ], + 'operationType' => 'read', + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'ProjectId', + 'name' => 'Plugins', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'PE9FQC48', - ], + 'schema' => ['description' => 'The collection of plugins selected by the user when downloading the AiCC Container application. Multiple selections are supported. The value is stored as a JSON array.', 'type' => 'string', 'required' => true, 'example' => '[{"PkgName":"com.aliyun.aicc.yundevice","VersionCode":20180228},{"PkgName":"com.aliyun.aicc.remoteassistant","VersionCode":""}]', 'title' => ''], ], [ - 'name' => 'FileId', + 'name' => 'SignMode', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '35', - ], + 'schema' => ['description' => 'The signing method. Valid values:'."\n" + ."\n" + .'- **customized**: custom signing'."\n" + .'- **platform**: platform signing.', 'type' => 'string', 'required' => true, 'example' => 'customized', 'title' => ''], ], [ - 'name' => 'DeployEnv', + 'name' => 'OsType', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '0', - ], + 'schema' => ['description' => 'The operating system type. Set this parameter to 1 for Android.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'PkgName', + 'in' => 'query', + 'schema' => ['description' => 'The package name of the system application that the user selects to download.', 'type' => 'string', 'required' => true, 'example' => 'com.aliyun.aicc', 'title' => ''], + ], + [ + 'name' => 'ProjectId', + 'in' => 'query', + 'schema' => ['description' => 'The project ID.', 'type' => 'string', 'required' => true, 'example' => '11', 'title' => ''], + ], + [ + 'name' => 'CertFileObjectKey', + 'in' => 'query', + 'schema' => ['description' => 'The full file name of the RSA certificate file in OSS after it is uploaded to OSS.', 'type' => 'string', 'required' => false, 'example' => '1768723179523459/11/2018-05-07/1525699039841.rsa', 'title' => ''], ], ], 'responses' => [ @@ -11079,122 +8042,90 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '629586FE-CB2E-4742-995E-121F952CEB72', + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'F3BAE77D-1954-48C5-95F6-D4937B29E2F4', 'title' => ''], + 'SysAppDownloadInfo' => [ + 'description' => 'The system application download information.', + 'type' => 'object', + 'properties' => [ + 'Url' => ['description' => 'The download URL.', 'type' => 'string', 'example' => 'http://iovcc-pm-tenant.oss-cn-shanghai.aliyuncs.com/1768723179523459/11/2018-05-07/1525699039841-com.aliyun.aicc-20180507.apk?OSSAccessKeyId=nz2pc56s936**9l&Expires=1141889120&Signature=vjbyPxybdZaNmGa%2ByT272YEAiv4%3D', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"629586FE-CB2E-4742-995E-121F952CEB72\\"\\n}","errorExample":"{\\n \\"RequestId\\": \\"6F25F67C-F411-499F-BCE2-67CA563CB064\\",\\n \\"HostId\\": \\"iovcc.cn-shanghai.aliyuncs.com\\",\\n \\"Code\\": \\"InvalidTenant\\",\\n \\"Message\\": \\"User is not a valid tenant\\"\\n}"},{"type":"xml","example":"<DeployFunctionFileResponse>\\r\\n\\t<RequestId>629586FE-CB2E-4742-995E-121F952CEB72</RequestId>\\r\\n</DeployFunctionFileResponse>","errorExample":""}]', - 'title' => 'DeployFunctionFile', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F3BAE77D-1954-48C5-95F6-D4937B29E2F4\\",\\n \\"SysAppDownloadInfo\\": {\\n \\"Url\\": \\"http://iovcc-pm-tenant.oss-cn-shanghai.aliyuncs.com/1768723179523459/11/2018-05-07/1525699039841-com.aliyun.aicc-20180507.apk?OSSAccessKeyId=nz2pc56s936**9l&Expires=1141889120&Signature=vjbyPxybdZaNmGa%2ByT272YEAiv4%3D\\"\\n }\\n}","type":"json"}]', + 'title' => 'Obtain ioVCC system application download information', + 'summary' => 'Calls GenerateSysAppDownloadInfo to obtain download information for IoVCC system applications.', + 'description' => '> Upload your certificate file (.rsa). IoVCC generates a corresponding security image based on the uploaded certificate file and stores it in the system application that you download.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'CreateTrigger' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [ + ['createdAt' => '2024-06-18T02:20:28.000Z', 'description' => 'Error codes changed'], + ], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'iovcc:GenerateSysAppDownloadInfo', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'GetDeviceAppUpdateFunnelEvents' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', - 'systemTags' => [ - 'operationType' => 'create', - ], + 'operationType' => 'read', + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'ProjectId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'PE9FQC48', - ], - ], - [ - 'name' => 'Namespace', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'f323baa35c304751a4b1254adc8230bf', - ], - ], - [ - 'name' => 'Source', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '/', - ], - ], - [ - 'name' => 'FileIds', + 'name' => 'PackageName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '1,2', - ], + 'schema' => ['description' => 'The application package name.', 'type' => 'string', 'required' => false, 'example' => 'com.aliyun.package1', 'title' => ''], ], [ - 'name' => 'FunctionIds', + 'name' => 'ProjectId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '35,36', - ], + 'schema' => ['description' => 'The project ID.', 'type' => 'string', 'required' => true, 'example' => 'P0VFCREU', 'title' => ''], ], [ - 'name' => 'InvocationMode', + 'name' => 'TargetVersionCode', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '0', - ], + 'schema' => ['description' => 'The target version code.', 'type' => 'string', 'required' => false, 'example' => '100', 'title' => ''], ], [ - 'name' => 'Sandbox', + 'name' => 'IdType', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'The device ID type. Valid values:'."\n" + ."\n" + .'- **device_id**: hardware ID'."\n" + .'- **sn**: serial number'."\n" + .'- **vin**: vehicle identification number'."\n" + .'- **hardware_id**: hardware ID.', 'type' => 'string', 'required' => false, 'example' => 'hardware_id', 'title' => ''], ], [ - 'name' => 'Production', + 'name' => 'OriginalId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'The source device ID.', 'type' => 'string', 'required' => false, 'example' => '23452345234523452', 'title' => ''], ], ], 'responses' => [ @@ -11202,60 +8133,97 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '629586FE-CB2E-4742-995E-121F952CEB72', + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '6F25F67C-F411-499F-BCE2-67CA563CB064', 'title' => ''], + 'EventList' => [ + 'description' => 'The list of upgrade progress events.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'PackageName' => ['description' => 'The application package name.', 'type' => 'string', 'example' => 'com.aliyun.package1', 'title' => ''], + 'DeviceId' => ['description' => 'The cloud device ID.', 'type' => 'string', 'example' => 'AS23DG23SA5D43GA34SD23GW456E', 'title' => ''], + 'TargetVersionCode' => ['description' => 'The target version code for the upgrade.', 'type' => 'string', 'example' => '2005680', 'title' => ''], + 'Event' => ['description' => 'The event name.', 'type' => 'string', 'example' => 'os_download_succ', 'title' => ''], + 'ReportTimestamp' => ['description' => 'The report timestamp.', 'type' => 'integer', 'format' => 'int64', 'example' => '16834500000', 'title' => ''], + 'ReportTime' => ['description' => 'The event report time.', 'type' => 'string', 'example' => '2018-02-14 14:20:18', 'title' => ''], + 'TenantId' => ['description' => 'The project ID.', 'type' => 'string', 'example' => 'P0VFCREU', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"629586FE-CB2E-4742-995E-121F952CEB72\\"\\n}","errorExample":"{\\n \\"RequestId\\": \\"6F25F67C-F411-499F-BCE2-67CA563CB064\\",\\n \\"HostId\\": \\"iovcc.cn-shanghai.aliyuncs.com\\",\\n \\"Code\\": \\"InvalidTenant\\",\\n \\"Message\\": \\"User is not a valid tenant\\"\\n}"},{"type":"xml","example":"<CreateTriggerResponse>\\r\\n <RequestId>629586FE-CB2E-4742-995E-121F952CEB72</RequestId>\\r\\n</CreateTriggerResponse>","errorExample":""}]', - 'title' => 'CreateTrigger', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6F25F67C-F411-499F-BCE2-67CA563CB064\\",\\n \\"EventList\\": [\\n {\\n \\"PackageName\\": \\"com.aliyun.package1\\",\\n \\"DeviceId\\": \\"AS23DG23SA5D43GA34SD23GW456E\\",\\n \\"TargetVersionCode\\": \\"2005680\\",\\n \\"Event\\": \\"os_download_succ\\",\\n \\"ReportTimestamp\\": 16834500000,\\n \\"ReportTime\\": \\"2018-02-14 14:20:18\\",\\n \\"TenantId\\": \\"P0VFCREU\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'Retrieve device application upgrade progress information', + 'summary' => 'Calls GetDeviceAppUpdateFunnelEvents to retrieve the progress information of device application upgrades.', + 'description' => 'For example, whether a version is found, whether the version is downloaded successfully, whether the signature verification is successful, and whether the installation is successful.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'DeleteTrigger' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [ + ['createdAt' => '2024-06-18T02:20:28.000Z', 'description' => 'Error codes changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'iovcc:GetDeviceAppUpdateFunnelEvents', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + ], + 'GetDeviceSystemUpdateFunnelEvents' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', - 'systemTags' => [ - 'operationType' => 'delete', - ], + 'operationType' => 'read', + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ + 'name' => 'OriginalId', + 'in' => 'query', + 'schema' => ['description' => 'The source device ID.', 'type' => 'string', 'required' => false, 'example' => '23452345234523452', 'title' => ''], + ], + [ 'name' => 'ProjectId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'PE9FQC48', - ], + 'schema' => ['description' => 'The project ID.', 'type' => 'string', 'required' => true, 'example' => 'P0VFCREU', 'title' => ''], ], [ - 'name' => 'Id', + 'name' => 'TargetVersion', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1', - ], + 'schema' => ['description' => 'The target system version number.', 'type' => 'string', 'required' => false, 'example' => '2.0.1-R-20180412.0824', 'title' => ''], + ], + [ + 'name' => 'IdType', + 'in' => 'query', + 'schema' => ['description' => 'The device ID type. Valid values:'."\n" + ."\n" + .'- **device_id**: hardware ID'."\n" + .'- **sn**: serial number'."\n" + .'- **vin**: vehicle identification number'."\n" + .'- **hardware_id**: hardware ID.', 'type' => 'string', 'required' => false, 'example' => 'hardware_id', 'title' => ''], ], ], 'responses' => [ @@ -11263,82 +8231,120 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '629586FE-CB2E-4742-995E-121F952CEB72', + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '6F25F67C-F411-499F-BCE2-67CA563CB064', 'title' => ''], + 'EventList' => [ + 'description' => 'The list of upgrade progress events.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'DeviceId' => ['description' => 'The cloud device ID.', 'type' => 'string', 'example' => 'AS23DG23SA5D43GA34SD23GW456E', 'title' => ''], + 'TargetVersion' => ['description' => 'The target system version number for the upgrade.', 'type' => 'string', 'example' => '2.0.1-R-20180412.0824', 'title' => ''], + 'Event' => ['description' => 'The event name.', 'type' => 'string', 'example' => 'os_download_succ', 'title' => ''], + 'ReportTimestamp' => ['description' => 'The report timestamp.', 'type' => 'integer', 'format' => 'int64', 'example' => '167845600000', 'title' => ''], + 'ReportTime' => ['description' => 'The event report time.', 'type' => 'string', 'example' => '2018-02-14 14:20:18', 'title' => ''], + 'TenantId' => ['description' => 'The project ID.', 'type' => 'string', 'example' => 'P0VFCREU', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"629586FE-CB2E-4742-995E-121F952CEB72\\"\\n}","errorExample":"{\\n \\"RequestId\\": \\"6F25F67C-F411-499F-BCE2-67CA563CB064\\",\\n \\"HostId\\": \\"iovcc.cn-shanghai.aliyuncs.com\\",\\n \\"Code\\": \\"InvalidTenant\\",\\n \\"Message\\": \\"User is not a valid tenant\\"\\n}"},{"type":"xml","example":"<DeleteTriggerResponse>\\r\\n\\t<RequestId>629586FE-CB2E-4742-995E-121F952CEB72</RequestId>\\r\\n</DeleteTriggerResponse>","errorExample":""}]', - 'title' => 'DeleteTrigger', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6F25F67C-F411-499F-BCE2-67CA563CB064\\",\\n \\"EventList\\": [\\n {\\n \\"DeviceId\\": \\"AS23DG23SA5D43GA34SD23GW456E\\",\\n \\"TargetVersion\\": \\"2.0.1-R-20180412.0824\\",\\n \\"Event\\": \\"os_download_succ\\",\\n \\"ReportTimestamp\\": 167845600000,\\n \\"ReportTime\\": \\"2018-02-14 14:20:18\\",\\n \\"TenantId\\": \\"P0VFCREU\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'Retrieve device system upgrade progress information', + 'summary' => 'Calls GetDeviceSystemUpdateFunnelEvents to retrieve the progress information of a device system upgrade.', + 'description' => 'For example, whether a version is found, whether the version is downloaded successfully, whether the signature verification is successful, and whether the installation is successful.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'UpdateTrigger' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [ + ['createdAt' => '2024-06-18T02:20:28.000Z', 'description' => 'Error codes changed'], + ], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'iovcc:GetDeviceSystemUpdateFunnelEvents', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'GetNamespaceData' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', - 'systemTags' => [ - 'operationType' => 'update', - ], + 'operationType' => 'read', + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'ProjectId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'PE9FQC48', - ], + 'schema' => ['description' => 'The project ID.', 'type' => 'string', 'required' => true, 'example' => 'PIY3UB0T', 'title' => ''], ], [ - 'name' => 'Id', + 'name' => 'Namespace', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1', - ], + 'schema' => ['description' => 'The unique identifier of the namespace.', 'type' => 'string', 'required' => true, 'example' => 'cc6c29893f2be7d465db44ec7b5d593e', 'title' => ''], ], [ - 'name' => 'Sandbox', + 'name' => 'AuthType', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'The data space partitioning and authentication method.'."\n" + ."\n" + .'- 1: account-based'."\n" + .'- 2: device-based'."\n" + .'- 101: account-and-device-based.', 'type' => 'string', 'required' => true, 'example' => '101', 'title' => ''], ], [ - 'name' => 'Production', + 'name' => 'DeviceIdType', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'The device ID type. Valid values: **uuid**, **sn**, **vin**, and **hardware_id**.'."\n" + ."\n" + .'> This parameter is required when `AuthType=2 or 101`.', 'type' => 'string', 'required' => false, 'example' => 'uuid', 'title' => ''], + ], + [ + 'name' => 'DeviceId', + 'in' => 'query', + 'schema' => ['description' => 'The device ID.', 'type' => 'string', 'required' => false, 'example' => '1ac5e182e9634252a02d442a4d5d16fc', 'title' => ''], + ], + [ + 'name' => 'AccountType', + 'in' => 'query', + 'schema' => ['description' => 'The user ID type.'."\n" + ."\n" + .'- `www.weibo.com`: Weibo'."\n" + .'- `www.openaccount.alios.cn`: AliOS'."\n" + .'- `www.amap.com`: AMAP'."\n" + .'- `www.yundevicedemo.aliyun.com`: YUNDEVICE_DEMO'."\n" + .'- `anonymous`: Anonymous'."\n" + ."\n" + .'> This parameter is required when AuthType=1 or 101.', 'type' => 'string', 'required' => false, 'example' => 'www.weibo.com', 'title' => ''], + ], + [ + 'name' => 'AccountId', + 'in' => 'query', + 'schema' => ['description' => 'The user ID.', 'type' => 'string', 'required' => false, 'example' => '10000', 'title' => ''], ], ], 'responses' => [ @@ -11346,81 +8352,89 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '629586FE-CB2E-4742-995E-121F952CEB72', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'E94C9864-56FB-44AD-AC0C-A1CEFB332254', 'title' => ''], + 'Data' => ['description' => 'The data stored in the namespace.', 'type' => 'string', 'example' => '[{\\"path\\":\\"/\\",\\"content\\":\\"Window\\",\\"children\\":[{\\"path\\":\\"/Window\\",\\"content\\":\\"SunroofSlideCtrl\\",\\"children\\":[{\\"path\\":\\"/Window/SunroofSlideCtrl\\",\\"content\\":\\"val\\",\\"children\\":[{\\"path\\":\\"/Window/SunroofSlideCtrl/val\\",\\"content\\":\\"3\\"}]}]},{\\"path\\":\\"/Window\\",\\"content\\":\\"SunroofTiltCtrl\\",\\"children\\":[{\\"path\\":\\"/Window/SunroofTiltCtrl\\",\\"content\\":\\"val\\",\\"children\\":[{\\"path\\":\\"/Window/SunroofTiltCtrl/val\\",\\"content\\":\\"1\\"}]}]}]}]', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"629586FE-CB2E-4742-995E-121F952CEB72\\"\\n}","errorExample":"{\\n \\"RequestId\\": \\"6F25F67C-F411-499F-BCE2-67CA563CB064\\",\\n \\"HostId\\": \\"iovcc.cn-shanghai.aliyuncs.com\\",\\n \\"Code\\": \\"InvalidTenant\\",\\n \\"Message\\": \\"User is not a valid tenant\\"\\n}"},{"type":"xml","example":"<UpdateTriggerResponse>\\r\\n\\t<RequestId>629586FE-CB2E-4742-995E-121F952CEB72</RequestId>\\r\\n</UpdateTriggerResponse>","errorExample":""}]', - 'title' => 'UpdateTrigger', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E94C9864-56FB-44AD-AC0C-A1CEFB332254\\",\\n \\"Data\\": \\"[{\\\\\\\\\\\\\\"path\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"/\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"content\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"Window\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"children\\\\\\\\\\\\\\":[{\\\\\\\\\\\\\\"path\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"/Window\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"content\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"SunroofSlideCtrl\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"children\\\\\\\\\\\\\\":[{\\\\\\\\\\\\\\"path\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"/Window/SunroofSlideCtrl\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"content\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"val\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"children\\\\\\\\\\\\\\":[{\\\\\\\\\\\\\\"path\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"/Window/SunroofSlideCtrl/val\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"content\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"3\\\\\\\\\\\\\\"}]}]},{\\\\\\\\\\\\\\"path\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"/Window\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"content\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"SunroofTiltCtrl\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"children\\\\\\\\\\\\\\":[{\\\\\\\\\\\\\\"path\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"/Window/SunroofTiltCtrl\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"content\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"val\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"children\\\\\\\\\\\\\\":[{\\\\\\\\\\\\\\"path\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"/Window/SunroofTiltCtrl/val\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"content\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"1\\\\\\\\\\\\\\"}]}]}]}]\\"\\n}","type":"json"}]', + 'title' => 'Query data stored in a namespace', + 'summary' => 'Queries data stored in a namespace by calling GetNamespaceData.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'ListTriggers' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [ + ['createdAt' => '2024-06-18T02:20:28.000Z', 'description' => 'Error codes changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'iovcc:GetNamespaceData', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + ], + 'GetNamespaceStatisticsData' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'ProjectId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'PE9FQC48', - ], + 'schema' => ['description' => 'The project ID.', 'type' => 'string', 'required' => true, 'example' => 'PIY3UB0T', 'title' => ''], ], [ 'name' => 'Namespace', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'f323baa35c304751a4b1254adc8230bf', - ], + 'schema' => ['description' => 'The unique identifier of the namespace.', 'type' => 'string', 'required' => true, 'example' => 'cc6c29893f2be7d465db44ec7b5d593e', 'title' => ''], ], [ - 'name' => 'PageIndex', + 'name' => 'DimensionType', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'The statistical dimension type.'."\n" + ."\n" + .'- **101**: daily active users'."\n" + .'- **102**: daily active devices'."\n" + .'- **103**: data submission count'."\n" + .'- **111**: per-minute user access count'."\n" + .'- **112**: per-minute device access count'."\n" + .'- **113**: per-minute data submission count.', 'type' => 'string', 'required' => true, 'example' => '101', 'title' => ''], ], [ - 'name' => 'PageSize', + 'name' => 'StartTime', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], + 'schema' => ['description' => 'The start time.'."\n" + ."\n" + .'- For daily statistics, such as 2018-08-16.'."\n" + .'- For per-minute statistics, such as 2018-08-23 13:53.', 'type' => 'string', 'required' => false, 'example' => '2018-09-20', 'title' => ''], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => ['description' => 'The end time.'."\n" + ."\n" + .'- For daily statistics, such as 2018-08-16.'."\n" + .'- For per-minute statistics, such as 2018-08-23 13:53.', 'type' => 'string', 'required' => false, 'example' => '2018-09-18', 'title' => ''], ], ], 'responses' => [ @@ -11428,229 +8442,97 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '629586FE-CB2E-4742-995E-121F952CEB72', - ], - 'TriggerList' => [ - 'description' => '', + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'E94C9864-56FB-44AD-AC0C-A1CEFB332254', 'title' => ''], + 'Statistics' => [ + 'description' => 'The statistics result.', 'type' => 'object', 'properties' => [ - 'Pagination' => [ + 'Categories' => [ + 'type' => 'array', + 'items' => ['description' => 'The statistical category.', 'type' => 'integer', 'format' => 'int64', 'example' => '["1534907280000","1534907340000","1534907400000"]', 'title' => ''], 'description' => '', - 'type' => 'object', - 'properties' => [ - 'PageIndex' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'TotalPageCount' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - 'PageSize' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'TotalCount' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '11', - ], - ], + 'title' => '', + 'example' => '', ], - 'Triggers' => [ - 'description' => '', + 'Series' => [ + 'description' => 'The statistics data.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'Status' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - 'Type' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'Production' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'Functions' => [ - 'description' => '', + 'Data' => [ 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'GmtCreate' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1535872636000', - ], - 'FileName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'hello.zip', - ], - 'Name' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'someFunc', - ], - 'GmtModified' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1535872636000', - ], - 'Id' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'FileId' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - ], - ], - ], - 'Sandbox' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'Namespace' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'f323baa35c304751a4b1254adc8230bf', - ], - 'GmtModified' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1535873636000', - ], - 'Source' => [ - 'description' => '', - 'type' => 'string', - 'example' => '/', - ], - 'ChainedFunctionIds' => [ + 'items' => ['description' => 'The statistics data result. Each data item corresponds to each item in Categories in order.', 'type' => 'integer', 'format' => 'int64', 'example' => '[1,10,5]', 'title' => ''], 'description' => '', - 'type' => 'string', - 'example' => '/', - ], - 'GmtCreate' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1535873636000', - ], - 'InvocationMode' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'Id' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', + 'title' => '', + 'example' => '', ], + 'Name' => ['description' => 'The name of the statistics data.', 'type' => 'string', 'example' => '设备访问次数', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"629586FE-CB2E-4742-995E-121F952CEB72\\",\\n \\"TriggerList\\": {\\n \\"Triggers\\": [\\n {\\n \\"Status\\": 2,\\n \\"Type\\": 0,\\n \\"Production\\": 1,\\n \\"ChainedFunctionIds\\": \\"/\\",\\n \\"GmtCreate\\": 1535873636000,\\n \\"Sandbox\\": 1,\\n \\"Namespace\\": \\"f323baa35c304751a4b1254adc8230bf\\",\\n \\"GmtModified\\": 1535873636000,\\n \\"Source\\": \\"/\\",\\n \\"InvocationMode\\": 0,\\n \\"Id\\": 1,\\n \\"Functions\\": [\\n {\\n \\"GmtCreate\\": 1535872636000,\\n \\"FileName\\": \\"hello.zip\\",\\n \\"Name\\": \\"someFunc\\",\\n \\"GmtModified\\": 1535872636000,\\n \\"Id\\": 1,\\n \\"FileId\\": 1\\n }\\n ]\\n }\\n ],\\n \\"Pagination\\": {\\n \\"PageIndex\\": 1,\\n \\"TotalPageCount\\": 2,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 11\\n }\\n }\\n}","errorExample":"{\\n \\"RequestId\\": \\"6F25F67C-F411-499F-BCE2-67CA563CB064\\",\\n \\"HostId\\": \\"iovcc.cn-shanghai.aliyuncs.com\\",\\n \\"Code\\": \\"InvalidTenant\\",\\n \\"Message\\": \\"User is not a valid tenant\\"\\n}"},{"type":"xml","example":"<ListTriggersResponse>\\r\\n\\t<RequestId>629586FE-CB2E-4742-995E-121F952CEB72</RequestId>\\r\\n\\t<TriggerList>\\r\\n\\t\\t<Pagination>\\r\\n\\t\\t\\t<PageIndex>1</PageIndex>\\r\\n\\t\\t\\t<PageSize>10</PageSize>\\r\\n\\t\\t\\t<TotalCount>2</TotalCount>\\r\\n\\t\\t\\t<TotalPageCount>1</TotalPageCount>\\r\\n\\t\\t</Pagination>\\r\\n\\t\\t<Triggers>\\r\\n\\t\\t\\t<Functions>\\r\\n\\t\\t\\t\\t<FileId>46</FileId>\\r\\n\\t\\t\\t\\t<FileName>hello.zip</FileName>\\r\\n\\t\\t\\t\\t<GmtCreate>1536201206000</GmtCreate>\\r\\n\\t\\t\\t\\t<GmtModified>1536201206000</GmtModified>\\r\\n\\t\\t\\t\\t<Id>36</Id>\\r\\n\\t\\t\\t\\t<Name>someFunc</Name>\\r\\n\\t\\t\\t</Functions>\\r\\n\\t\\t\\t<GmtCreate>1537154684000</GmtCreate>\\r\\n\\t\\t\\t<GmtModified>1537154684000</GmtModified>\\r\\n\\t\\t\\t<Id>2533</Id>\\r\\n\\t\\t\\t<InvocationMode>0</InvocationMode>\\r\\n\\t\\t\\t<Namespace>f323baa35c304751a4b1254adc8230bf</Namespace>\\r\\n\\t\\t\\t<Production>1</Production>\\r\\n\\t\\t\\t<Sandbox>1</Sandbox>\\r\\n\\t\\t\\t<Source>/</Source>\\r\\n\\t\\t\\t<Status>2</Status>\\r\\n\\t\\t\\t<Type>0</Type>\\r\\n\\t\\t</Triggers>\\r\\n\\t</TriggerList>\\r\\n</ListTriggersResponse>","errorExample":""}]', - 'title' => 'ListTriggers', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E94C9864-56FB-44AD-AC0C-A1CEFB332254\\",\\n \\"Statistics\\": {\\n \\"Categories\\": [\\n 0\\n ],\\n \\"Series\\": [\\n {\\n \\"Data\\": [\\n 0\\n ],\\n \\"Name\\": \\"设备访问次数\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'Query namespace business statistics', + 'summary' => 'Queries the business statistics of a namespace by calling GetNamespaceStatisticsData.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'AddVersionGroupDevices' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [ + ['createdAt' => '2021-05-26T12:50:16.000Z', 'description' => 'OpenAPI offline'], ], - 'schemes' => [ - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'iovcc:GetNamespaceStatisticsData', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + ], + 'GetOssUploadMeta' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', - 'systemTags' => [ - 'operationType' => 'create', - ], + 'operationType' => 'read', + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'DeviceIdType', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'sn', - ], - ], - [ 'name' => 'ProjectId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'P0VFCREU', - ], + 'schema' => ['description' => 'The ID of the project.', 'type' => 'string', 'required' => true, 'example' => 'P0VFCREU', 'title' => ''], ], [ - 'name' => 'DeviceIds', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '"b8fe2e24ff2b48e0a3aa4e49809fc1b3","b8f12e24ff2b48e0a3aa4e49809fc1b3"', - ], - ], - [ - 'name' => 'DeviceGroupId', + 'name' => 'Ext', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '1', - ], + 'schema' => ['description' => 'The file name extension.', 'type' => 'string', 'required' => true, 'example' => 'zip', 'title' => ''], ], ], 'responses' => [ @@ -11658,88 +8540,92 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '6F25F67C-F411-499F-BCE2-67CA563CB064', + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '6F25F67C-F411-499F-BCE2-67CA563CB064', 'title' => ''], + 'OssUploadMeta' => [ + 'description' => 'The information required for the upload.', + 'type' => 'object', + 'properties' => [ + 'AccessKey' => ['description' => 'The information required for the upload.', 'type' => 'string', 'example' => 'STS.xxxxxxxxxxx', 'title' => ''], + 'Signature' => ['description' => 'The signature.', 'type' => 'string', 'example' => 'xxxxxxxxxxxx=', 'title' => ''], + 'Host' => ['description' => 'The address of the OSS server for the upload.', 'type' => 'string', 'example' => 'http://xxxxxx.oss-cn-shanghai.aliyuncs.com', 'title' => ''], + 'Policy' => ['description' => 'The OSS upload policy.', 'type' => 'string', 'example' => 'xxxxxxxxxxxxxx', 'title' => ''], + 'SecurityToken' => ['description' => 'STS token', 'type' => 'string', 'example' => 'xxxxxxxxxxxxxx', 'title' => ''], + 'ObjectKey' => ['description' => 'The destination path of the uploaded file.', 'type' => 'string', 'example' => '11/1527911483513.zip', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"6F25F67C-F411-499F-BCE2-67CA563CB064\\"\\n}","errorExample":"{\\n \\"RequestId\\": \\"6F25F67C-F411-499F-BCE2-67CA563CB064\\",\\n \\"HostId\\": \\"iovcc.cn-shanghai.aliyuncs.com\\",\\n \\"Code\\": \\"NoPermissionToAccessProject\\",\\n \\"Message\\": \\"User is not authorized to access the specified project.\\"\\n}"},{"type":"xml","example":"<AddVersionGroupDevicesResponse>\\r\\n\\t<RequestId>6F25F67C-F411-499F-BCE2-67CA563CB064</RequestId>\\r\\n</AddVersionGroupDevicesResponse>","errorExample":""}]', - 'title' => 'AddVersionGroupDevices', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6F25F67C-F411-499F-BCE2-67CA563CB064\\",\\n \\"OssUploadMeta\\": {\\n \\"AccessKey\\": \\"STS.xxxxxxxxxxx\\",\\n \\"Signature\\": \\"xxxxxxxxxxxx=\\",\\n \\"Host\\": \\"http://xxxxxx.oss-cn-shanghai.aliyuncs.com\\",\\n \\"Policy\\": \\"xxxxxxxxxxxxxx\\",\\n \\"SecurityToken\\": \\"xxxxxxxxxxxxxx\\",\\n \\"ObjectKey\\": \\"11/1527911483513.zip\\"\\n }\\n}","type":"json"}]', + 'title' => 'Retrieve information required to upload an upgrade package to OSS', + 'summary' => 'Retrieves the STS token, policy, and other information required to upload an upgrade package to OSS.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'AddVersionWhiteDevices' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [ + ['createdAt' => '2024-06-18T02:20:28.000Z', 'description' => 'Error codes changed'], ], - 'schemes' => [ - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'iovcc:GetOssUploadMeta', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + ], + 'InvokeFunction' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', - 'systemTags' => [ - 'operationType' => 'create', - ], + 'operationType' => 'readAndWrite', + 'systemTags' => ['operationType' => 'create'], 'parameters' => [ [ - 'name' => 'DeviceIds', + 'name' => 'ProjectId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '11,22,33', - ], + 'schema' => ['description' => 'The project ID.', 'type' => 'string', 'required' => true, 'example' => 'PE9FQC48', 'title' => ''], ], [ - 'name' => 'ProjectId', + 'name' => 'FileId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'P0VFCREU', - ], + 'schema' => ['description' => 'The function file ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1', 'title' => ''], ], [ - 'name' => 'VersionType', + 'name' => 'FunctionName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'FOTA', - ], + 'schema' => ['description' => 'The function name.', 'type' => 'string', 'required' => true, 'example' => 'someFunc', 'title' => ''], ], [ - 'name' => 'DeviceIdType', + 'name' => 'Env', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'hardware_id', - ], + 'schema' => ['description' => 'The environment in which the function is deployed. Valid values:'."\n" + ."\n" + .'- 0: sandbox environment.'."\n" + .'- 1: production environment.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '0', 'title' => ''], ], [ - 'name' => 'VersionId', + 'name' => 'Parameters', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '12345', - ], + 'schema' => ['description' => 'The input parameters for the function invocation.', 'type' => 'string', 'required' => true, 'example' => '{"key":"value"}', 'title' => ''], ], ], 'responses' => [ @@ -11747,83 +8633,147 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '6F25F67C-F411-499F-BCE2-67CA563CB064', + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '629586FE-CB2E-4742-995E-121F952CEB72', 'title' => ''], + 'Result' => [ + 'description' => 'The returned result.', + 'type' => 'object', + 'properties' => [ + 'Output' => ['description' => 'The standard output of the function execution.', 'type' => 'string', 'example' => 'hello, bla bla bla...', 'title' => ''], + 'BackEndRequestId' => ['description' => 'The request ID of the call made by the backend runtime environment.', 'type' => 'string', 'example' => '54117932-59f1-4955-7a26-0c96962fd645', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"6F25F67C-F411-499F-BCE2-67CA563CB064\\"\\n}","errorExample":"{\\n \\"RequestId\\": \\"6F25F67C-F411-499F-BCE2-67CA563CB064\\",\\n \\"HostId\\": \\"iovcc.cn-shanghai.aliyuncs.com\\",\\n \\"Code\\": \\"NoPermissionToAccessProject\\",\\n \\"Message\\": \\"User is not authorized to access the specified project.\\"\\n}"},{"type":"xml","example":"<AddVersionWhiteDevicesResponse>\\r\\n\\t<RequestId>6F25F67C-F411-499F-BCE2-67CA563CB064</RequestId>\\r\\n</AddVersionWhiteDevicesResponse>","errorExample":""}]', - 'title' => 'AddVersionWhiteDevices', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"629586FE-CB2E-4742-995E-121F952CEB72\\",\\n \\"Result\\": {\\n \\"Output\\": \\"hello, bla bla bla...\\",\\n \\"BackEndRequestId\\": \\"54117932-59f1-4955-7a26-0c96962fd645\\"\\n }\\n}","type":"json"}]', + 'title' => 'Invoke a function', + 'summary' => 'Invokes a function by using InvokeFunction.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'AddVersionWhiteDevicesByDeviceGroups' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [ + ['createdAt' => '2024-06-18T02:20:28.000Z', 'description' => 'Error codes changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'iovcc:InvokeFunction', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + ], + 'ListApiGatewayApps' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', - 'systemTags' => [ - 'operationType' => 'create', - ], + 'operationType' => 'read', + 'systemTags' => ['operationType' => 'list'], 'parameters' => [ [ 'name' => 'ProjectId', 'in' => 'query', + 'schema' => ['description' => 'The project ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '11', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'ApiGatewayApps' => [ + 'description' => 'The information about associated gateway apps.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'GatewayAppKey' => ['description' => 'The AppKey of the API Gateway application.', 'type' => 'string', 'example' => '24659924', 'title' => ''], + 'Status' => ['description' => 'The status. Valid values:'."\n" + .'- 0: Normal.'."\n" + .'- 1: Disabled.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'GatewayAppSecret' => ['description' => 'The AppSecret of the API Gateway application. The API does not return the complete AppSecret. Only the first and last few characters are displayed.', 'type' => 'string', 'example' => 'a******1', 'title' => ''], + 'GatewayAppId' => ['description' => 'The API Gateway application ID.', 'type' => 'string', 'example' => '1111111', 'title' => ''], + 'UserId' => ['description' => 'The ID of the user to whom the application belongs.', 'type' => 'string', 'example' => '1768723179523459', 'title' => ''], + 'ProjectId' => ['description' => 'The project ID.', 'type' => 'string', 'example' => '11', 'title' => ''], + 'GmtCreate' => ['description' => 'The time when the application was created.', 'type' => 'integer', 'format' => 'int64', 'example' => '1508400744000', 'title' => ''], + 'GmtModified' => ['description' => 'The time when the application was last modified.', 'type' => 'integer', 'format' => 'int64', 'example' => '1525340035000', 'title' => ''], + 'Id' => ['description' => 'The primary key ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '8', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '9CC2A1F1-DAE4-47DA-A682-240AF2DEED84', 'title' => ''], + ], 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'UEWE232', + 'title' => '', + 'example' => '', ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"ApiGatewayApps\\": [\\n {\\n \\"GatewayAppKey\\": \\"24659924\\",\\n \\"Status\\": 0,\\n \\"GatewayAppSecret\\": \\"a******1\\",\\n \\"GatewayAppId\\": \\"1111111\\",\\n \\"UserId\\": \\"1768723179523459\\",\\n \\"ProjectId\\": \\"11\\",\\n \\"GmtCreate\\": 1508400744000,\\n \\"GmtModified\\": 1525340035000,\\n \\"Id\\": 8\\n }\\n ],\\n \\"RequestId\\": \\"9CC2A1F1-DAE4-47DA-A682-240AF2DEED84\\"\\n}","type":"json"}]', + 'title' => 'Query gateway app information associated with a project', + 'summary' => 'Queries the information about gateway apps associated with a project by calling ListApiGatewayApps.', + 'description' => '> Currently, only one gateway app can be associated.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2024-06-18T02:20:28.000Z', 'description' => 'Error codes changed'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ [ - 'name' => 'VersionType', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'FOTA', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'iovcc:ListApiGatewayApps', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + ], + 'ListApps' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'GroupIds', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '12', - ], + 'AK' => [], ], + ], + 'operationType' => 'read', + 'systemTags' => ['operationType' => 'list'], + 'parameters' => [ [ - 'name' => 'VersionId', + 'name' => 'ProjectId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '12323', - ], + 'schema' => ['description' => 'The ID of the IoVCC project.', 'type' => 'string', 'required' => true, 'example' => 'PV37HJ8Q', 'title' => ''], ], ], 'responses' => [ @@ -11831,84 +8781,82 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '6F25F67C-F411-499F-BCE2-67CA563CB064', - ], - 'Data' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'success', + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '629586FE-CB2E-4742-995E-121F952CEB72', 'title' => ''], + 'Apps' => [ + 'description' => 'The list of custom application objects.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'AppName' => ['description' => 'The application name.', 'type' => 'string', 'example' => 'app_test', 'title' => ''], + 'AppKey' => ['description' => 'The application key.', 'type' => 'string', 'example' => 'ZBjeuffe', 'title' => ''], + 'OsType' => ['description' => 'The operating system type on which the application runs. Valid values:'."\n" + ."\n" + .'- 0: YunOS'."\n" + .'- 1: Android'."\n" + .'- 2: iOS.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'AppPackage' => ['description' => 'The application package name.', 'type' => 'string', 'example' => 'com.aliyun.test', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Data\\": \\"success\\",\\n \\"RequestId\\": \\"6F25F67C-F411-499F-BCE2-67CA563CB064\\"\\n}","errorExample":""},{"type":"xml","example":"<RequestId>6F25F67C-F411-499F-BCE2-67CA563CB064</RequestId>\\n<Data>success</Data>","errorExample":""}]', - 'title' => 'AddVersionWhiteDevicesByDeviceGroups', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"629586FE-CB2E-4742-995E-121F952CEB72\\",\\n \\"Apps\\": [\\n {\\n \\"AppName\\": \\"app_test\\",\\n \\"AppKey\\": \\"ZBjeuffe\\",\\n \\"OsType\\": 1,\\n \\"AppPackage\\": \\"com.aliyun.test\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'Retrieve application list under a project', + 'summary' => 'Retrieves the list of applications under a project by project ID.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'CreateDeviceBrand' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [ + ['createdAt' => '2024-06-18T02:20:28.000Z', 'description' => 'Error codes changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'iovcc:ListApps', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + ], + 'ListAssistActionDetails' => [ + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', - 'systemTags' => [ - 'operationType' => 'create', - ], + 'operationType' => 'read', + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'ProjectId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'projectTest', - ], - ], - [ - 'name' => 'BrandName', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'TmallGenius', - ], - ], - [ - 'name' => 'Manufacture', + 'name' => 'ActionTimestamp', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'Alibaba', - ], + 'schema' => ['description' => 'The timestamp ID of the action.', 'type' => 'string', 'required' => true, 'example' => '1524560714502LwoJKfp', 'title' => ''], ], [ - 'name' => 'Description', + 'name' => 'ProjectId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '', - ], + 'schema' => ['description' => 'The project ID.', 'type' => 'string', 'required' => true, 'example' => 'PZ1HK7JZ', 'title' => ''], ], ], 'responses' => [ @@ -11916,165 +8864,187 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '9c7a3b09-a69a-43f5-8bf2-84f7119810eb', - ], - 'BrandId' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '9c7a3b09-a69a-43f5-8bf2-84f7119810eb', 'title' => ''], + 'Results' => [ + 'description' => 'The list of action details.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Type' => ['description' => 'The action type.', 'type' => 'string', 'example' => 'event', 'title' => ''], + 'Action' => ['description' => 'The action.', 'type' => 'string', 'example' => 'top', 'title' => ''], + 'Data' => ['description' => 'The action result.', 'type' => 'string', 'example' => 'Processes: 331 total, 2 running, 329 sleeping, 1936 threads', 'title' => ''], + 'DeviceId' => ['description' => 'The device ID.', 'type' => 'string', 'example' => '37aac8e7d96c42ea94fd5408e351474e', 'title' => ''], + 'CreatedAt' => ['description' => 'The time when the action was created.', 'type' => 'integer', 'format' => 'int64', 'example' => '1525767660000', 'title' => ''], + 'UpdatedAt' => ['description' => 'The time when the action was last updated.', 'type' => 'integer', 'format' => 'int64', 'example' => '1525767660000', 'title' => ''], + 'Timestamp' => ['description' => 'The timestamp ID of the action.', 'type' => 'string', 'example' => '1525398712826BdAw5KN', 'title' => ''], + 'ID' => ['description' => 'The action ID.', 'type' => 'string', 'example' => '40475', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"BrandId\\": 1,\\n \\"RequestId\\": \\"9c7a3b09-a69a-43f5-8bf2-84f7119810eb\\"\\n}","errorExample":"{\\n \\"Code\\":\\"NoPermissionToAccessProject\\",\\n \\"HostId\\":\\"iovcc.cn-shanghai.aliyuncs.com\\",\\n \\"Message\\":\\"User is not authorized to access the specified project.\\",\\n \\"RequestId\\":\\"6F25F67C-F411-499F-BCE2-67CA563CB064\\"\\n}"},{"type":"xml","example":"<CreateDeviceBrandResponse>\\r\\n\\t<RequestId>E94C9864-56FB-44AD-AC0C-A1CEFB332254</RequestId>\\r\\n\\t<BrandId>1</BrandId>\\r\\n</CreateDeviceBrandResponse>","errorExample":""}]', - 'title' => 'CreateDeviceBrand', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9c7a3b09-a69a-43f5-8bf2-84f7119810eb\\",\\n \\"Results\\": [\\n {\\n \\"Type\\": \\"event\\",\\n \\"Action\\": \\"top\\",\\n \\"Data\\": \\"Processes: 331 total, 2 running, 329 sleeping, 1936 threads\\",\\n \\"DeviceId\\": \\"37aac8e7d96c42ea94fd5408e351474e\\",\\n \\"CreatedAt\\": 1525767660000,\\n \\"UpdatedAt\\": 1525767660000,\\n \\"Timestamp\\": \\"1525398712826BdAw5KN\\",\\n \\"ID\\": \\"40475\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'Retrieve details of a specified diagnostic action', + 'summary' => 'Calls ListAssistActionDetails to retrieve the details of a specified diagnostic action.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'CreateDeviceModel' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [ + ['createdAt' => '2024-06-18T02:20:27.000Z', 'description' => 'Error codes changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'iovcc:ListAssistActionDetails', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'ListAssistDevices' => [ + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', - 'systemTags' => [ - 'operationType' => 'create', - ], + 'operationType' => 'read', + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'InitUsageType', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '0', - ], - ], - [ - 'name' => 'CanCreateDeviceId', + 'name' => 'ProjectId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'true', - ], + 'schema' => ['description' => 'The project ID.', 'type' => 'string', 'required' => true, 'example' => 'PZ1HK7JZ', 'title' => ''], ], [ - 'name' => 'ModelName', + 'name' => 'PageIndex', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'X1', - ], + 'schema' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1', 'title' => ''], ], [ - 'name' => 'HardwareType', + 'name' => 'Condition', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'sn', - ], + 'schema' => ['description' => 'The query condition.', 'type' => 'string', 'required' => false, 'example' => '{"vin":"LVFAG7A31HK000029"}', 'title' => ''], ], [ - 'name' => 'BrandName', + 'name' => 'PerPage', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'TmallGenius', - ], + 'schema' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '20', 'title' => ''], ], - [ - 'name' => 'Description', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TotalCount' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '35', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '9c7a3b09-a69a-43f5-8bf2-84f7119810eb', 'title' => ''], + 'PerPage' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''], + 'PageIndex' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'Devices' => [ + 'description' => 'The list of devices.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'SerialNumber' => ['description' => 'The serial number.', 'type' => 'string', 'example' => 'DX3JNY1FDTD2', 'title' => ''], + 'HardwareId' => ['description' => 'The hardware ID.', 'type' => 'string', 'example' => 'BALFL8429HI', 'title' => ''], + 'DeviceName' => ['description' => 'The device name.', 'type' => 'string', 'example' => 'Model S', 'title' => ''], + 'AccessTime' => ['description' => 'The device access time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1525767660000', 'title' => ''], + 'DeviceId' => ['description' => 'The device ID.', 'type' => 'string', 'example' => '6fde56979c484b93b99fba257e3cbe83', 'title' => ''], + 'UUID' => ['description' => 'The AliOS device UUID.', 'type' => 'string', 'example' => '842972B2C0F4C9F030E60769CA65806A', 'title' => ''], + 'VIN' => ['description' => 'The Vehicle Identification Number (VIN).', 'type' => 'string', 'example' => 'LVFAG7A31HK000029', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], 'description' => '', - 'type' => 'string', - 'required' => false, + 'title' => '', 'example' => '', ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalCount\\": 35,\\n \\"RequestId\\": \\"9c7a3b09-a69a-43f5-8bf2-84f7119810eb\\",\\n \\"PerPage\\": 20,\\n \\"PageIndex\\": 1,\\n \\"Devices\\": [\\n {\\n \\"SerialNumber\\": \\"DX3JNY1FDTD2\\",\\n \\"HardwareId\\": \\"BALFL8429HI\\",\\n \\"DeviceName\\": \\"Model S\\",\\n \\"AccessTime\\": 1525767660000,\\n \\"DeviceId\\": \\"6fde56979c484b93b99fba257e3cbe83\\",\\n \\"UUID\\": \\"842972B2C0F4C9F030E60769CA65806A\\",\\n \\"VIN\\": \\"LVFAG7A31HK000029\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'Retrieve the list of devices connected to remote diagnostics', + 'summary' => 'Calls ListAssistDevices to retrieve the list of devices connected to remote diagnostics.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2024-06-18T02:20:27.000Z', 'description' => 'Error codes changed'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ [ - 'name' => 'DeviceType', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'iovcc:ListAssistDevices', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + ], + 'ListAssistHistories' => [ + 'methods' => ['get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'ProjectId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'projectTest', - ], + 'AK' => [], ], + ], + 'operationType' => 'read', + 'systemTags' => ['operationType' => 'get'], + 'parameters' => [ [ - 'name' => 'SecurityChip', + 'name' => 'PerPage', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '0', - ], + 'schema' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '20', 'title' => ''], ], [ - 'name' => 'OsPlatform', + 'name' => 'PageIndex', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'android', - ], + 'schema' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1', 'title' => ''], ], [ - 'name' => 'ObjectKey', + 'name' => 'Condition', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '1151125281886341/375KZRO8TARYBQY7P0E4/2019-04-12/1555062240807.jpg', - ], + 'schema' => ['description' => 'The query condition.', 'type' => 'string', 'required' => false, 'example' => '{"vin":"LVFAG7A31HK000029"}', 'title' => ''], ], [ - 'name' => 'DeviceName', + 'name' => 'ProjectId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'device', - ], + 'schema' => ['description' => 'The project ID.', 'type' => 'string', 'required' => true, 'example' => 'PZ1HK7JZ', 'title' => ''], ], ], 'responses' => [ @@ -12082,84 +9052,88 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '9c7a3b09-a69a-43f5-8bf2-84f7119810eb', - ], - 'DeviceModelId' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10', + 'TotalCount' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '46', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '9c7a3b09-a69a-43f5-8bf2-84f7119810eb', 'title' => ''], + 'PerPage' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''], + 'Histories' => [ + 'description' => 'The history list.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'SerialNumber' => ['description' => 'The serial number.', 'type' => 'string', 'example' => 'BALFL8429SN', 'title' => ''], + 'EndTime' => ['description' => 'The end time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1525767680000', 'title' => ''], + 'StartTime' => ['description' => 'The start time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1525767660000', 'title' => ''], + 'UNAME' => ['description' => 'The username of the operator.', 'type' => 'string', 'example' => 'admin', 'title' => ''], + 'HardwareId' => ['description' => 'The hardware ID.', 'type' => 'string', 'example' => 'BALFL8429HI', 'title' => ''], + 'DeviceName' => ['description' => 'The device name.', 'type' => 'string', 'example' => 'Model S', 'title' => ''], + 'UUID' => ['description' => 'The AliOS device UUID.', 'type' => 'string', 'example' => '842972B2C0F4C9F030E60769CA65806A', 'title' => ''], + 'DeviceId' => ['description' => 'The device ID.', 'type' => 'string', 'example' => '6fde56979c484b93b99fba257e3cbe83', 'title' => ''], + 'VIN' => ['description' => 'The vehicle identification number (VIN).', 'type' => 'string', 'example' => 'LHK000026VFAG7A31', 'title' => ''], + 'UID' => ['description' => 'The user ID of the operator.', 'type' => 'string', 'example' => '12345', 'title' => ''], + 'ID' => ['description' => 'The diagnostics session ID.', 'type' => 'string', 'example' => '510', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], + 'PageIndex' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"DeviceModelId\\": 10,\\n \\"RequestId\\": \\"9c7a3b09-a69a-43f5-8bf2-84f7119810eb\\"\\n}","errorExample":"{\\n \\"Code\\":\\"NoPermissionToAccessProject\\",\\n \\"HostId\\":\\"iovcc.cn-shanghai.aliyuncs.com\\",\\n \\"Message\\":\\"User is not authorized to access the specified project.\\",\\n \\"RequestId\\":\\"6F25F67C-F411-499F-BCE2-67CA563CB064\\"\\n}"},{"type":"xml","example":"<CreateDeviceModelResponse>\\r\\n\\t<RequestId>E94C9864-56FB-44AD-AC0C-A1CEFB332254</RequestId>\\r\\n\\t<DeviceModelId>10</DeviceModelId>\\r\\n</CreateDeviceModelResponse>","errorExample":""}]', - 'title' => 'CreateDeviceModel', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalCount\\": 46,\\n \\"RequestId\\": \\"9c7a3b09-a69a-43f5-8bf2-84f7119810eb\\",\\n \\"PerPage\\": 20,\\n \\"Histories\\": [\\n {\\n \\"SerialNumber\\": \\"BALFL8429SN\\",\\n \\"EndTime\\": 1525767680000,\\n \\"StartTime\\": 1525767660000,\\n \\"UNAME\\": \\"admin\\",\\n \\"HardwareId\\": \\"BALFL8429HI\\",\\n \\"DeviceName\\": \\"Model S\\",\\n \\"UUID\\": \\"842972B2C0F4C9F030E60769CA65806A\\",\\n \\"DeviceId\\": \\"6fde56979c484b93b99fba257e3cbe83\\",\\n \\"VIN\\": \\"LHK000026VFAG7A31\\",\\n \\"UID\\": \\"12345\\",\\n \\"ID\\": \\"510\\"\\n }\\n ],\\n \\"PageIndex\\": 1\\n}","type":"json"}]', + 'title' => 'Retrieve remote diagnostics history list', + 'summary' => 'Calls ListAssistHistories to retrieve the list of remote diagnostics history.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'CreateVersionDeviceGroup' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [ + ['createdAt' => '2024-06-18T02:20:27.000Z', 'description' => 'Error codes changed'], ], - 'schemes' => [ - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'iovcc:ListAssistHistories', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + ], + 'ListAssistHistoryDetails' => [ + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', - 'systemTags' => [ - 'operationType' => 'create', - ], + 'operationType' => 'read', + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'MaxCount', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '100', - ], - ], - [ 'name' => 'ProjectId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'P0VFCREU', - ], + 'schema' => ['description' => 'The project ID.', 'type' => 'string', 'required' => true, 'example' => 'PZ1HK7JZ', 'title' => ''], ], [ - 'name' => 'Name', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '', - ], - ], - [ - 'name' => 'Description', + 'name' => 'AssistId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '', - ], + 'schema' => ['description' => 'The diagnostic session ID.', 'type' => 'string', 'required' => true, 'example' => '510', 'title' => ''], ], ], 'responses' => [ @@ -12167,63 +9141,81 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '6F25F67C-F411-499F-BCE2-67CA563CB064', - ], - 'DeviceGroupId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '1', + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '9c7a3b09-a69a-43f5-8bf2-84f7119810eb', 'title' => ''], + 'Actions' => [ + 'description' => 'The list of operations.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Action' => ['description' => 'The operation.', 'type' => 'string', 'example' => 'top', 'title' => ''], + 'CreatedAt' => ['description' => 'The time when the operation was created.', 'type' => 'integer', 'format' => 'int64', 'example' => '1525767660000', 'title' => ''], + 'Timestamp' => ['description' => 'The timestamp ID of the operation.', 'type' => 'string', 'example' => '1524560987853KrvUfI1', 'title' => ''], + 'UpdatedAt' => ['description' => 'The time when the operation was updated.', 'type' => 'integer', 'format' => 'int64', 'example' => '1525767660000', 'title' => ''], + 'AssistId' => ['description' => 'The diagnostic session ID.', 'type' => 'string', 'example' => '510', 'title' => ''], + 'ID' => ['description' => 'The operation ID.', 'type' => 'string', 'example' => '40475', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"DeviceGroupId\\": \\"1\\",\\n \\"RequestId\\": \\"6F25F67C-F411-499F-BCE2-67CA563CB064\\"\\n}","errorExample":"{\\n \\"RequestId\\": \\"6F25F67C-F411-499F-BCE2-67CA563CB064\\",\\n \\"HostId\\": \\"iovcc.cn-shanghai.aliyuncs.com\\",\\n \\"Code\\": \\"NoPermissionToAccessProject\\",\\n \\"Message\\": \\"User is not authorized to access the specified project.\\"\\n}"},{"type":"xml","example":"<CreateVersionDeviceGroupResponse>\\r\\n\\t<RequestId>6F25F67C-F411-499F-BCE2-67CA563CB064</RequestId>\\r\\n\\t<DeviceGroupId>1</DeviceGroupId>\\r\\n</CreateVersionDeviceGroupResponse>","errorExample":""}]', - 'title' => 'CreateVersionDeviceGroup', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9c7a3b09-a69a-43f5-8bf2-84f7119810eb\\",\\n \\"Actions\\": [\\n {\\n \\"Action\\": \\"top\\",\\n \\"CreatedAt\\": 1525767660000,\\n \\"Timestamp\\": \\"1524560987853KrvUfI1\\",\\n \\"UpdatedAt\\": 1525767660000,\\n \\"AssistId\\": \\"510\\",\\n \\"ID\\": \\"40475\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'Retrieve details of a specified diagnostic history', + 'summary' => 'Retrieves the details of a specified diagnostic history, including the list of executed commands.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'DeleteAllVersionGroupDevices' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [ + ['createdAt' => '2024-06-18T02:20:27.000Z', 'description' => 'Error codes changed'], + ], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'iovcc:ListAssistHistoryDetails', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'ListClientPluginVersions' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', - 'systemTags' => [ - 'operationType' => 'delete', - ], + 'operationType' => 'read', + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'ProjectId', + 'name' => 'OsType', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'P0VFCREU', - ], + 'schema' => ['description' => 'The operating system type. Valid values:'."\n" + .'- 1: Android.', 'type' => 'string', 'required' => true, 'example' => '1', 'title' => ''], ], [ - 'name' => 'DeviceGroupId', + 'name' => 'PkgName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '1', - ], + 'schema' => ['description' => 'The plugin package name.', 'type' => 'string', 'required' => true, 'example' => 'com.aliyun.aicc.yundevice', 'title' => ''], ], ], 'responses' => [ @@ -12231,59 +9223,76 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '6F25F67C-F411-499F-BCE2-67CA563CB064', + 'ClientPluginVersions' => [ + 'description' => 'The client plugin version information.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Version' => ['description' => 'The version name.', 'type' => 'string', 'example' => '1.1.1.20180103102554-3', 'title' => ''], + 'DownloadUrl' => ['description' => 'The download URL.', 'type' => 'string', 'example' => 'http://xxxxx.oss-cn-shanghai.aliyuncs.com/1046834015363116/xxx/2019-09-17/1568704641998-com.aliyun.aicc-1.2-36-g4e4b62e.apk?spm=5176.11279587.0.0.f7944f48XVfS6a&Expires=1568708242&OSSAccessKeyId=xxxx&Signature=xxx%3D&response-content-disposition=attachment%3Bfilename%3Dcom.aliyun.aicc-1.2-36-g4e4b62e.apk%3Bfilename%2A%3DUTF-8%27%27com.aliyun.aicc-1.2-36-g4e4b62e.apk', 'title' => ''], + 'Size' => ['description' => 'The plugin package size. Unit: bytes.', 'type' => 'integer', 'format' => 'int64', 'example' => '743503', 'title' => ''], + 'PkgName' => ['description' => 'The plugin package name.', 'type' => 'string', 'example' => 'com.aliyun.aicc.yundevice', 'title' => ''], + 'VersionCode' => ['description' => 'The version number.', 'type' => 'integer', 'format' => 'int64', 'example' => '201', 'title' => ''], + 'Id' => ['description' => 'The version ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '40', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '647D4B28-7646-424E-88DD-61B7969E5C1E', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"6F25F67C-F411-499F-BCE2-67CA563CB064\\"\\n}","errorExample":"{\\n \\"RequestId\\": \\"6F25F67C-F411-499F-BCE2-67CA563CB064\\",\\n \\"HostId\\": \\"iovcc.cn-shanghai.aliyuncs.com\\",\\n \\"Code\\": \\"NoPermissionToAccessProject\\",\\n \\"Message\\": \\"User is not authorized to access the specified project.\\"\\n}"},{"type":"xml","example":"<DeleteAllVersionGroupDevicesResponse>\\r\\n\\t<RequestId>6F25F67C-F411-499F-BCE2-67CA563CB064</RequestId>\\r\\n</DeleteAllVersionGroupDevicesResponse>","errorExample":""}]', - 'title' => 'DeleteAllVersionGroupDevices', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"ClientPluginVersions\\": [\\n {\\n \\"Version\\": \\"1.1.1.20180103102554-3\\",\\n \\"DownloadUrl\\": \\"http://xxxxx.oss-cn-shanghai.aliyuncs.com/1046834015363116/xxx/2019-09-17/1568704641998-com.aliyun.aicc-1.2-36-g4e4b62e.apk?spm=5176.11279587.0.0.f7944f48XVfS6a&Expires=1568708242&OSSAccessKeyId=xxxx&Signature=xxx%3D&response-content-disposition=attachment%3Bfilename%3Dcom.aliyun.aicc-1.2-36-g4e4b62e.apk%3Bfilename%2A%3DUTF-8%27%27com.aliyun.aicc-1.2-36-g4e4b62e.apk\\",\\n \\"Size\\": 743503,\\n \\"PkgName\\": \\"com.aliyun.aicc.yundevice\\",\\n \\"VersionCode\\": 201,\\n \\"Id\\": 40\\n }\\n ],\\n \\"RequestId\\": \\"647D4B28-7646-424E-88DD-61B7969E5C1E\\"\\n}","type":"json"}]', + 'title' => 'Query plugin version list by package name', + 'summary' => 'Queries the version list of a plugin by the specified plugin package name by calling ListClientPluginVersions.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'DeleteDevice' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [ + ['createdAt' => '2024-06-18T02:20:27.000Z', 'description' => 'Error codes changed'], + ], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'iovcc:ListClientPluginVersions', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'ListClientPlugins' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', - 'systemTags' => [ - 'operationType' => 'delete', - ], + 'operationType' => 'read', + 'systemTags' => ['operationType' => 'list'], 'parameters' => [ [ - 'name' => 'DeviceId', + 'name' => 'OsType', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '100', - ], - ], - [ - 'name' => 'ProjectId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'projectTest', - ], + 'schema' => ['description' => 'The operating system type. Valid values:'."\n" + .'- 1: Android.', 'type' => 'string', 'required' => true, 'example' => '1', 'title' => ''], ], ], 'responses' => [ @@ -12291,68 +9300,72 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '9c7a3b09-a69a-43f5-8bf2-84f7119810eb', + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '647D4B28-7646-424E-88DD-61B7969E5C1E', 'title' => ''], + 'ClientPlugins' => [ + 'description' => 'The client plugin information.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'PkgName' => ['description' => 'The plugin package name.', 'type' => 'string', 'example' => 'com.aliyun.aicc.yundevice', 'title' => ''], + 'Name' => ['description' => 'The plugin name.', 'type' => 'string', 'example' => 'YunDevice', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"9c7a3b09-a69a-43f5-8bf2-84f7119810eb\\"\\n}","errorExample":"{\\n \\"Code\\":\\"NoPermissionToAccessProject\\",\\n \\"HostId\\":\\"iovcc.cn-shanghai.aliyuncs.com\\",\\n \\"Message\\":\\"User is not authorized to access the specified project.\\",\\n \\"RequestId\\":\\"6F25F67C-F411-499F-BCE2-67CA563CB064\\"\\n}"},{"type":"xml","example":"<DeleteDeviceResponse>\\r\\n<RequestId>E94C9864-56FB-44AD-AC0C-A1CEFB332254</RequestId>\\r\\n</DeleteDeviceResponse>","errorExample":""}]', - 'title' => 'DeleteDevice', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"647D4B28-7646-424E-88DD-61B7969E5C1E\\",\\n \\"ClientPlugins\\": [\\n {\\n \\"PkgName\\": \\"com.aliyun.aicc.yundevice\\",\\n \\"Name\\": \\"YunDevice\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'Query client plugins', + 'summary' => 'Queries the list of client plugins by calling ListClientPlugins.', + 'description' => '> When downloading the AiCC Container client app, you need to select client plugins. Use this operation to query the plugin list.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'DeleteVersionAllBlackDevices' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [ + ['createdAt' => '2024-06-18T02:20:27.000Z', 'description' => 'Error codes changed'], ], - 'schemes' => [ - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'iovcc:ListClientPlugins', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + ], + 'ListClientSdks' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', - 'systemTags' => [ - 'operationType' => 'delete', - ], + 'operationType' => 'read', + 'systemTags' => ['operationType' => 'list'], 'parameters' => [ [ - 'name' => 'ProjectId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'P0VFCREU', - ], - ], - [ - 'name' => 'VersionType', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'FOTA', - ], - ], - [ - 'name' => 'VersionId', + 'name' => 'OsType', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '12345', - ], + 'schema' => ['description' => 'The operating system type. Set this parameter to 1 for Android.', 'type' => 'string', 'required' => true, 'example' => '1', 'title' => ''], ], ], 'responses' => [ @@ -12360,68 +9373,103 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '6F25F67C-F411-499F-BCE2-67CA563CB064', + 'ClientSdks' => [ + 'description' => 'The client SDK information.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'OsType' => ['description' => 'The operating system type. Set this parameter to 1 for Android.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'GmtCreate' => ['description' => 'The creation time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1512976910000', 'title' => ''], + 'GmtModified' => ['description' => 'The modification time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1512976910000', 'title' => ''], + 'Name' => ['description' => 'The SDK name.', 'type' => 'string', 'example' => 'AiCCSDK-FOTA', 'title' => ''], + 'PkgName' => ['description' => 'The package name. This field is empty for SDKs.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'PkgType' => ['description' => 'The package type. Valid values:'."\n" + .'- 0: SDK.'."\n" + .'- 1: application.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'Id' => ['description' => 'The primary key ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '6', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'D1BE8AC4-BE5B-4B04-B78B-A64C6BDB2AC2', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"6F25F67C-F411-499F-BCE2-67CA563CB064\\"\\n}","errorExample":"{\\n \\"RequestId\\": \\"6F25F67C-F411-499F-BCE2-67CA563CB064\\",\\n \\"HostId\\": \\"iovcc.cn-shanghai.aliyuncs.com\\",\\n \\"Code\\": \\"NoPermissionToAccessProject\\",\\n \\"Message\\": \\"User is not authorized to access the specified project.\\"\\n}"},{"type":"xml","example":"<DeleteVersionAllBlackDevicesResponse>\\r\\n\\t<RequestId>6F25F67C-F411-499F-BCE2-67CA563CB064</RequestId>\\r\\n</DeleteVersionAllBlackDevicesResponse>","errorExample":""}]', - 'title' => 'DeleteVersionAllBlackDevices', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"ClientSdks\\": [\\n {\\n \\"OsType\\": 1,\\n \\"GmtCreate\\": 1512976910000,\\n \\"GmtModified\\": 1512976910000,\\n \\"Name\\": \\"AiCCSDK-FOTA\\",\\n \\"PkgName\\": \\"null\\",\\n \\"PkgType\\": 0,\\n \\"Id\\": 6\\n }\\n ],\\n \\"RequestId\\": \\"D1BE8AC4-BE5B-4B04-B78B-A64C6BDB2AC2\\"\\n}","type":"json"}]', + 'title' => 'Query client SDK list', + 'summary' => 'Queries the list of client SDKs by calling ListClientSdks.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'DeleteVersionAllWhiteDevices' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [ + ['createdAt' => '2024-06-18T02:20:27.000Z', 'description' => 'Error codes changed'], ], - 'schemes' => [ - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'iovcc:ListClientSdks', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + ], + 'ListConnectLogs' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', - 'systemTags' => [ - 'operationType' => 'delete', - ], + 'operationType' => 'read', + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries per page in a paged query.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', 'title' => ''], + ], + [ 'name' => 'ProjectId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'P0VFCREU', - ], + 'schema' => ['description' => 'The ID of the iovcc project.', 'type' => 'string', 'required' => true, 'example' => 'fgsggsgg', 'title' => ''], ], [ - 'name' => 'VersionType', + 'name' => 'DeviceId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'FOTA', - ], + 'schema' => ['description' => 'The device ID in the dis system.', 'type' => 'string', 'required' => true, 'example' => 'fc35429dff9b473c81d7ef5f62ab11dc', 'title' => ''], ], [ - 'name' => 'VersionId', + 'name' => 'StartTime', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '12345', - ], + 'schema' => ['description' => 'The start time for the log query, accurate to the second.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1525684245', 'title' => ''], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => ['description' => 'The end time for the log query, accurate to the second.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1525694245', 'title' => ''], + ], + [ + 'name' => 'PageIndex', + 'in' => 'query', + 'schema' => ['description' => 'The page number in a paged query.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], ], 'responses' => [ @@ -12429,58 +9477,102 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '6F25F67C-F411-499F-BCE2-67CA563CB064', + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '629586FE-CB2E-4742-995E-121F952CEB72', 'title' => ''], + 'Logs' => [ + 'description' => 'The paginated log list object.', + 'type' => 'object', + 'properties' => [ + 'Pagination' => [ + 'description' => 'The pagination object.', + 'type' => 'object', + 'properties' => [ + 'PageIndex' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'TotalPageCount' => ['description' => 'The total number of pages.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '30', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'List' => [ + 'description' => 'The log list.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Sid' => ['description' => 'The session ID of the persistent connection.', 'type' => 'string', 'example' => 'rkp_u-sTz_1_29473_1525516404577', 'title' => ''], + 'Status' => ['description' => 'The connection status.', 'type' => 'string', 'example' => '断开', 'title' => ''], + 'Time' => ['description' => 'The log time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1525517083249', 'title' => ''], + 'DeviceId' => ['description' => 'The device ID in the dis system.', 'type' => 'string', 'example' => 'fc71429ddd9b473c81d7ef5f44ab10cc', 'title' => ''], + 'SystemVersion' => ['description' => 'The system version of the device.', 'type' => 'string', 'example' => '4.4.4', 'title' => ''], + 'Ip' => ['description' => 'The IP address of the device.', 'type' => 'string', 'example' => '220.180.xx.xxx', 'title' => ''], + 'NetWorking' => ['description' => 'The network type, such as EDGE, LTE, or WIFI.', 'type' => 'string', 'example' => 'EDGE', 'title' => ''], + 'Terminal' => ['description' => 'The device model.', 'type' => 'string', 'example' => 'iphone7', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"6F25F67C-F411-499F-BCE2-67CA563CB064\\"\\n}","errorExample":"{\\n \\"RequestId\\": \\"6F25F67C-F411-499F-BCE2-67CA563CB064\\",\\n \\"HostId\\": \\"iovcc.cn-shanghai.aliyuncs.com\\",\\n \\"Code\\": \\"NoPermissionToAccessProject\\",\\n \\"Message\\": \\"User is not authorized to access the specified project.\\"\\n}"},{"type":"xml","example":"<DeleteVersionAllWhiteDevicesResponse>\\r\\n\\t<RequestId>6F25F67C-F411-499F-BCE2-67CA563CB064</RequestId>\\r\\n</DeleteVersionAllWhiteDevicesResponse>","errorExample":""}]', - 'title' => 'DeleteVersionAllWhiteDevices', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"629586FE-CB2E-4742-995E-121F952CEB72\\",\\n \\"Logs\\": {\\n \\"Pagination\\": {\\n \\"PageIndex\\": 1,\\n \\"TotalPageCount\\": 2,\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 30\\n },\\n \\"List\\": [\\n {\\n \\"Sid\\": \\"rkp_u-sTz_1_29473_1525516404577\\",\\n \\"Status\\": \\"断开\\",\\n \\"Time\\": 1525517083249,\\n \\"DeviceId\\": \\"fc71429ddd9b473c81d7ef5f44ab10cc\\",\\n \\"SystemVersion\\": \\"4.4.4\\",\\n \\"Ip\\": \\"220.180.xx.xxx\\",\\n \\"NetWorking\\": \\"EDGE\\",\\n \\"Terminal\\": \\"iphone7\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'Query device connection logs', + 'summary' => 'Queries device connection logs by device ID and time range.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'DeleteVersionDeviceGroup' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [ + ['createdAt' => '2024-06-18T02:20:27.000Z', 'description' => 'Error codes changed'], + ], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'iovcc:ListConnectLogs', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'ListDeployedFunctions' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'delete', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'ProjectId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'P0VFCREU', - ], + 'schema' => ['description' => 'The project ID.', 'type' => 'string', 'required' => true, 'example' => 'PE9FQC48', 'title' => ''], ], [ - 'name' => 'Id', + 'name' => 'FileId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '1', - ], + 'schema' => ['description' => 'The file ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1', 'title' => ''], ], ], 'responses' => [ @@ -12488,78 +9580,95 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '6F25F67C-F411-499F-BCE2-67CA563CB064', + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '629586FE-CB2E-4742-995E-121F952CEB72', 'title' => ''], + 'Functions' => [ + 'description' => 'The function records.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ProjectId' => ['description' => 'The project ID.', 'type' => 'string', 'example' => 'PE9FQC48', 'title' => ''], + 'GmtCreate' => ['description' => 'The creation time, as a UNIX timestamp in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1535604251000', 'title' => ''], + 'Name' => ['description' => 'The function name.', 'type' => 'string', 'example' => 'someFunc', 'title' => ''], + 'GmtModified' => ['description' => 'The modification time, as a UNIX timestamp in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1535872636000', 'title' => ''], + 'Id' => ['description' => 'The function ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'FileId' => ['description' => 'The file ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"6F25F67C-F411-499F-BCE2-67CA563CB064\\"\\n}","errorExample":"{\\n \\"RequestId\\": \\"6F25F67C-F411-499F-BCE2-67CA563CB064\\",\\n \\"HostId\\": \\"iovcc.cn-shanghai.aliyuncs.com\\",\\n \\"Code\\": \\"NoPermissionToAccessProject\\",\\n \\"Message\\": \\"User is not authorized to access the specified project.\\"\\n}"},{"type":"xml","example":"<DeleteVersionDeviceGroupResponse>\\r\\n\\t<RequestId>6F25F67C-F411-499F-BCE2-67CA563CB064</RequestId>\\r\\n</DeleteVersionDeviceGroupResponse>","errorExample":""}]', - 'title' => 'DeleteVersionDeviceGroup', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"629586FE-CB2E-4742-995E-121F952CEB72\\",\\n \\"Functions\\": [\\n {\\n \\"ProjectId\\": \\"PE9FQC48\\",\\n \\"GmtCreate\\": 1535604251000,\\n \\"Name\\": \\"someFunc\\",\\n \\"GmtModified\\": 1535872636000,\\n \\"Id\\": 1,\\n \\"FileId\\": 1\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'Query deployed functions', + 'summary' => 'Queries deployed functions by calling ListDeployedFunctions.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'DeleteVersionGroupDevice' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [ + ['createdAt' => '2024-06-18T02:20:27.000Z', 'description' => 'Error codes changed'], ], - 'schemes' => [ - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'iovcc:ListDeployedFunctions', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + ], + 'ListDeviceBrands' => [ + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'delete', - ], + 'systemTags' => ['operationType' => 'list'], 'parameters' => [ [ - 'name' => 'DeviceIds', + 'name' => 'ProjectId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'b8fe2e24ff2b48e0a3aa4e49809fc1b3', - ], + 'schema' => ['description' => 'The project ID.', 'type' => 'string', 'required' => false, 'example' => 'projectTest', 'title' => ''], ], [ - 'name' => 'ProjectId', + 'name' => 'DeviceBrandId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'P0VFCREU', - ], + 'schema' => ['description' => 'The device brand ID to query.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''], ], [ - 'name' => 'DeviceGroupId', + 'name' => 'DeviceBrand', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '1', - ], + 'schema' => ['description' => 'The device brand name to query. Fuzzy match is supported.', 'type' => 'string', 'required' => false, 'example' => 'Tmall', 'title' => ''], ], [ - 'name' => 'DeviceIdType', + 'name' => 'Start', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'device_id', - ], + 'schema' => ['description' => 'The start position of the returned list.', 'type' => 'string', 'required' => false, 'example' => '10', 'title' => ''], + ], + [ + 'name' => 'Length', + 'in' => 'query', + 'schema' => ['description' => 'The maximum number of records to return.', 'type' => 'string', 'required' => false, 'example' => '20', 'title' => ''], ], ], 'responses' => [ @@ -12567,238 +9676,403 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '6F25F67C-F411-499F-BCE2-67CA563CB064', + 'DeviceBrands' => [ + 'description' => 'The query results.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'DeviceBrandId' => ['description' => 'The brand ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'Description' => ['description' => 'The brand description.', 'type' => 'string', 'example' => '荣威 ', 'title' => ''], + 'ProjectId' => ['description' => 'The project ID.', 'type' => 'string', 'example' => 'projectTest', 'title' => ''], + 'Manufacture' => ['description' => 'The manufacturer.', 'type' => 'string', 'example' => 'SAIC', 'title' => ''], + 'DeviceBrand' => ['description' => 'The brand name.', 'type' => 'string', 'example' => 'ROEWE', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '9c7a3b09-a69a-43f5-8bf2-84f7119810eb', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"6F25F67C-F411-499F-BCE2-67CA563CB064\\"\\n}","errorExample":"{\\n \\"RequestId\\": \\"6F25F67C-F411-499F-BCE2-67CA563CB064\\",\\n \\"HostId\\": \\"iovcc.cn-shanghai.aliyuncs.com\\",\\n \\"Code\\": \\"NoPermissionToAccessProject\\",\\n \\"Message\\": \\"User is not authorized to access the specified project.\\"\\n}"},{"type":"xml","example":"<DeleteVersionGroupDeviceResponse>\\r\\n\\t<RequestId>6F25F67C-F411-499F-BCE2-67CA563CB064</RequestId>\\r\\n</DeleteVersionGroupDeviceResponse>","errorExample":""}]', - 'title' => 'DeleteVersionGroupDevice', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"DeviceBrands\\": [\\n {\\n \\"DeviceBrandId\\": 1,\\n \\"Description\\": \\"荣威\\\\t\\",\\n \\"ProjectId\\": \\"projectTest\\",\\n \\"Manufacture\\": \\"SAIC\\",\\n \\"DeviceBrand\\": \\"ROEWE\\"\\n }\\n ],\\n \\"RequestId\\": \\"9c7a3b09-a69a-43f5-8bf2-84f7119810eb\\"\\n}","type":"json"}]', + 'title' => 'Query device brand list', + 'summary' => 'Queries a list of device brands by brand ID or brand name with fuzzy match support.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'DeleteVersionGroupDeviceById' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [ + ['createdAt' => '2024-06-18T02:20:27.000Z', 'description' => 'Error codes changed'], ], - 'schemes' => [ - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'iovcc:ListDeviceBrands', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + ], + 'ListDeviceModels' => [ + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', - 'systemTags' => [ - 'operationType' => 'delete', - ], + 'operationType' => 'read', + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ + 'name' => 'DeviceModelId', + 'in' => 'query', + 'schema' => ['description' => 'The device model ID.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], + ], + [ + 'name' => 'Length', + 'in' => 'query', + 'schema' => ['description' => 'The maximum length of the list.', 'type' => 'string', 'required' => false, 'example' => '20', 'title' => ''], + ], + [ + 'name' => 'DeviceModel', + 'in' => 'query', + 'schema' => ['description' => 'The device model name. Fuzzy match is supported.', 'type' => 'string', 'required' => false, 'example' => 'X1', 'title' => ''], + ], + [ + 'name' => 'DeviceBrand', + 'in' => 'query', + 'schema' => ['description' => 'The device brand.', 'type' => 'string', 'required' => false, 'example' => 'TmallGenius', 'title' => ''], + ], + [ + 'name' => 'Start', + 'in' => 'query', + 'schema' => ['description' => 'The start position of the list.', 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ 'name' => 'ProjectId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'P0VFCREU', - ], + 'schema' => ['description' => 'The project ID.', 'type' => 'string', 'required' => false, 'example' => 'projectTest', 'title' => ''], ], [ - 'name' => 'DeviceGroupId', + 'name' => 'DeviceBrandId', 'in' => 'query', + 'schema' => ['type' => 'integer', 'format' => 'int64', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'DeviceModels' => [ + 'description' => 'The list of query results.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'DeviceModelId' => ['description' => 'The model ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''], + 'HardwareType' => ['description' => 'The basis for generating the device ID.', 'type' => 'string', 'example' => 'sn', 'title' => ''], + 'DeviceName' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'DeviceType' => ['description' => 'The device type.', 'type' => 'string', 'example' => '智能家居', 'title' => ''], + 'CanCreateDeviceId' => ['description' => 'Indicates whether a device ID can be generated.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'ProjectId' => ['description' => 'The project ID.', 'type' => 'string', 'example' => 'projectTest', 'title' => ''], + 'OsPlatform' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'DeviceModel' => ['description' => 'The device model.', 'type' => 'string', 'example' => 'X1', 'title' => ''], + 'SecurityChip' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'DeviceLogoUrl' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Description' => ['description' => 'The description of the device model.', 'type' => 'string', 'example' => '天猫精灵X1', 'title' => ''], + 'ObjectKey' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'InitUsageTypeDesc' => ['description' => 'The description of the device usage type. Valid values:'."\n" + .'- 0: Personal device.'."\n" + .'- 1: Operational or shared device.', 'type' => 'string', 'example' => '私人设备', 'title' => ''], + 'InitUsageType' => ['description' => 'The device usage type. Valid values:'."\n" + .'- 0: Personal device.'."\n" + .'- 1: Operational or shared device.'."\n" + ."\n" + .'Default value: 0.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'DeviceBrand' => ['description' => 'The device brand.', 'type' => 'string', 'example' => 'TmallGenius', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '9c7a3b09-a69a-43f5-8bf2-84f7119810eb', 'title' => ''], + ], 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '1234', + 'title' => '', + 'example' => '', ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"DeviceModels\\": [\\n {\\n \\"DeviceModelId\\": 10,\\n \\"HardwareType\\": \\"sn\\",\\n \\"DeviceName\\": \\"\\",\\n \\"DeviceType\\": \\"智能家居\\",\\n \\"CanCreateDeviceId\\": 1,\\n \\"ProjectId\\": \\"projectTest\\",\\n \\"OsPlatform\\": \\"\\",\\n \\"DeviceModel\\": \\"X1\\",\\n \\"SecurityChip\\": \\"\\",\\n \\"DeviceLogoUrl\\": \\"\\",\\n \\"Description\\": \\"天猫精灵X1\\",\\n \\"ObjectKey\\": \\"\\",\\n \\"InitUsageTypeDesc\\": \\"私人设备\\",\\n \\"InitUsageType\\": 0,\\n \\"DeviceBrand\\": \\"TmallGenius\\"\\n }\\n ],\\n \\"RequestId\\": \\"9c7a3b09-a69a-43f5-8bf2-84f7119810eb\\"\\n}","type":"json"}]', + 'title' => 'Query device model list', + 'summary' => 'Queries the list of device models.', + 'description' => 'Queries the list of device models.', + 'changeSet' => [ + ['createdAt' => '2024-06-18T02:20:27.000Z', 'description' => 'Error codes changed'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ [ - 'name' => 'Ids', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '11,22,33', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'iovcc:ListDeviceModels', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], + ], + 'ListDeviceTypes' => [ + 'methods' => ['get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => ['operationType' => 'get'], + 'parameters' => [ + [ + 'name' => 'ProjectId', + 'in' => 'query', + 'schema' => ['description' => 'The project ID.', 'type' => 'string', 'required' => false, 'example' => 'projectTest', 'title' => ''], + ], + ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '6F25F67C-F411-499F-BCE2-67CA563CB064', + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '9c7a3b09-a69a-43f5-8bf2-84f7119810eb', 'title' => ''], + 'DeviceTypes' => [ + 'description' => 'The response content.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'DeviceType' => ['description' => 'The device type identifier.', 'type' => 'string', 'example' => 'car_auto', 'title' => ''], + 'Name' => ['description' => 'The device type name.', 'type' => 'string', 'example' => '智能汽车', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"6F25F67C-F411-499F-BCE2-67CA563CB064\\"\\n}","errorExample":"{\\n \\"RequestId\\": \\"6F25F67C-F411-499F-BCE2-67CA563CB064\\",\\n \\"HostId\\": \\"iovcc.cn-shanghai.aliyuncs.com\\",\\n \\"Code\\": \\"NoPermissionToAccessProject\\",\\n \\"Message\\": \\"User is not authorized to access the specified project.\\"\\n}"},{"type":"xml","example":"<DeleteVersionGroupDeviceByIdRespone>\\r\\n\\t<RequestId>6F25F67C-F411-499F-BCE2-67CA563CB064</RequestId>\\r\\n</DeleteVersionGroupDeviceByIdRespone>","errorExample":""}]', - 'title' => 'DeleteVersionGroupDeviceById', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9c7a3b09-a69a-43f5-8bf2-84f7119810eb\\",\\n \\"DeviceTypes\\": [\\n {\\n \\"DeviceType\\": \\"car_auto\\",\\n \\"Name\\": \\"智能汽车\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'Retrieve all device types supported by the system', + 'summary' => 'Calls ListDeviceTypes to retrieve the list of all device types supported by the system.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'UpdateDeviceModel' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [ + ['createdAt' => '2024-06-18T02:20:27.000Z', 'description' => 'Error codes changed'], + ], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'iovcc:ListDeviceTypes', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'ListDevices' => [ + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', - 'systemTags' => [ - 'operationType' => 'update', - ], + 'operationType' => 'read', + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'InitUsageType', + 'name' => 'ProjectId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '0', - ], + 'schema' => ['description' => 'The project ID.', 'type' => 'string', 'required' => false, 'example' => 'projectTest', 'title' => ''], ], [ - 'name' => 'ModelName', + 'name' => 'DeviceModelId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'X2', - ], + 'schema' => ['description' => 'The device model ID.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], ], [ - 'name' => 'Id', + 'name' => 'DeviceModel', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '10', - ], + 'schema' => ['description' => 'The device model name. Fuzzy match is supported.', 'type' => 'string', 'required' => false, 'example' => 'ROEWE RX5 ', 'title' => ''], ], [ - 'name' => 'BrandName', + 'name' => 'Start', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'ROEWE', - ], + 'schema' => ['description' => 'The start position of the returned result list.', 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''], ], [ - 'name' => 'Description', + 'name' => 'Length', 'in' => 'query', + 'schema' => ['description' => 'The maximum length of the returned result list.', 'type' => 'string', 'required' => false, 'example' => '20', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '9c7a3b09-a69a-43f5-8bf2-84f7119810eb', 'title' => ''], + 'Devices' => [ + 'description' => 'The returned content.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'SerialNumber' => ['description' => 'The serial number of the device.', 'type' => 'string', 'example' => 'xxxxxxxx', 'title' => ''], + 'Status' => ['description' => 'The device status.', 'type' => 'string', 'example' => '0', 'title' => ''], + 'DeviceModelId' => ['description' => 'The device model ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''], + 'MacAddress' => ['description' => 'The MAC address.', 'type' => 'string', 'example' => '00:00:00:00:00:00', 'title' => ''], + 'DeviceId' => ['description' => 'The device ID.', 'type' => 'string', 'example' => 'cn.1234567890', 'title' => ''], + 'DeviceType' => ['description' => 'The device type.', 'type' => 'string', 'example' => 'car_auto ', 'title' => ''], + 'ProjectId' => ['description' => 'The project ID.', 'type' => 'string', 'example' => 'projectTest', 'title' => ''], + 'DeviceModel' => ['description' => 'The device model.', 'type' => 'string', 'example' => 'ROEWE RX5 ', 'title' => ''], + 'UsageType' => ['description' => 'The usage type of the device.'."\n" + ."\n" + .'0 indicates a private device. 1 indicates a business or shared device.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'Vin' => ['description' => 'The Vehicle Identification Number (VIN) of the device. This parameter is used for automotive products.', 'type' => 'string', 'example' => 'xxxxxxxx', 'title' => ''], + 'UsageTypeDesc' => ['description' => 'The description of the device usage type.'."\n" + ."\n" + .'**private** indicates a private device. **business** indicates a business or shared device.', 'type' => 'string', 'example' => 'private', 'title' => ''], + 'Uuid' => ['description' => 'The UUID of the device.', 'type' => 'string', 'example' => 'xxxxxxxx', 'title' => ''], + 'HardwareId' => ['description' => 'The hardware ID.', 'type' => 'string', 'example' => 'xxxxxxxx', 'title' => ''], + 'Region' => ['description' => 'The country code of the device location.', 'type' => 'string', 'example' => 'cn', 'title' => ''], + 'SoftwareId' => ['description' => 'The software ID.', 'type' => 'string', 'example' => 'xxxxxxxx', 'title' => ''], + 'Name' => ['description' => 'The nickname of the device.', 'type' => 'string', 'example' => '我的设备', 'title' => ''], + 'DeviceBrand' => ['description' => 'The device brand.', 'type' => 'string', 'example' => 'ROEWE', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], 'description' => '', - 'type' => 'string', - 'required' => false, + 'title' => '', 'example' => '', ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9c7a3b09-a69a-43f5-8bf2-84f7119810eb\\",\\n \\"Devices\\": [\\n {\\n \\"SerialNumber\\": \\"xxxxxxxx\\",\\n \\"Status\\": \\"0\\",\\n \\"DeviceModelId\\": 10,\\n \\"MacAddress\\": \\"00:00:00:00:00:00\\",\\n \\"DeviceId\\": \\"cn.1234567890\\",\\n \\"DeviceType\\": \\"car_auto\\\\t\\",\\n \\"ProjectId\\": \\"projectTest\\",\\n \\"DeviceModel\\": \\"ROEWE RX5\\\\t\\",\\n \\"UsageType\\": 0,\\n \\"Vin\\": \\"xxxxxxxx\\",\\n \\"UsageTypeDesc\\": \\"private\\",\\n \\"Uuid\\": \\"xxxxxxxx\\",\\n \\"HardwareId\\": \\"xxxxxxxx\\",\\n \\"Region\\": \\"cn\\",\\n \\"SoftwareId\\": \\"xxxxxxxx\\",\\n \\"Name\\": \\"我的设备\\",\\n \\"DeviceBrand\\": \\"ROEWE\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'Query device list', + 'summary' => 'Calls ListDevices to query a list of devices.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2024-06-18T02:20:27.000Z', 'description' => 'Error codes changed'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ [ - 'name' => 'DeviceType', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'car_auto', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'iovcc:ListDevices', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + ], + 'ListFunctionExecuteLog' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'CanCreateDeviceId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'true', - ], + 'AK' => [], ], + ], + 'operationType' => 'read', + 'systemTags' => ['operationType' => 'get'], + 'parameters' => [ [ 'name' => 'ProjectId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'projectTest', - ], + 'schema' => ['description' => 'The project ID.', 'type' => 'string', 'required' => true, 'example' => 'PE9FQC48', 'title' => ''], ], [ - 'name' => 'HardwareType', + 'name' => 'FileId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'hardware_id', - ], + 'schema' => ['description' => 'The file ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1', 'title' => ''], ], [ - 'name' => 'SecurityChip', + 'name' => 'FunctionName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '0', - ], + 'schema' => ['description' => 'The function name.', 'type' => 'string', 'required' => true, 'example' => 'someFunc', 'title' => ''], ], [ - 'name' => 'OsPlatform', + 'name' => 'Env', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'android', - ], + 'schema' => ['description' => 'The environment in which the function is deployed. Valid values:'."\n" + .'- 0: sandbox environment'."\n" + .'- 1: production environment.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '0', 'title' => ''], ], [ - 'name' => 'ObjectKey', + 'name' => 'PageIndex', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '1151125281886341/375KZRO8TARYBQY7P0E4/2019-04-12/1555062240807.jpg', - ], + 'schema' => ['description' => 'The page number. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], [ - 'name' => 'DeviceName', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'device', - ], + 'schema' => ['description' => 'The number of entries per page. Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], ], ], 'responses' => [ @@ -12806,78 +10080,107 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '9c7a3b09-a69a-43f5-8bf2-84f7119810eb', + 'LogList' => [ + 'description' => 'The log list.', + 'type' => 'object', + 'properties' => [ + 'Pagination' => [ + 'description' => 'The pagination information.', + 'type' => 'object', + 'properties' => [ + 'PageIndex' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'HasNextPage' => ['description' => 'Indicates whether there is a next page.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'Logs' => [ + 'description' => 'The log array.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Message' => ['description' => 'The standard output log content generated during function execution.', 'type' => 'string', 'example' => '2018-08-21T03:28:50.267Z 5f541c0a-2175-7651-7b7e-c8a0bff5cb7e [info] This is output of console.log', 'title' => ''], + 'BackEndRequestId' => ['description' => 'The ID of the backend runtime environment call.', 'type' => 'string', 'example' => '5f541c0a-2175-7651-7b7e-c8a0bff5cb7e', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '629586FE-CB2E-4742-995E-121F952CEB72', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"9c7a3b09-a69a-43f5-8bf2-84f7119810eb\\"\\n}","errorExample":"{\\n \\"Code\\":\\"NoPermissionToAccessProject\\",\\n \\"HostId\\":\\"iovcc.cn-shanghai.aliyuncs.com\\",\\n \\"Message\\":\\"User is not authorized to access the specified project.\\",\\n \\"RequestId\\":\\"6F25F67C-F411-499F-BCE2-67CA563CB064\\"\\n}"},{"type":"xml","example":"<UpdateDeviceModelResponse>\\r\\n<RequestId>E94C9864-56FB-44AD-AC0C-A1CEFB332254</RequestId>\\r\\n</UpdateDeviceModelResponse>","errorExample":""}]', - 'title' => 'UpdateDeviceModel', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"LogList\\": {\\n \\"Pagination\\": {\\n \\"PageIndex\\": 1,\\n \\"PageSize\\": 10,\\n \\"HasNextPage\\": true\\n },\\n \\"Logs\\": [\\n {\\n \\"Message\\": \\"2018-08-21T03:28:50.267Z 5f541c0a-2175-7651-7b7e-c8a0bff5cb7e [info] This is output of console.log\\",\\n \\"BackEndRequestId\\": \\"5f541c0a-2175-7651-7b7e-c8a0bff5cb7e\\"\\n }\\n ]\\n },\\n \\"RequestId\\": \\"629586FE-CB2E-4742-995E-121F952CEB72\\"\\n}","type":"json"}]', + 'title' => 'Query function execution logs', + 'summary' => 'Lists the logs of function executions by page.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'UpdateVersionDeviceGroup' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [ + ['createdAt' => '2024-06-18T02:20:27.000Z', 'description' => 'Error codes changed'], ], - 'schemes' => [ - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'iovcc:ListFunctionExecuteLog', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + ], + 'ListFunctionFiles' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'update', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'ProjectId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'P0VFCREU', - ], + 'schema' => ['description' => 'The project ID.', 'type' => 'string', 'required' => true, 'example' => 'PE9FQC48', 'title' => ''], ], [ - 'name' => 'Name', + 'name' => 'FileType', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '', - ], + 'schema' => ['description' => 'The file type. Valid values:'."\n" + .'- 0: single file.'."\n" + .'- 1: package file.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1', 'title' => ''], ], [ - 'name' => 'Description', + 'name' => 'PageIndex', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '', - ], + 'schema' => ['description' => 'The page number. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], [ - 'name' => 'Id', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'The number of entries per page. Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], ], ], 'responses' => [ @@ -12885,70 +10188,120 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '6F25F67C-F411-499F-BCE2-67CA563CB064', + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '629586FE-CB2E-4742-995E-121F952CEB72', 'title' => ''], + 'FileList' => [ + 'description' => 'The file list.', + 'type' => 'object', + 'properties' => [ + 'Pagination' => [ + 'description' => 'The pagination information.', + 'type' => 'object', + 'properties' => [ + 'PageIndex' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'TotalPageCount' => ['description' => 'The total number of pages.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '11', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'Files' => [ + 'description' => 'The array of files.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Status' => ['description' => 'The file status. Valid values:'."\n" + .'- 0: Normal.'."\n" + .'- 1: Deleted.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'ProductionDeployTime' => ['description' => 'The deployment time in the production environment. The value is a UNIX timestamp in milliseconds.'."\n" + ."\n" + .'> This value is returned only when the deployment status of the production environment is deployed. Otherwise, this field is not returned.', 'type' => 'integer', 'format' => 'int64', 'example' => '1535604251000', 'title' => ''], + 'ProductionDeployStatus' => ['description' => 'The deployment status of the production environment. Valid values:'."\n" + .'- 0: Not deployed.'."\n" + .'- 1: Deployed.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'Description' => ['description' => 'The file description.', 'type' => 'string', 'example' => 'This is description', 'title' => ''], + 'SandboxDeployTime' => ['description' => 'The deployment time in the sandbox environment. The value is a UNIX timestamp in milliseconds.'."\n" + ."\n" + .'> This value is returned only when the deployment status of the sandbox environment is deployed. Otherwise, this field is not returned.', 'type' => 'integer', 'format' => 'int64', 'example' => '1535604251000', 'title' => ''], + 'GmtCreate' => ['description' => 'The creation time. The value is a UNIX timestamp in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1535604251000', 'title' => ''], + 'SandboxDeployStatus' => ['description' => 'The deployment status of the sandbox environment. Valid values:'."\n" + .'- 0: Not deployed.'."\n" + .'- 1: Deployed.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'GmtModified' => ['description' => 'The modification time. The value is a UNIX timestamp in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1535604251000', 'title' => ''], + 'Name' => ['description' => 'The file name.', 'type' => 'string', 'example' => 'hello.zip', 'title' => ''], + 'ContentId' => ['description' => 'The file content ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'Id' => ['description' => 'The file ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"6F25F67C-F411-499F-BCE2-67CA563CB064\\"\\n}","errorExample":"{\\n \\"RequestId\\": \\"6F25F67C-F411-499F-BCE2-67CA563CB064\\",\\n \\"HostId\\": \\"iovcc.cn-shanghai.aliyuncs.com\\",\\n \\"Code\\": \\"NoPermissionToAccessProject\\",\\n \\"Message\\": \\"User is not authorized to access the specified project.\\"\\n}"},{"type":"xml","example":"<UpdateVersionDeviceGroupResponse>\\r\\n\\t<RequestId>6F25F67C-F411-499F-BCE2-67CA563CB064</RequestId>\\r\\n</UpdateVersionDeviceGroupResponse>","errorExample":""}]', - 'title' => 'UpdateVersionDeviceGroup', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"629586FE-CB2E-4742-995E-121F952CEB72\\",\\n \\"FileList\\": {\\n \\"Pagination\\": {\\n \\"PageIndex\\": 1,\\n \\"TotalPageCount\\": 2,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 11\\n },\\n \\"Files\\": [\\n {\\n \\"Status\\": 0,\\n \\"ProductionDeployTime\\": 1535604251000,\\n \\"ProductionDeployStatus\\": 1,\\n \\"Description\\": \\"This is description\\",\\n \\"SandboxDeployTime\\": 1535604251000,\\n \\"GmtCreate\\": 1535604251000,\\n \\"SandboxDeployStatus\\": 1,\\n \\"GmtModified\\": 1535604251000,\\n \\"Name\\": \\"hello.zip\\",\\n \\"ContentId\\": 1,\\n \\"Id\\": 1\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'Query function files', + 'summary' => 'Lists function files of a specified type in a specified project. Pagination is supported.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'UpdateApiGatewayAppStatus' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [ + ['createdAt' => '2024-06-18T02:20:27.000Z', 'description' => 'Error codes changed'], + ], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'iovcc:ListFunctionFiles', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'ListFunctionFilesByProjectId' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', - 'systemTags' => [ - 'operationType' => 'update', - ], + 'operationType' => 'read', + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'ProjectId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'PPCVFRG7', - ], + 'schema' => ['description' => 'The project ID.', 'type' => 'string', 'required' => true, 'example' => 'PE9FQC48', 'title' => ''], ], [ - 'name' => 'GatewayAppId', + 'name' => 'PageIndex', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '5929076', - ], + 'schema' => ['description' => 'The page number. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], [ - 'name' => 'Status', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '1', - ], + 'schema' => ['description' => 'The number of items per page. Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], ], ], 'responses' => [ @@ -12956,69 +10309,107 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '6F25F67C-F411-499F-BCE2-67CA563CB064', + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '629586FE-CB2E-4742-995E-121F952CEB72', 'title' => ''], + 'Files' => [ + 'description' => 'The file records.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Type' => ['description' => 'The file type. Valid values:'."\n" + .'- 0: single file'."\n" + .'- 1: package file.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'Status' => ['description' => 'The file status. Valid values:'."\n" + .'- 0: Normal.'."\n" + .'- 1: Deleted.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'GmtCreate' => ['description' => 'The creation time. This value is a UNIX timestamp accurate to milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1535604251000', 'title' => ''], + 'GmtModified' => ['description' => 'The modification time. This value is a UNIX timestamp accurate to milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1535872636000', 'title' => ''], + 'Name' => ['description' => 'The file name.', 'type' => 'string', 'example' => 'hello.zip', 'title' => ''], + 'Id' => ['description' => 'The file ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'ContentId' => ['description' => 'The file content ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"6F25F67C-F411-499F-BCE2-67CA563CB064\\"\\n}","errorExample":"{\\n \\"RequestId\\": \\"6F25F67C-F411-499F-BCE2-67CA563CB064\\",\\n \\"HostId\\": \\"iovcc.cn-shanghai.aliyuncs.com\\",\\n \\"Code\\": \\"NotFoundProject\\",\\n \\"Message\\": \\"Cannot find the specified project\\"\\n}"},{"type":"xml","example":"<UpdateApiGatewayAppStatusResponse>\\r\\n<RequestId>6F25F67C-F411-499F-BCE2-67CA563CB064</RequestId>\\r\\n</UpdateApiGatewayAppStatusResponse>","errorExample":""}]', - 'title' => 'UpdateApiGatewayAppStatus', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"629586FE-CB2E-4742-995E-121F952CEB72\\",\\n \\"Files\\": [\\n {\\n \\"Type\\": 1,\\n \\"Status\\": 0,\\n \\"GmtCreate\\": 1535604251000,\\n \\"GmtModified\\": 1535872636000,\\n \\"Name\\": \\"hello.zip\\",\\n \\"Id\\": 1,\\n \\"ContentId\\": 1\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'Query function files by project ID', + 'summary' => 'Lists the single files and package files of functions created in a specified project, with pagination support.', + 'description' => '> For example, when creating a trigger, list the function files associated with the current project first, and then select a function.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'UpdateProject' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [ + ['createdAt' => '2024-06-18T02:20:27.000Z', 'description' => 'Error codes changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'iovcc:ListFunctionFilesByProjectId', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + ], + 'ListMessageAcks' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', - 'systemTags' => [ - 'operationType' => 'update', - ], + 'operationType' => 'read', + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', 'title' => ''], + ], + [ 'name' => 'ProjectId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '11', - ], + 'schema' => ['description' => 'The ID of the IoVCC project.', 'type' => 'string', 'required' => true, 'example' => 'gsgshhfs', 'title' => ''], ], [ - 'name' => 'Name', + 'name' => 'DeviceId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'test', - ], + 'schema' => ['description' => 'The device ID in the DIS system. The query results vary based on the parameters:'."\n" + ."\n" + .'1. If only DeviceId is specified as a conditional query, the message ACK records of the specified device are returned.'."\n" + .'2. If both DeviceId and MessageId are specified, the ACK record of the specified message on the specified device is returned.', 'type' => 'string', 'required' => false, 'example' => 'fc71429ddd9b473c81d7ef5f33ab10cc', 'title' => ''], ], [ - 'name' => 'Description', + 'name' => 'MessageId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'test', - ], + 'schema' => ['description' => 'The message ID. The query results vary based on the parameters:'."\n" + ."\n" + .'1. If only MessageId is specified as a conditional query, the ACK records of the specified message are returned.'."\n" + .'2. If both MessageId and DeviceId are specified, the ACK record of the specified message on the specified device is returned.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '24266', 'title' => ''], + ], + [ + 'name' => 'PageIndex', + 'in' => 'query', + 'schema' => ['description' => 'The page number for the paged query.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], ], 'responses' => [ @@ -13026,69 +10417,107 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '6F25F67C-F411-499F-BCE2-67CA563CB064', + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '629586FE-CB2E-4742-995E-121F952CEB72', 'title' => ''], + 'MessageAcks' => [ + 'description' => 'The paginated data object of ACK records.', + 'type' => 'object', + 'properties' => [ + 'Pagination' => [ + 'description' => 'The pagination object.', + 'type' => 'object', + 'properties' => [ + 'PageIndex' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'TotalPageCount' => ['description' => 'The total number of pages.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '30', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'List' => [ + 'description' => 'The paginated list data.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'DeviceId' => ['description' => 'The device ID in the DIS system.', 'type' => 'string', 'example' => 'fc71429ddd9b473c81d7ef5f33ab10cc', 'title' => ''], + 'AckTime' => ['description' => 'The time when the message arrived, accurate to milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1525684245000', 'title' => ''], + 'Mid' => ['description' => 'The message ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '24266', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"6F25F67C-F411-499F-BCE2-67CA563CB064\\"\\n}","errorExample":"{\\n \\"RequestId\\": \\"6F25F67C-F411-499F-BCE2-67CA563CB064\\",\\n \\"HostId\\": \\"iovcc.cn-shanghai.aliyuncs.com\\",\\n \\"Code\\": \\"NotFoundProject\\",\\n \\"Message\\": \\"Cannot find the specified project\\"\\n}"},{"type":"xml","example":"<UpdateProjectResponse>\\r\\n<RequestId>6F25F67C-F411-499F-BCE2-67CA563CB064</RequestId>\\r\\n</UpdateProjectResponse>","errorExample":""}]', - 'title' => 'UpdateProject', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"629586FE-CB2E-4742-995E-121F952CEB72\\",\\n \\"MessageAcks\\": {\\n \\"Pagination\\": {\\n \\"PageIndex\\": 1,\\n \\"TotalPageCount\\": 2,\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 30\\n },\\n \\"List\\": [\\n {\\n \\"DeviceId\\": \\"fc71429ddd9b473c81d7ef5f33ab10cc\\",\\n \\"AckTime\\": 1525684245000,\\n \\"Mid\\": 24266\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'Query message ACK records', + 'summary' => 'Queries the list of message ACK records by message ID or device ID.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'DescribeDeviceModel' => [ - 'methods' => [ - 'get', + 'changeSet' => [ + ['createdAt' => '2024-06-18T02:20:26.000Z', 'description' => 'Error codes changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'iovcc:ListMessageAcks', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + ], + 'ListMessageReceivers' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'DeviceModelId', + 'name' => 'ProjectId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], + 'schema' => ['description' => 'The ID of the IoVCC project.', 'type' => 'string', 'required' => true, 'example' => 'sfgsghd6', 'title' => ''], ], [ - 'name' => 'DeviceModel', + 'name' => 'MessageId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'X1', - ], + 'schema' => ['description' => 'The message ID.', 'type' => 'string', 'required' => true, 'example' => '32555', 'title' => ''], ], [ - 'name' => 'ProjectId', + 'name' => 'PageIndex', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'projectTest', - ], + 'schema' => ['description' => 'The page number for the paged query.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries per page for the paged query.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', 'title' => ''], ], ], 'responses' => [ @@ -13096,153 +10525,103 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'DeviceModel' => [ - 'description' => '', + 'MessageReceivers' => [ + 'description' => 'The paged query data object for device receivers.', 'type' => 'object', 'properties' => [ - 'DeviceModelId' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10', - ], - 'HardwareType' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'sn', - ], - 'DeviceName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'device', - ], - 'DeviceType' => [ - 'description' => '', - 'type' => 'string', + 'Pagination' => [ + 'description' => 'The paging object.', + 'type' => 'object', + 'properties' => [ + 'PageIndex' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'TotalPageCount' => ['description' => 'The total number of pages.', 'type' => 'integer', 'format' => 'int32', 'example' => '30', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''], + ], + 'title' => '', 'example' => '', ], - 'CanCreateDeviceId' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'ProjectId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'projectTest', - ], - 'OsPlatform' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'android', - ], - 'DeviceModel' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'ROEWE RX5', - ], - 'SecurityChip' => [ - 'description' => '', - 'type' => 'string', - 'example' => '0', - ], - 'DeviceLogoUrl' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'http://dis-cdn.aicc.aliyun.com/1151125281886341/375KZRO8TARYBQY7P0E4/2019-04-12/1555062240807.jpg', - ], - 'Description' => [ - 'description' => '', - 'type' => 'string', + 'List' => [ + 'description' => 'The list of device receiver objects.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Type' => ['description' => 'The object type of the message receiver.'."\n" + ."\n" + .'Valid values: **uuid** (deviceId), **imei**, **kp**, **terminal**.', 'type' => 'string', 'example' => 'uuid', 'title' => ''], + 'Value' => ['description' => 'The value of the device receiver.', 'type' => 'string', 'example' => 'fc35429dff9b473c81d7ef5f62ab11dc', 'title' => ''], + 'Mid' => ['description' => 'The message ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '33566', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', 'example' => '', ], - 'ObjectKey' => [ - 'description' => '', - 'type' => 'string', - 'example' => '1151125281886341/375KZRO8TARYBQY7P0E4/2019-04-12/1555062240807.jpg', - ], - 'InitUsageTypeDesc' => [ - 'description' => '', - 'type' => 'string', - 'example' => '0', - ], - 'InitUsageType' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'DeviceBrand' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'ROEWE', - ], ], + 'title' => '', + 'example' => '', ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '9c7a3b09-a69a-43f5-8bf2-84f7119810eb', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '629586FE-CB2E-4742-995E-121F952CEB72', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"9c7a3b09-a69a-43f5-8bf2-84f7119810eb\\",\\n \\"DeviceModel\\": {\\n \\"DeviceModelId\\": 10,\\n \\"HardwareType\\": \\"sn\\",\\n \\"DeviceName\\": \\"device\\",\\n \\"DeviceType\\": \\"智能家居\\",\\n \\"CanCreateDeviceId\\": 1,\\n \\"ProjectId\\": \\"projectTest\\",\\n \\"OsPlatform\\": \\"android\\",\\n \\"DeviceModel\\": \\"ROEWE RX5\\",\\n \\"SecurityChip\\": \\"0\\",\\n \\"DeviceLogoUrl\\": \\"http://dis-cdn.aicc.aliyun.com/1151125281886341/375KZRO8TARYBQY7P0E4/2019-04-12/1555062240807.jpg\\",\\n \\"Description\\": \\"荣威RX5\\",\\n \\"ObjectKey\\": \\"1151125281886341/375KZRO8TARYBQY7P0E4/2019-04-12/1555062240807.jpg\\",\\n \\"InitUsageTypeDesc\\": \\"0\\",\\n \\"InitUsageType\\": 0,\\n \\"DeviceBrand\\": \\"ROEWE\\"\\n }\\n}","errorExample":"{\\n \\"Code\\":\\"NoPermissionToAccessProject\\",\\n \\"HostId\\":\\"iovcc.cn-shanghai.aliyuncs.com\\",\\n \\"Message\\":\\"User is not authorized to access the specified project.\\",\\n \\"RequestId\\":\\"6F25F67C-F411-499F-BCE2-67CA563CB064\\"\\n}"},{"type":"xml","example":"<DescribeDeviceModelResponse>\\r\\n\\t<DeviceModel>\\r\\n\\t\\t<CanCreateDeviceId>1</CanCreateDeviceId>\\r\\n\\t\\t<Description>荣威 RX5</Description>\\r\\n\\t\\t<DeviceBrand>ROEWE</DeviceBrand>\\r\\n\\t\\t<DeviceModelId>10</DeviceModelId>\\r\\n\\t\\t<DeviceType>car_auto</DeviceType>\\r\\n\\t\\t<HardwareType>sn</HardwareType>\\r\\n\\t\\t<InitUsageType>0</InitUsageType>\\r\\n\\t\\t<InitUsageTypeDesc>private</InitUsageTypeDesc>\\r\\n\\t\\t<ProjectId>projectTest</ProjectId>\\r\\n <DeviceName>device</DeviceName>\\r\\n <ObjectKey>1151125281886341/375KZRO8TARYBQY7P0E4/2019-04-12/1555062240807.jpg</ObjectKey>\\r\\n <OsPlatform>android</OsPlatform>\\r\\n <SecurityChip>0</SecurityChip>\\r\\n\\t</DeviceModel>\\r\\n\\t<RequestId>E94C9864-56FB-44AD-AC0C-A1CEFB332254</RequestId>\\r\\n</DescribeDeviceModelResponse>","errorExample":""}]', - 'title' => 'DescribeDeviceModel', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"MessageReceivers\\": {\\n \\"Pagination\\": {\\n \\"PageIndex\\": 1,\\n \\"TotalPageCount\\": 30,\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 2\\n },\\n \\"List\\": [\\n {\\n \\"Type\\": \\"uuid\\",\\n \\"Value\\": \\"fc35429dff9b473c81d7ef5f62ab11dc\\",\\n \\"Mid\\": 33566\\n }\\n ]\\n },\\n \\"RequestId\\": \\"629586FE-CB2E-4742-995E-121F952CEB72\\"\\n}","type":"json"}]', + 'title' => 'Query message device receiver list by message ID', + 'summary' => 'Queries the list of message device receivers by message ID by calling ListMessageReceivers.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'DescribeDeviceOnlineInfo' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [ + ['createdAt' => '2024-06-18T02:20:26.000Z', 'description' => 'Error codes changed'], + ], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'iovcc:ListMessageReceivers', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'ListNamespaces' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'ProjectId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'sghghshr', - ], + 'schema' => ['description' => 'The project ID.', 'type' => 'string', 'required' => true, 'example' => 'PIY3UB0T', 'title' => ''], ], [ - 'name' => 'Type', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'deviceId', - ], - ], - [ - 'name' => 'Value', + 'name' => 'AuthType', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'c86b36f1d19c488f9ae3798f332b9fd5', - ], + 'schema' => ['description' => 'The data space partitioning and authentication method.'."\n" + ."\n" + .'- 1: account-based'."\n" + .'- 2: device-based'."\n" + .'- 101: account and device-based.', 'type' => 'string', 'required' => false, 'example' => '101', 'title' => ''], ], ], 'responses' => [ @@ -13250,140 +10629,101 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '629586FE-CB2E-4742-995E-121F952CEB72', - ], - 'Devices' => [ - 'description' => '', + 'Namespaces' => [ + 'description' => 'The collection of namespaces.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'LoginTime' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1525701500000', - ], - 'DeviceId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'fc71429ddd9b473c81d7ef5f33ab10cc', - ], - 'Online' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'ProjectId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'gsgshhfs', - ], - 'IasId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '123xxxxxxxxxxx', - ], - 'SystemVersion' => [ - 'description' => '', - 'type' => 'string', - 'example' => '5.3.0', - ], - 'Terminal' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'iphone7', - ], - 'ClientVersion' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2.1.0.1.20170327', - ], + 'AuthType' => ['description' => 'The data space partitioning and authentication method.'."\n" + ."\n" + .'- 1: account-based'."\n" + .'- 2: device-based'."\n" + .'- 101: account and device-based.', 'type' => 'integer', 'format' => 'int32', 'example' => '101', 'title' => ''], + 'Description' => ['description' => 'The description of the namespace.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'UserId' => ['description' => 'The ID of the tenant to which the namespace belongs.', 'type' => 'string', 'example' => '123456', 'title' => ''], + 'ProjectId' => ['description' => 'The ID of the project to which the namespace belongs.', 'type' => 'string', 'example' => 'PLR58HKB', 'title' => ''], + 'GmtCreate' => ['description' => 'The time when the namespace was created.', 'type' => 'integer', 'format' => 'int64', 'example' => '1526871654000', 'title' => ''], + 'Namespace' => ['description' => 'The unique identifier of the namespace.', 'type' => 'string', 'example' => 'cca8e86c056bdc4fe78751vbf3f26c7k', 'title' => ''], + 'GmtModified' => ['description' => 'The time when the namespace was last modified.', 'type' => 'integer', 'format' => 'int64', 'example' => '1526871654000', 'title' => ''], + 'Name' => ['description' => 'The name of the namespace.', 'type' => 'string', 'example' => 'test', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'E94C9864-56FB-44AD-AC0C-A1CEFB332254', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"629586FE-CB2E-4742-995E-121F952CEB72\\",\\n \\"Devices\\": [\\n {\\n \\"LoginTime\\": 1525701500000,\\n \\"DeviceId\\": \\"fc71429ddd9b473c81d7ef5f33ab10cc\\",\\n \\"Online\\": 1,\\n \\"ProjectId\\": \\"gsgshhfs\\",\\n \\"IasId\\": \\"123xxxxxxxxxxx\\",\\n \\"SystemVersion\\": \\"5.3.0\\",\\n \\"Terminal\\": \\"iphone7\\",\\n \\"ClientVersion\\": \\"2.1.0.1.20170327\\"\\n }\\n ]\\n}","errorExample":"{\\n \\"Code\\":\\"MissingParameter\\",\\n \\"Message\\":\\"The Type is mandatory for this action\\",\\n \\"HostId\\": \\"iovcc.cn-shanghai.aliyuncs.com\\",\\n \\"RequestId\\":\\"629586FE-CB2E-4742-995E-121F952CEB72\\"\\n}"},{"type":"xml","example":"<DescribeDeviceOnlineInfoResponse>\\r\\n\\t<Devices>\\r\\n\\t\\t<DeviceId>6c845cc9c4fe11138aff5be5e0aeebjj</DeviceId>\\r\\n\\t\\t<Terminal>iphone8</Terminal>\\r\\n\\t\\t<IasId></IasId>\\r\\n\\t\\t<ProjectId>PYNNN9KS</ProjectId>\\r\\n\\t\\t<ClientVersion>2.3.0.4.20170217</ClientVersion>\\r\\n\\t\\t<SystemVersion>1.0.1-E-20180330.1343</SystemVersion>\\r\\n\\t\\t<Online>0</Online>\\r\\n\\t\\t<LoginTime>1523452482291</LoginTime>\\r\\n\\t</Devices>\\r\\n\\t<RequestId>629586FE-CB2E-4742-995E-121F952CEB72</RequestId>\\r\\n</DescribeDeviceOnlineInfoResponse>","errorExample":""}]', - 'title' => 'DescribeDeviceOnlineInfo', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Namespaces\\": [\\n {\\n \\"AuthType\\": 101,\\n \\"Description\\": \\"test\\",\\n \\"UserId\\": \\"123456\\",\\n \\"ProjectId\\": \\"PLR58HKB\\",\\n \\"GmtCreate\\": 1526871654000,\\n \\"Namespace\\": \\"cca8e86c056bdc4fe78751vbf3f26c7k\\",\\n \\"GmtModified\\": 1526871654000,\\n \\"Name\\": \\"test\\"\\n }\\n ],\\n \\"RequestId\\": \\"E94C9864-56FB-44AD-AC0C-A1CEFB332254\\"\\n}","type":"json"}]', + 'title' => 'Query the namespace list of a specified project', + 'summary' => 'Queries the list of namespaces for a specified project by calling ListNamespaces.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'DescribeDeviceShadow' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [ + ['createdAt' => '2024-06-18T02:20:26.000Z', 'description' => 'Error codes changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'iovcc:ListNamespaces', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + ], + 'ListOfflineMessages' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'ProjectId', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'PIC3UA0V', - ], + 'schema' => ['description' => 'The number of entries per page in a paged query.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', 'title' => ''], ], [ - 'name' => 'DeviceId', + 'name' => 'ProjectId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '1ac5e182e9634252a02d442a4d5d16fc', - ], + 'schema' => ['description' => 'The ID of the iovcc project.', 'type' => 'string', 'required' => true, 'example' => 'sfgsghd6', 'title' => ''], ], [ - 'name' => 'DeviceModel', + 'name' => 'Type', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'model_2nd', - ], + 'schema' => ['description' => 'The query type for the offline message box. Valid values: **deviceId**, **kp**.', 'type' => 'string', 'required' => true, 'example' => 'deviceId', 'title' => ''], ], [ - 'name' => 'Path', + 'name' => 'Value', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '/', - ], + 'schema' => ['description' => 'The value corresponding to **deviceId** or **kp** (iasId).', 'type' => 'string', 'required' => true, 'example' => 'fc71429ddd9b473c81d7ef5f33ab10cc', 'title' => ''], ], [ - 'name' => 'ViewSubscribed', + 'name' => 'PageIndex', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], + 'schema' => ['description' => 'The page number in a paged query.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], ], 'responses' => [ @@ -13391,74 +10731,111 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '6F25F67C-F411-499F-BCE2-67CA563CB064', - ], - 'DeviceShadow' => [ - 'description' => '', + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '629586FE-CB2E-4742-995E-121F952CEB72', 'title' => ''], + 'OfflineMessages' => [ + 'description' => 'The paged query data object for offline messages.', 'type' => 'object', 'properties' => [ - 'DeviceShadow' => [ - 'description' => '', - 'type' => 'string', + 'Pagination' => [ + 'description' => 'The pagination object.', + 'type' => 'object', + 'properties' => [ + 'PageIndex' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'TotalPageCount' => ['description' => 'The total number of pages.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '30', 'title' => ''], + ], + 'title' => '', 'example' => '', ], - 'DeviceInfo' => [ - 'description' => '', - 'type' => 'string', + 'List' => [ + 'description' => 'The list of offline messages.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ExpiredTime' => ['description' => 'The expiration time of the message.', 'type' => 'integer', 'format' => 'int64', 'example' => '1525693420000', 'title' => ''], + 'Mid' => ['description' => 'The message ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '106577', 'title' => ''], + 'GmtCreate' => ['description' => 'The creation time of the message.', 'type' => 'integer', 'format' => 'int64', 'example' => '1525517606000', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"6F25F67C-F411-499F-BCE2-67CA563CB064\\",\\n \\"DeviceShadow\\": {\\n \\"DeviceShadow\\": \\"[{\\\\\\\\\\\\\\"id\\\\\\\\\\\\\\":10102,\\\\\\\\\\\\\\"name\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"车门:车门\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"open\\\\\\\\\\\\\\":true,\\\\\\\\\\\\\\"pId\\\\\\\\\\\\\\":101,\\\\\\\\\\\\\\"path\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"/车身与HVAC/车门/车门\\\\\\\\\\\\\\"},{\\\\\\\\\\\\\\"id\\\\\\\\\\\\\\":10101,\\\\\\\\\\\\\\"name\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"锁止状态:1\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"open\\\\\\\\\\\\\\":true,\\\\\\\\\\\\\\"pId\\\\\\\\\\\\\\":101,\\\\\\\\\\\\\\"path\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"/车身与HVAC/车门/锁止状态\\\\\\\\\\\\\\"}]\\",\\n \\"DeviceInfo\\": \\"{\\\\\\\\\\\\\\"schema版本\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"1.0\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"uuid\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"002\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"制造商\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"0110446as34\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"对内型号\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"test_model_product\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"对外型号\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"test_model\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"插件版本号\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"插件版本号\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"1.0\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"远程控制\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"1.0\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"远程诊断\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"1.0\\\\\\\\\\\\\\"},\\\\\\\\\\\\\\"数据更新时间\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"2018-09-14 22:00:01\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"最近登录账号ID\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"4***********\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"系统版本号\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"1.0.0\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"设备品牌\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"003\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"设备描述\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"sample desc1\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"车架号\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"001\\\\\\\\\\\\\\"}\\"\\n }\\n}","errorExample":"{\\n \\"RequestId\\": \\"6F25F67C-F411-499F-BCE2-67CA563CB064\\",\\n \\"HostId\\": \\"iovcc.cn-shanghai.aliyuncs.com\\",\\n \\"Code\\": \\"InvalidTenant\\",\\n \\"Message\\": \\"User is not a valid tenant\\"\\n}"},{"type":"xml","example":"<DeviceShadow>\\n <DeviceInfo>{\\"车架号\\":\\"001\\",\\"对外型号\\":\\"test_model\\",\\"最近登录账号ID\\":\\"439********\\",\\"对内型号\\":\\"test_model_product\\",\\"系统版本号\\":\\"1.0.0\\",\\"数据更新时间\\":\\"2018-09-14 21:49:29\\",\\"制造商\\":\\"0110446as34\\",\\"设备描述\\":\\"sample desc1\\",\\"设备品牌\\":\\"003\\",\\"插件版本号\\":{\\"远程诊断\\":\\"1.0\\",\\"远程控制\\":\\"1.0\\",\\"插件版本号\\":\\"1.0\\"},\\"uuid\\":\\"002\\",\\"schema版本\\":\\"1.0\\"}</DeviceInfo>\\n <DeviceShadow>[{\\"path\\":\\"/车身与HVAC/车门/引擎盖状态\\",\\"name\\":\\"引擎盖状态:3\\",\\"pId\\":101,\\"id\\":10103,\\"open\\":true},{\\"path\\":\\"/车身与HVAC/车门/车门\\",\\"name\\":\\"车门:车门\\",\\"pId\\":101,\\"id\\":10102,\\"open\\":true},{\\"path\\":\\"/车身与HVAC/车门/锁止状态\\",\\"name\\":\\"锁止状态:1\\",\\"pId\\":101,\\"id\\":10101,\\"open\\":true}]</DeviceShadow>\\n</DeviceShadow>\\n<RequestId>40FE5EA3-F4D3-4D4B-99BD-2F5B7B90DE7E</RequestId>","errorExample":""}]', - 'title' => 'DescribeDeviceShadow', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"629586FE-CB2E-4742-995E-121F952CEB72\\",\\n \\"OfflineMessages\\": {\\n \\"Pagination\\": {\\n \\"PageIndex\\": 1,\\n \\"TotalPageCount\\": 2,\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 30\\n },\\n \\"List\\": [\\n {\\n \\"ExpiredTime\\": 1525693420000,\\n \\"Mid\\": 106577,\\n \\"GmtCreate\\": 1525517606000\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'Query device offline messages', + 'summary' => 'Queries the list of offline messages for a device by deviceId or kp.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'DescribeVersionDeviceGroup' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [ + ['createdAt' => '2024-06-18T02:20:26.000Z', 'description' => 'Error codes changed'], + ], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'iovcc:ListOfflineMessages', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'ListOpenAccountLinks' => [ + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'ProjectId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'P0VFCREU', - ], + 'schema' => ['description' => 'The project ID.', 'type' => 'string', 'required' => false, 'example' => 'projectTest', 'title' => ''], ], [ - 'name' => 'Id', + 'name' => 'IdentityId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '1', - ], + 'schema' => ['description' => 'The cloud user ID.'."\n" + ."\n" + .'This parameter and **idToken+Idp** cannot both be empty.', 'type' => 'string', 'required' => false, 'example' => 'identityidtest', 'title' => ''], + ], + [ + 'name' => 'Idp', + 'in' => 'query', + 'schema' => ['description' => 'The account authentication provider.'."\n" + ."\n" + .'**IdentityId+Idp** cannot both be empty.', 'type' => 'string', 'required' => false, 'example' => 'ALIOS', 'title' => ''], + ], + [ + 'name' => 'OpenId', + 'in' => 'query', + 'schema' => ['description' => 'The third-party account platform ID.', 'type' => 'string', 'required' => false, 'example' => '12345', 'title' => ''], ], ], 'responses' => [ @@ -13466,95 +10843,112 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '6F25F67C-F411-499F-BCE2-67CA563CB064', - ], - 'DeviceGroup' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'GmtModify' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2018-01-01 00:01:00', - ], - 'Description' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'GmtCreate' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2018-01-01 00:00:00', - ], - 'Name' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'Id' => [ - 'description' => 'ID', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'MaxCount' => [ - 'description' => '', - 'type' => 'string', - 'example' => '100', + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '9c7a3b09-a69a-43f5-8bf2-84f7119810eb', 'title' => ''], + 'OpenAccounts' => [ + 'description' => 'The response content.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Status' => ['description' => 'The status.'."\n" + ."\n" + .'Valid values:'."\n" + .'- 0: Normal.'."\n" + .'- 1: Disabled.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'Type' => ['description' => 'The type.'."\n" + ."\n" + .'Valid values:'."\n" + .'- 1: third-party linked account.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'DisplayName' => ['description' => 'The display name.', 'type' => 'string', 'example' => 'displaynametest', 'title' => ''], + 'CreateAccessKey' => ['description' => 'The AccessKey created for the account.', 'type' => 'string', 'example' => 'createaccesskeytest', 'title' => ''], + 'OpenId' => ['description' => 'The third-party platform account ID.', 'type' => 'string', 'example' => '12345', 'title' => ''], + 'Mobile' => ['description' => 'The mobile phone number.', 'type' => 'string', 'example' => '1390000****', 'title' => ''], + 'Region' => ['description' => 'The region.', 'type' => 'string', 'example' => 'cn', 'title' => ''], + 'IdentityId' => ['description' => 'The account ID.', 'type' => 'string', 'example' => 'identityidtest', 'title' => ''], + 'LoginId' => ['description' => 'The logon name.', 'type' => 'string', 'example' => 'loginidtest', 'title' => ''], + 'Idp' => ['description' => 'The short name of the third-party platform identifier.', 'type' => 'string', 'example' => 'ALIOS', 'title' => ''], + 'AliyunId' => ['description' => 'The tenant ID.', 'type' => 'string', 'example' => 'aliyunidtest', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"6F25F67C-F411-499F-BCE2-67CA563CB064\\",\\n \\"DeviceGroup\\": {\\n \\"GmtModify\\": \\"2018-01-01 00:01:00\\",\\n \\"Description\\": \\"测试\\",\\n \\"GmtCreate\\": \\"2018-01-01 00:00:00\\",\\n \\"Name\\": \\"升级分组\\",\\n \\"Id\\": 1,\\n \\"MaxCount\\": \\"100\\"\\n }\\n}","errorExample":"{\\n \\"RequestId\\": \\"6F25F67C-F411-499F-BCE2-67CA563CB064\\",\\n \\"HostId\\": \\"iovcc.cn-shanghai.aliyuncs.com\\",\\n \\"Code\\": \\"NoPermissionToAccessProject\\",\\n \\"Message\\": \\"User is not authorized to access the specified project.\\"\\n}"},{"type":"xml","example":"<DescribeVersionDeviceGroupResponse>\\r\\n\\t<RequestId>6F25F67C-F411-499F-BCE2-67CA563CB064</RequestId>\\r\\n\\t<DeviceGroup>\\r\\n\\t\\t<Id>1</Id>\\r\\n\\t\\t<Name>升级分组</Name>\\r\\n\\t\\t<Description>测试</Description>\\r\\n\\t\\t<GmtCreate>2018-01-01 00:00:00</GmtCreate>\\r\\n\\t\\t<GmtModify>2018-01-01 00:01:00</GmtModify>\\r\\n\\t</DeviceGroup>\\r\\n</DescribeVersionDeviceGroupResponse>","errorExample":""}]', - 'title' => 'DescribeVersionDeviceGroup', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9c7a3b09-a69a-43f5-8bf2-84f7119810eb\\",\\n \\"OpenAccounts\\": [\\n {\\n \\"Status\\": 0,\\n \\"Type\\": 1,\\n \\"DisplayName\\": \\"displaynametest\\",\\n \\"CreateAccessKey\\": \\"createaccesskeytest\\",\\n \\"OpenId\\": \\"12345\\",\\n \\"Mobile\\": \\"1390000****\\",\\n \\"Region\\": \\"cn\\",\\n \\"IdentityId\\": \\"identityidtest\\",\\n \\"LoginId\\": \\"loginidtest\\",\\n \\"Idp\\": \\"ALIOS\\",\\n \\"AliyunId\\": \\"aliyunidtest\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'Query account list by third-party account ID', + 'summary' => 'Queries the list of accounts by third-party account ID by calling ListOpenAccountLinks.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'QueryPrepublishPassedDeviceCount' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [ + ['createdAt' => '2024-06-18T02:20:26.000Z', 'description' => 'Error codes changed'], + ], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'iovcc:ListOpenAccountLinks', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'ListOpenAccounts' => [ + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'ProjectId', + 'name' => 'Length', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'P0VFCREU', - ], + 'schema' => ['description' => 'The maximum length of the returned list.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', 'title' => ''], ], [ - 'name' => 'PrepublishId', + 'name' => 'Start', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '1', - ], + 'schema' => ['description' => 'The start position of the returned list.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'Mobile', + 'in' => 'query', + 'schema' => ['description' => 'The mobile phone number.', 'type' => 'string', 'required' => false, 'example' => '1390000****', 'title' => ''], + ], + [ + 'name' => 'Email', + 'in' => 'query', + 'schema' => ['description' => 'The email address.', 'type' => 'string', 'required' => false, 'example' => 'test@alibaba.com', 'title' => ''], + ], + [ + 'name' => 'DisplayName', + 'in' => 'query', + 'schema' => ['description' => 'The display name.', 'type' => 'string', 'required' => false, 'example' => 'displaynametest', 'title' => ''], + ], + [ + 'name' => 'ProjectId', + 'in' => 'query', + 'schema' => ['description' => 'The project ID.', 'type' => 'string', 'required' => false, 'example' => 'projectTest', 'title' => ''], ], ], 'responses' => [ @@ -13562,169 +10956,171 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '6F25F67C-F411-499F-BCE2-67CA563CB064', - ], - 'Count' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1000', + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '9c7a3b09-a69a-43f5-8bf2-84f7119810eb', 'title' => ''], + 'OpenAccounts' => [ + 'description' => 'The returned content.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Status' => ['description' => 'The status.'."\n" + ."\n" + .'Valid values:'."\n" + .'- 0: Normal.'."\n" + .'- 1: Disabled.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'Type' => ['description' => 'The type.'."\n" + ."\n" + .'Valid values:'."\n" + .'- 1: third-party linked account.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'DisplayName' => ['description' => 'The display name.', 'type' => 'string', 'example' => 'displaynametest', 'title' => ''], + 'CreateAccessKey' => ['description' => 'The AccessKey created for the account.', 'type' => 'string', 'example' => 'createaccesskeytest', 'title' => ''], + 'OpenId' => ['description' => 'The account ID on the third-party platform.', 'type' => 'string', 'example' => '12345', 'title' => ''], + 'Mobile' => ['description' => 'The mobile phone number.', 'type' => 'string', 'example' => '1390000****', 'title' => ''], + 'Region' => ['description' => 'The region.', 'type' => 'string', 'example' => 'cn', 'title' => ''], + 'IdentityId' => ['description' => 'The account ID.', 'type' => 'string', 'example' => 'identityidtest', 'title' => ''], + 'LoginId' => ['description' => 'The logon name.', 'type' => 'string', 'example' => 'loginidtest', 'title' => ''], + 'Idp' => ['description' => 'The short name of the third-party platform identifier.', 'type' => 'string', 'example' => 'ALIOS', 'title' => ''], + 'AliyunId' => ['description' => 'The tenant ID.', 'type' => 'string', 'example' => 'aliyunidtest', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Count\\": 1000,\\n \\"RequestId\\": \\"6F25F67C-F411-499F-BCE2-67CA563CB064\\"\\n}","errorExample":"{\\n \\"RequestId\\": \\"6F25F67C-F411-499F-BCE2-67CA563CB064\\",\\n \\"HostId\\": \\"iovcc.cn-shanghai.aliyuncs.com\\",\\n \\"Code\\": \\"NoPermission.NotOwner\\",\\n \\"Message\\": \\"You have no permission because you are not the owner of the data\\"\\n}"},{"type":"xml","example":"<QueryPrepublishPassedDeviceCountResponse>\\r\\n\\t<RequestId>6F25F67C-F411-499F-BCE2-67CA563CB064</RequestId>\\r\\n\\t<Count>1000</Count>\\r\\n</QueryPrepublishPassedDeviceCountResponse>","errorExample":""}]', - 'title' => 'QueryPrepublishPassedDeviceCount', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9c7a3b09-a69a-43f5-8bf2-84f7119810eb\\",\\n \\"OpenAccounts\\": [\\n {\\n \\"Status\\": 0,\\n \\"Type\\": 1,\\n \\"DisplayName\\": \\"displaynametest\\",\\n \\"CreateAccessKey\\": \\"createaccesskeytest\\",\\n \\"OpenId\\": \\"12345\\",\\n \\"Mobile\\": \\"1390000****\\",\\n \\"Region\\": \\"cn\\",\\n \\"IdentityId\\": \\"identityidtest\\",\\n \\"LoginId\\": \\"loginidtest\\",\\n \\"Idp\\": \\"ALIOS\\",\\n \\"AliyunId\\": \\"aliyunidtest\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'Query account list', + 'summary' => 'Queries a list of accounts by calling ListOpenAccounts.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'ListVersionDeviceGroups' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [ + ['createdAt' => '2024-06-18T02:20:26.000Z', 'description' => 'Error codes changed'], ], - 'schemes' => [ - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], - 'security' => [ + 'ramActions' => [ [ - 'AK' => [], + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'iovcc:ListOpenAccounts', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], ], - 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - ], - 'parameters' => [ + ], + 'ListPreChecks' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'ProjectId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'P0VFCREU', - ], + 'AK' => [], ], ], + 'operationType' => 'read', + 'systemTags' => ['operationType' => 'list'], + 'parameters' => [], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '6F25F67C-F411-499F-BCE2-67CA563CB064', - ], - 'DeviceGroupList' => [ - 'description' => '', + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'BB80AC68-1E8A-4A46-B348-7D875AE9132A', 'title' => ''], + 'PreChecks' => [ + 'description' => 'The dry run results.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'GmtModify' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2018-01-01 00:01:00', - ], - 'Description' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'GmtCreate' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2018-01-01 00:00:00', - ], - 'Name' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'Id' => [ - 'description' => 'ID', - 'type' => 'string', - 'example' => '1', - ], + 'Key' => ['description' => 'The check item.', 'type' => 'string', 'example' => 'IovccEnabled', 'title' => ''], + 'Link' => ['description' => 'The homepage of the check item.', 'type' => 'string', 'example' => 'https://www.aliyun.com/product/iovcc', 'title' => ''], + 'Price' => ['description' => 'The billing mode of the check item.', 'type' => 'string', 'example' => 'FreeTrial', 'title' => ''], + 'State' => ['description' => 'The check result.', 'type' => 'string', 'example' => 'Enabled', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"6F25F67C-F411-499F-BCE2-67CA563CB064\\",\\n \\"DeviceGroupList\\": [\\n {\\n \\"GmtCreate\\": \\"2018-01-01 00:00:00\\",\\n \\"GmtModify\\": \\"2018-01-01 00:01:00\\",\\n \\"Description\\": \\"测试\\",\\n \\"Name\\": \\"升级分组\\",\\n \\"Id\\": \\"1\\"\\n }\\n ]\\n}","errorExample":"{\\n \\"RequestId\\": \\"6F25F67C-F411-499F-BCE2-67CA563CB064\\",\\n \\"HostId\\": \\"iovcc.cn-shanghai.aliyuncs.com\\",\\n \\"Code\\": \\"NoPermissionToAccessProject\\",\\n \\"Message\\": \\"User is not authorized to access the specified project.\\"\\n}"},{"type":"xml","example":"<ListVersionDeviceGroupsResponse>\\r\\n\\t<RequestId>6F25F67C-F411-499F-BCE2-67CA563CB064</RequestId>\\r\\n\\t<DeviceGroupList>\\r\\n\\t\\t<Id>1</Id>\\r\\n\\t\\t<Name>升级分组</Name>\\r\\n\\t\\t<Description>测试</Description>\\r\\n\\t\\t<GmtCreate>2018-01-01 00:00:00</GmtCreate>\\r\\n\\t\\t<GmtModify>2018-01-01 00:01:00</GmtModify>\\r\\n\\t</DeviceGroupList>\\r\\n</ListVersionDeviceGroupsResponse>","errorExample":""}]', - 'title' => 'ListVersionDeviceGroups', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BB80AC68-1E8A-4A46-B348-7D875AE9132A\\",\\n \\"PreChecks\\": [\\n {\\n \\"Key\\": \\"IovccEnabled\\",\\n \\"Link\\": \\"https://www.aliyun.com/product/iovcc\\",\\n \\"Price\\": \\"FreeTrial\\",\\n \\"State\\": \\"Enabled\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'Query dry run results', + 'summary' => 'Calls ListPreChecks to query the dry run results.', + 'description' => '> Queries whether the user has activated this service and other dependent Alibaba Cloud services.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'ListAssistDevices' => [ - 'methods' => [ - 'get', + 'changeSet' => [ + ['createdAt' => '2024-06-18T02:20:26.000Z', 'description' => 'Error codes changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'iovcc:ListPreChecks', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + ], + 'ListProjectApps' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'ProjectId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'PZ1HK7JZ', - ], + 'schema' => ['description' => 'The project ID.', 'type' => 'string', 'required' => true, 'example' => '11', 'title' => ''], ], [ 'name' => 'PageIndex', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '1', - ], + 'schema' => ['description' => 'The current page number, starting from **1**.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], [ - 'name' => 'Condition', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '{"vin":"LVFAG7A31HK000029"}', - ], + 'schema' => ['description' => 'The number of records per page. Default value: **10**.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], ], [ - 'name' => 'PerPage', + 'name' => 'Keywords', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '20', - ], + 'schema' => ['description' => 'The keyword for the application name or package name.', 'type' => 'string', 'required' => false, 'example' => 'app', 'title' => ''], ], ], 'responses' => [ @@ -13732,166 +11128,178 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'TotalCount' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '35', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '9c7a3b09-a69a-43f5-8bf2-84f7119810eb', - ], - 'PerPage' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '20', - ], - 'PageIndex' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'Devices' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'SerialNumber' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'DX3JNY1FDTD2', - ], - 'HardwareId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'BALFL8429HI', - ], - 'DeviceName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Model S', - ], - 'AccessTime' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1525767660000', - ], - 'DeviceId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '6fde56979c484b93b99fba257e3cbe83', - ], - 'UUID' => [ - 'description' => '', - 'type' => 'string', - 'example' => '842972B2C0F4C9F030E60769CA65806A', - ], - 'VIN' => [ + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'A15971B1-DC63-4AEC-A8B1-85CB8CD78227', 'title' => ''], + 'Result' => [ + 'description' => 'The query result.', + 'type' => 'object', + 'properties' => [ + 'ProjectApps' => [ + 'description' => 'The list of applications.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Status' => ['description' => 'The application status.'."\n" + ."\n" + .'A value of 0 indicates normal. A value of 1 indicates deleted.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'ProjectId' => ['description' => 'The ID of the project to which the application belongs.', 'type' => 'string', 'example' => '11', 'title' => ''], + 'UserId' => ['description' => 'The ID of the user to which the application belongs.', 'type' => 'string', 'example' => '1768723179523459', 'title' => ''], + 'GmtModified' => ['description' => 'The modification time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1524736376000', 'title' => ''], + 'AppPkgName' => ['description' => 'The application package name.', 'type' => 'string', 'example' => 'com.app1', 'title' => ''], + 'AppName' => ['description' => 'The application name.', 'type' => 'string', 'example' => 'app1', 'title' => ''], + 'AppSecret' => ['description' => 'The AppSecret of the application.'."\n" + ."\n" + .'By default, the value is partially masked and only the first and last two characters are displayed.', 'type' => 'string', 'example' => 'Q******F', 'title' => ''], + 'AppKey' => ['description' => 'The AppKey of the application.', 'type' => 'string', 'example' => 'mPp7O4LW', 'title' => ''], + 'AppId' => ['description' => 'The AppId of the application.', 'type' => 'string', 'example' => 'AX4R4JWQ', 'title' => ''], + 'OsType' => ['description' => 'The operating system type. A value of 1 indicates Android.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'GmtCreate' => ['description' => 'The creation time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1524736376000', 'title' => ''], + 'Id' => ['description' => 'The primary key ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '78', 'title' => ''], + ], 'description' => '', - 'type' => 'string', - 'example' => 'LVFAG7A31HK000029', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], + 'TotalPage' => ['description' => 'The total number of pages.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of records.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"PageIndex\\": 1,\\n \\"RequestId\\": \\"9c7a3b09-a69a-43f5-8bf2-84f7119810eb\\",\\n \\"TotalCount\\": 35,\\n \\"PerPage\\": 20,\\n \\"Devices\\": [\\n {\\n \\"SerialNumber\\": \\"DX3JNY1FDTD2\\",\\n \\"HardwareId\\": \\"BALFL8429HI\\",\\n \\"DeviceName\\": \\"Model S\\",\\n \\"AccessTime\\": 1525767660000,\\n \\"DeviceId\\": \\"6fde56979c484b93b99fba257e3cbe83\\",\\n \\"UUID\\": \\"842972B2C0F4C9F030E60769CA65806A\\",\\n \\"VIN\\": \\"LVFAG7A31HK000029\\"\\n }\\n ]\\n}","errorExample":"{\\n \\"Code\\":\\"NoPermissionToAccessProject\\",\\n \\"HostId\\":\\"iovcc.cn-shanghai.aliyuncs.com\\",\\n \\"Message\\":\\"User is not authorized to access the specified project.\\",\\n \\"RequestId\\":\\"6F25F67C-F411-499F-BCE2-67CA563CB064\\"\\n}"},{"type":"xml","example":"<ListAssistDevicesResponse>\\r\\n\\t<RequestId>6F0A833B-7A86-4D92-A083-C184041E2F2D</RequestId>\\r\\n\\t<PageIndex>1</PageIndex>\\r\\n\\t<PerPage>20</PerPage>\\r\\n\\t<TotalCount>1</TotalCount>\\r\\n\\t<DeviceList>\\r\\n\\t\\t<DeviceId>37aac8e7d96c42ea94fd5408e351474e</DeviceId>\\r\\n\\t\\t<DeviceName>Model S</DeviceName>\\r\\n\\t\\t<AccessTime>1525767660000</AccessTime>\\r\\n\\t\\t<VIN>LVFAG7A31HK000029</VIN>\\r\\n\\t\\t<SerialNumber>DX3JNY1FDTD2</SerialNumber>\\r\\n\\t</DeviceList>\\r\\n</ListAssistDevicesResponse>","errorExample":""}]', - 'title' => 'ListAssistDevices', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A15971B1-DC63-4AEC-A8B1-85CB8CD78227\\",\\n \\"Result\\": {\\n \\"ProjectApps\\": [\\n {\\n \\"Status\\": 0,\\n \\"ProjectId\\": \\"11\\",\\n \\"UserId\\": \\"1768723179523459\\",\\n \\"GmtModified\\": 1524736376000,\\n \\"AppPkgName\\": \\"com.app1\\",\\n \\"AppName\\": \\"app1\\",\\n \\"AppSecret\\": \\"Q******F\\",\\n \\"AppKey\\": \\"mPp7O4LW\\",\\n \\"AppId\\": \\"AX4R4JWQ\\",\\n \\"OsType\\": 1,\\n \\"GmtCreate\\": 1524736376000,\\n \\"Id\\": 78\\n }\\n ],\\n \\"TotalPage\\": 1,\\n \\"TotalCount\\": 1\\n }\\n}","type":"json"}]', + 'title' => 'Query all custom applications', + 'summary' => 'Queries all custom applications in a project by project ID.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'ListConnectLogs' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [ + ['createdAt' => '2024-06-18T02:20:26.000Z', 'description' => 'Error codes changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'iovcc:ListProjectApps', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'ListProjects' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - ], - 'parameters' => [ - [ - 'name' => 'PageSize', - 'in' => 'query', + 'systemTags' => ['operationType' => 'get'], + 'parameters' => [], + 'responses' => [ + 200 => [ 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '3305DEE5-4020-4FF0-9D42-5882B1580088', 'title' => ''], + 'Projects' => [ + 'description' => 'The project list information.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Status' => ['description' => 'The status. A value of 0 indicates normal.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'Description' => ['description' => 'The project description.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'UserId' => ['description' => 'The ID of the user to whom the project belongs.', 'type' => 'string', 'example' => '1768723179523459', 'title' => ''], + 'ProjectId' => ['description' => 'The project ID.', 'type' => 'string', 'example' => '11', 'title' => ''], + 'GmtCreate' => ['description' => 'The creation time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1508341160000', 'title' => ''], + 'GmtModified' => ['description' => 'The modification time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1525687817000', 'title' => ''], + 'Name' => ['description' => 'The project name.', 'type' => 'string', 'example' => 'aicc_test11', 'title' => ''], + 'Id' => ['description' => 'The primary key ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '11', 'title' => ''], + 'Creator' => ['description' => 'The project creator.', 'type' => 'string', 'example' => 'user001', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '20', + 'title' => '', + 'example' => '', ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3305DEE5-4020-4FF0-9D42-5882B1580088\\",\\n \\"Projects\\": [\\n {\\n \\"Status\\": 0,\\n \\"Description\\": \\"test\\",\\n \\"UserId\\": \\"1768723179523459\\",\\n \\"ProjectId\\": \\"11\\",\\n \\"GmtCreate\\": 1508341160000,\\n \\"GmtModified\\": 1525687817000,\\n \\"Name\\": \\"aicc_test11\\",\\n \\"Id\\": 11,\\n \\"Creator\\": \\"user001\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'Query project list', + 'summary' => 'Queries a list of projects by calling ListProjects.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2024-06-13T11:40:24.000Z', 'description' => 'Error codes changed'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ [ - 'name' => 'ProjectId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'fgsggsgg', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'iovcc:ListProjects', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + ], + 'ListRpcServices' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'DeviceId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'fc35429dff9b473c81d7ef5f62ab11dc', - ], + 'AK' => [], ], + ], + 'operationType' => 'read', + 'systemTags' => ['operationType' => 'list'], + 'parameters' => [ [ - 'name' => 'StartTime', + 'name' => 'ProjectId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1525684245', - ], + 'schema' => ['description' => 'The ID of the IoVCC project.', 'type' => 'string', 'required' => true, 'example' => 'sfgsghd6', 'title' => ''], ], [ - 'name' => 'EndTime', + 'name' => 'PageIndex', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1525694245', - ], + 'schema' => ['description' => 'The page number for the paged query.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], [ - 'name' => 'PageIndex', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'The number of entries per page for the paged query.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', 'title' => ''], ], ], 'responses' => [ @@ -13899,194 +11307,224 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '629586FE-CB2E-4742-995E-121F952CEB72', - ], - 'Logs' => [ - 'description' => '', + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '629586FE-CB2E-4742-995E-121F952CEB72', 'title' => ''], + 'RpcServices' => [ + 'description' => 'The paging query data object for RPC service interfaces.', 'type' => 'object', 'properties' => [ 'Pagination' => [ - 'description' => '', + 'description' => 'The pagination object.', 'type' => 'object', 'properties' => [ - 'PageIndex' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'TotalPageCount' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - 'PageSize' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '20', - ], - 'TotalCount' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '30', - ], + 'PageIndex' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'TotalPageCount' => ['description' => 'The total number of pages.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '30', 'title' => ''], ], + 'title' => '', + 'example' => '', ], 'List' => [ - 'description' => '', + 'description' => 'The list of RPC service interface registrations.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'Sid' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'rkp_u-sTz_1_29473_1525516404577', - ], - 'Status' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'Time' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1525517083249', - ], - 'DeviceId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'fc71429ddd9b473c81d7ef5f44ab10cc', - ], - 'SystemVersion' => [ - 'description' => '', - 'type' => 'string', - 'example' => '4.4.4', - ], - 'Ip' => [ - 'description' => '', - 'type' => 'string', - 'example' => '220.180.xx.xxx', - ], - 'NetWorking' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'EDGE', - ], - 'Terminal' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'iphone7', - ], + 'MethodName' => ['description' => 'The method name.', 'type' => 'string', 'example' => 'rpcTest', 'title' => ''], + 'Type' => ['description' => 'The invocation type. Valid values: http and hsf.', 'type' => 'string', 'example' => 'http', 'title' => ''], + 'InterfaceName' => ['description' => 'The interface name.', 'type' => 'string', 'example' => 'https://portal.aicc.aliyun.com/rpcServiceTest.html', 'title' => ''], + 'Params' => ['description' => 'The interface parameters.', 'type' => 'string', 'example' => 'param1,param2', 'title' => ''], + 'AppKey' => ['description' => 'The appKey of the CMNS client application.', 'type' => 'string', 'example' => 'aorlFafJ', 'title' => ''], + 'GroupName' => ['description' => 'The service group name.', 'type' => 'string', 'example' => 'lbs', 'title' => ''], + 'GmtCreate' => ['description' => 'The time when the service was registered.', 'type' => 'integer', 'format' => 'int64', 'example' => '1525684245000', 'title' => ''], + 'IsDelete' => ['description' => 'Indicates whether the record is logically deleted. Valid values:'."\n" + .'- **Y**: Deleted.'."\n" + .'- **N**: Not deleted.', 'type' => 'string', 'example' => 'N', 'title' => ''], + 'VersionCode' => ['description' => 'The version number.', 'type' => 'string', 'example' => '2018-05-01', 'title' => ''], + 'GmtModified' => ['description' => 'The time when the service was last modified.', 'type' => 'integer', 'format' => 'int64', 'example' => '1525684245000', 'title' => ''], + 'Id' => ['description' => 'The record ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"629586FE-CB2E-4742-995E-121F952CEB72\\",\\n \\"Logs\\": {\\n \\"List\\": [\\n {\\n \\"Sid\\": \\"rkp_u-sTz_1_29473_1525516404577\\",\\n \\"Status\\": \\"断开\\",\\n \\"Time\\": 1525517083249,\\n \\"DeviceId\\": \\"fc71429ddd9b473c81d7ef5f44ab10cc\\",\\n \\"SystemVersion\\": \\"4.4.4\\",\\n \\"Ip\\": \\"220.180.xx.xxx\\",\\n \\"NetWorking\\": \\"EDGE\\",\\n \\"Terminal\\": \\"iphone7\\"\\n }\\n ],\\n \\"Pagination\\": {\\n \\"PageIndex\\": 1,\\n \\"TotalPageCount\\": 2,\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 30\\n }\\n }\\n}","errorExample":"{\\n \\"Code\\":\\"MissingParameter\\",\\n \\"Message\\":\\"The DeviceId is mandatory for this action\\",\\n \\"HostId\\": \\"iovcc.cn-shanghai.aliyuncs.com\\",\\n \\"RequestId\\":\\"629586FE-CB2E-4742-995E-121F952CEB72\\"\\n}"},{"type":"xml","example":"<ListConnectLogsResponse>\\r\\n\\t<Logs>\\r\\n\\t\\t<Pagination>\\r\\n\\t\\t\\t<TotalCount>10</TotalCount>\\r\\n\\t\\t\\t<TotalPageCount>1</TotalPageCount>\\r\\n\\t\\t\\t<PageIndex>1</PageIndex>\\r\\n\\t\\t\\t<PageSize>20</PageSize>\\r\\n\\t\\t</Pagination>\\r\\n\\t\\t<List>\\r\\n\\t\\t\\t<DeviceId>3583820a2cf941a8810b3e0a2435b13d</DeviceId>\\r\\n\\t\\t\\t<SystemVersion>4.4.4</SystemVersion>\\r\\n\\t\\t\\t<Terminal>MuMu</Terminal>\\r\\n\\t\\t\\t<Ip>::ffff:112.10.xx.xx</Ip>\\r\\n\\t\\t\\t<NetWorking>wifi</NetWorking>\\r\\n\\t\\t\\t<Time>1525517083250</Time>\\r\\n\\t\\t\\t<Status>连接</Status>\\r\\n\\t\\t\\t<Sid>Hymmibopf_1_29473_1525517083243</Sid>\\r\\n\\t\\t</List>\\r\\n\\t\\t<List>\\r\\n\\t\\t\\t<DeviceId />\\r\\n\\t\\t\\t<SystemVersion />\\r\\n\\t\\t\\t<Terminal />\\r\\n\\t\\t\\t<Ip />\\r\\n\\t\\t\\t<NetWorking />\\r\\n\\t\\t\\t<Time>1525517083249</Time>\\r\\n\\t\\t\\t<Status>断开</Status>\\r\\n\\t\\t\\t<Sid>rkp_u-sTz_1_29473_1525516404577</Sid>\\r\\n\\t\\t</List>\\r\\n\\t</Logs>\\r\\n\\t<RequestId>629586FE-CB2E-4742-995E-121F952CEB72</RequestId>\\r\\n</ListConnectLogsResponse>","errorExample":""}]', - 'title' => 'ListConnectLogs', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"629586FE-CB2E-4742-995E-121F952CEB72\\",\\n \\"RpcServices\\": {\\n \\"Pagination\\": {\\n \\"PageIndex\\": 1,\\n \\"TotalPageCount\\": 2,\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 30\\n },\\n \\"List\\": [\\n {\\n \\"MethodName\\": \\"rpcTest\\",\\n \\"Type\\": \\"http\\",\\n \\"InterfaceName\\": \\"https://portal.aicc.aliyun.com/rpcServiceTest.html\\",\\n \\"Params\\": \\"param1,param2\\",\\n \\"AppKey\\": \\"aorlFafJ\\",\\n \\"GroupName\\": \\"lbs\\",\\n \\"GmtCreate\\": 1525684245000,\\n \\"IsDelete\\": \\"N\\",\\n \\"VersionCode\\": \\"2018-05-01\\",\\n \\"GmtModified\\": 1525684245000,\\n \\"Id\\": 1\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'Query RPC service interface registration records', + 'summary' => 'Queries the list of RPC service interface registration records by calling ListRpcServices.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'ListDeviceModels' => [ - 'methods' => [ - 'get', + 'changeSet' => [ + ['createdAt' => '2024-06-18T02:20:26.000Z', 'description' => 'Error codes changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'iovcc:ListRpcServices', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + ], + 'ListSchemaSubscribes' => [ + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'DeviceModelId', + 'name' => 'ProjectId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], + 'schema' => ['description' => 'The project ID.', 'type' => 'string', 'required' => true, 'example' => 'PIC3UA0V', 'title' => ''], ], [ - 'name' => 'Length', + 'name' => 'DeviceModel', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '20', - ], + 'schema' => ['description' => 'The device model information.', 'type' => 'string', 'required' => false, 'example' => 'model_2nd', 'title' => ''], ], [ - 'name' => 'DeviceModel', + 'name' => 'PageIndex', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'X1', - ], + 'schema' => ['description' => 'The page number to query.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], [ - 'name' => 'DeviceBrand', + 'name' => 'PageSize', 'in' => 'query', + 'schema' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '6F25F67C-F411-499F-BCE2-67CA563CB064', 'title' => ''], + 'PageList' => [ + 'description' => 'The returned data list information.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Pagination' => [ + 'description' => 'The returned pagination information.', + 'type' => 'object', + 'properties' => [ + 'PageIndex' => ['description' => 'The current page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'TotalPageCount' => ['description' => 'The total number of pages.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'SimpleSign' => ['description' => 'Indicates whether simple data is returned.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'HasNextPage' => ['description' => 'Indicates whether there is a next page.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'List' => [ + 'description' => 'The subscription list.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'DeviceModelId' => ['description' => 'The device model ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '120', 'title' => ''], + 'Version' => ['description' => 'The version.', 'type' => 'string', 'example' => '1.0', 'title' => ''], + 'ProjectId' => ['description' => 'The project ID.', 'type' => 'string', 'example' => 'PIC3UA0V', 'title' => ''], + 'GmtCreate' => ['description' => 'The creation time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1537255540160', 'title' => ''], + 'Namespace' => ['description' => 'The namespace.', 'type' => 'string', 'example' => 'b09e93ce436aaf0dcfc2fb2004c1fde8', 'title' => ''], + 'ValiditySchema' => ['description' => 'The validated schema information.', 'type' => 'string', 'example' => '{"ecu":{"node_desc":"动力系统","brake_controll":{"handbrake":"手刹状态"}},"device_info":{"vin":"车架号","uuid":"uuid","brand":"设备品牌","plugin_version":{"ra":"远程诊断","control":"远程控制","node_desc":"插件版本号","yundevice":"yundevice版本号"},"system_version":"系统版本号"},"car_body_hvac":{"node_desc":"车身与HVAC","cigar_lighter":{"node_desc":"点烟器"},"cleaning_fluid":"清洗液"}}', 'title' => ''], + 'DeviceModel' => ['description' => 'The device model name.', 'type' => 'string', 'example' => 'model_2nd', 'title' => ''], + 'GmtModified' => ['description' => 'The modification time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1537255540160', 'title' => ''], + 'Id' => ['description' => 'The data record ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '12', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'TmallGenius', + 'title' => '', + 'example' => '', ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6F25F67C-F411-499F-BCE2-67CA563CB064\\",\\n \\"PageList\\": [\\n {\\n \\"Pagination\\": {\\n \\"PageIndex\\": 1,\\n \\"TotalPageCount\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 10,\\n \\"SimpleSign\\": false,\\n \\"HasNextPage\\": true\\n },\\n \\"List\\": [\\n {\\n \\"DeviceModelId\\": 120,\\n \\"Version\\": \\"1.0\\",\\n \\"ProjectId\\": \\"PIC3UA0V\\",\\n \\"GmtCreate\\": 1537255540160,\\n \\"Namespace\\": \\"b09e93ce436aaf0dcfc2fb2004c1fde8\\",\\n \\"ValiditySchema\\": \\"{\\\\\\"ecu\\\\\\":{\\\\\\"node_desc\\\\\\":\\\\\\"动力系统\\\\\\",\\\\\\"brake_controll\\\\\\":{\\\\\\"handbrake\\\\\\":\\\\\\"手刹状态\\\\\\"}},\\\\\\"device_info\\\\\\":{\\\\\\"vin\\\\\\":\\\\\\"车架号\\\\\\",\\\\\\"uuid\\\\\\":\\\\\\"uuid\\\\\\",\\\\\\"brand\\\\\\":\\\\\\"设备品牌\\\\\\",\\\\\\"plugin_version\\\\\\":{\\\\\\"ra\\\\\\":\\\\\\"远程诊断\\\\\\",\\\\\\"control\\\\\\":\\\\\\"远程控制\\\\\\",\\\\\\"node_desc\\\\\\":\\\\\\"插件版本号\\\\\\",\\\\\\"yundevice\\\\\\":\\\\\\"yundevice版本号\\\\\\"},\\\\\\"system_version\\\\\\":\\\\\\"系统版本号\\\\\\"},\\\\\\"car_body_hvac\\\\\\":{\\\\\\"node_desc\\\\\\":\\\\\\"车身与HVAC\\\\\\",\\\\\\"cigar_lighter\\\\\\":{\\\\\\"node_desc\\\\\\":\\\\\\"点烟器\\\\\\"},\\\\\\"cleaning_fluid\\\\\\":\\\\\\"清洗液\\\\\\"}}\\",\\n \\"DeviceModel\\": \\"model_2nd\\",\\n \\"GmtModified\\": 1537255540160,\\n \\"Id\\": 12\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'Query subscription list', + 'summary' => 'Queries a subscription list by calling ListSchemaSubscribes.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2024-06-18T02:20:26.000Z', 'description' => 'Error codes changed'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ [ - 'name' => 'Start', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '1', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'iovcc:ListSchemaSubscribes', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + ], + 'ListShadowSchemaDeviceModels' => [ + 'methods' => ['get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'ProjectId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'projectTest', - ], + 'AK' => [], ], + ], + 'operationType' => 'read', + 'systemTags' => ['operationType' => 'get'], + 'parameters' => [ [ - 'name' => 'DeviceBrandId', + 'name' => 'ProjectId', 'in' => 'query', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - ], + 'schema' => ['description' => 'The project ID.', 'type' => 'string', 'required' => true, 'example' => 'PIC3UA0V', 'title' => ''], ], ], 'responses' => [ @@ -14094,162 +11532,107 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'DeviceModels' => [ - 'description' => '', + 'ModelList' => [ + 'description' => 'The list of device models returned.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'DeviceModelId' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10', - ], - 'HardwareType' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'sn', - ], - 'DeviceName' => [ - 'type' => 'string', - ], - 'DeviceType' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'CanCreateDeviceId' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'ProjectId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'projectTest', - ], - 'OsPlatform' => [ - 'type' => 'string', - ], - 'DeviceModel' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'X1', - ], - 'SecurityChip' => [ - 'type' => 'string', - ], - 'DeviceLogoUrl' => [ - 'type' => 'string', - ], - 'Description' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'ObjectKey' => [ - 'type' => 'string', - ], - 'InitUsageTypeDesc' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'InitUsageType' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'DeviceBrand' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'TmallGenius', - ], + 'DeviceModelId' => ['description' => 'The device model ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '208', 'title' => ''], + 'HardwareType' => ['description' => 'The hardware type.', 'type' => 'string', 'example' => 'sn', 'title' => ''], + 'DeviceType' => ['description' => 'The device type.', 'type' => 'string', 'example' => 'car_auto', 'title' => ''], + 'CanCreateDeviceId' => ['description' => 'Indicates whether a device ID can be created.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'ProjectId' => ['description' => 'The project ID.', 'type' => 'string', 'example' => 'PIC3UA0V', 'title' => ''], + 'OsPlatform' => ['description' => 'The operating system platform type. Valid values:'."\n" + .'- **android**'."\n" + .'- **alios**'."\n" + .'- **linux**'."\n" + .'- **qnx**.', 'type' => 'string', 'example' => 'linux', 'title' => ''], + 'DeviceModel' => ['description' => 'The device model.', 'type' => 'string', 'example' => 'model_2nd', 'title' => ''], + 'SecurityChip' => ['description' => 'The chip authentication hardening scheme. Valid values:'."\n" + .'- 0: Disabled.'."\n" + .'- 1: Enabled.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'Description' => ['description' => 'The description.', 'type' => 'string', 'example' => 'description', 'title' => ''], + 'InitUsageTypeDesc' => ['description' => 'The description of the usage type.', 'type' => 'string', 'example' => 'private', 'title' => ''], + 'InitUsageType' => ['description' => 'The usage type, such as private or commercial.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'DeviceBrand' => ['description' => 'The device brand.', 'type' => 'string', 'example' => 'brand_2nd', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '9c7a3b09-a69a-43f5-8bf2-84f7119810eb', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '4F501674-4FE3-47F9-ADAD-A1875A325798', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"9c7a3b09-a69a-43f5-8bf2-84f7119810eb\\",\\n \\"DeviceModels\\": [\\n {\\n \\"DeviceModelId\\": 10,\\n \\"HardwareType\\": \\"sn\\",\\n \\"Description\\": \\"天猫精灵X1\\",\\n \\"DeviceType\\": \\"智能家居\\",\\n \\"CanCreateDeviceId\\": 1,\\n \\"ProjectId\\": \\"projectTest\\",\\n \\"InitUsageTypeDesc\\": \\"私人设备\\",\\n \\"InitUsageType\\": 0,\\n \\"DeviceModel\\": \\"X1\\",\\n \\"DeviceBrand\\": \\"TmallGenius\\"\\n }\\n ]\\n}","errorExample":"{\\n \\"Code\\":\\"NoPermissionToAccessProject\\",\\n \\"HostId\\":\\"iovcc.cn-shanghai.aliyuncs.com\\",\\n \\"Message\\":\\"User is not authorized to access the specified project.\\",\\n \\"RequestId\\":\\"6F25F67C-F411-499F-BCE2-67CA563CB064\\"\\n}"},{"type":"xml","example":"","errorExample":""}]', - ], - 'ListDevices' => [ - 'methods' => [ - 'get', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"ModelList\\": [\\n {\\n \\"DeviceModelId\\": 208,\\n \\"HardwareType\\": \\"sn\\",\\n \\"DeviceType\\": \\"car_auto\\",\\n \\"CanCreateDeviceId\\": 1,\\n \\"ProjectId\\": \\"PIC3UA0V\\",\\n \\"OsPlatform\\": \\"linux\\",\\n \\"DeviceModel\\": \\"model_2nd\\",\\n \\"SecurityChip\\": 0,\\n \\"Description\\": \\"description\\",\\n \\"InitUsageTypeDesc\\": \\"private\\",\\n \\"InitUsageType\\": 1,\\n \\"DeviceBrand\\": \\"brand_2nd\\"\\n }\\n ],\\n \\"RequestId\\": \\"4F501674-4FE3-47F9-ADAD-A1875A325798\\"\\n}","type":"json"}]', + 'title' => 'Retrieve all device models', + 'summary' => 'Retrieves all device model lists under a project based on the current ProjectId when adding a device paradigm.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2024-06-18T02:20:26.000Z', 'description' => 'Error codes changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'iovcc:ListShadowSchemaDeviceModels', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + ], + 'ListShadowSchemas' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'ProjectId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'projectTest', - ], + 'schema' => ['description' => 'The project ID.', 'type' => 'string', 'required' => true, 'example' => 'PIC3UA0V', 'title' => ''], ], [ - 'name' => 'DeviceModelId', + 'name' => 'QueryType', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], + 'schema' => ['description' => 'The query type.', 'type' => 'string', 'required' => false, 'example' => 'deviceModelId', 'title' => ''], ], [ - 'name' => 'DeviceModel', + 'name' => 'QueryValue', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'ROEWE RX5 ', - ], + 'schema' => ['description' => 'The query value that matches the query type.', 'type' => 'string', 'required' => false, 'example' => '120', 'title' => ''], ], [ - 'name' => 'Start', + 'name' => 'PageIndex', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'The page number to query.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], [ - 'name' => 'Length', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '20', - ], + 'schema' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], ], ], 'responses' => [ @@ -14257,245 +11640,182 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '9c7a3b09-a69a-43f5-8bf2-84f7119810eb', - ], - 'Devices' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'SerialNumber' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'xxxxxxxx', - ], - 'Status' => [ - 'description' => '', - 'type' => 'string', - 'example' => '0', - ], - 'DeviceModelId' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10', - ], - 'MacAddress' => [ - 'description' => '', - 'type' => 'string', - 'example' => '00:00:00:00:00:00', - ], - 'DeviceId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'cn.1234567890', - ], - 'DeviceType' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'car_auto ', - ], - 'ProjectId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'projectTest', - ], - 'DeviceModel' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'ROEWE RX5 ', - ], - 'UsageType' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'Vin' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'xxxxxxxx', - ], - 'UsageTypeDesc' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'private', - ], - 'Uuid' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'xxxxxxxx', - ], - 'HardwareId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'xxxxxxxx', - ], - 'Region' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'cn', - ], - 'SoftwareId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'xxxxxxxx', - ], - 'Name' => [ + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '629586FE-CB2E-4742-995E-121F952CEB72', 'title' => ''], + 'PageList' => [ + 'description' => 'The query result list.', + 'type' => 'object', + 'properties' => [ + 'Pagination' => [ + 'description' => 'The pagination information.', + 'type' => 'object', + 'properties' => [ + 'PageIndex' => ['description' => 'The current page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'TotalPageCount' => ['description' => 'The total number of pages.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The number of records per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of records.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'SimpleSign' => ['description' => 'Indicates whether simple authentication is used. This field has no reference value.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'HasNextPage' => ['description' => 'Indicates whether a next page exists.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'List' => [ + 'description' => 'The result list.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'AuthTypeDesc' => ['description' => 'The description of the authentication type.', 'type' => 'string', 'example' => '基于账号', 'title' => ''], + 'DeviceModelId' => ['description' => 'The device model ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '120', 'title' => ''], + 'AuthType' => ['description' => 'The account authentication type.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'ProjectId' => ['description' => 'The project ID.', 'type' => 'string', 'example' => 'PIC3UA0V', 'title' => ''], + 'GmtCreate' => ['description' => 'The creation time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1537255499517', 'title' => ''], + 'Namespace' => ['description' => 'The namespace.', 'type' => 'string', 'example' => 'b09e93ce436aaf0dcfc2fb2004c1fde8', 'title' => ''], + 'DeviceModel' => ['description' => 'The device model.', 'type' => 'string', 'example' => 'model_2nd', 'title' => ''], + 'GmtModified' => ['description' => 'The modification time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1537255499517', 'title' => ''], + 'ModuleSchema' => ['description' => 'The schema information of the device model.', 'type' => 'string', 'example' => '{"a":"b"}', 'title' => ''], + 'Id' => ['description' => 'The unique record ID of the data.', 'type' => 'integer', 'format' => 'int64', 'example' => '12', 'title' => ''], + ], 'description' => '', - 'type' => 'string', + 'title' => '', 'example' => '', ], - 'DeviceBrand' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'ROEWE', - ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"9c7a3b09-a69a-43f5-8bf2-84f7119810eb\\",\\n \\"Devices\\": [\\n {\\n \\"Status\\": \\"0\\",\\n \\"SerialNumber\\": \\"xxxxxxxx\\",\\n \\"DeviceModelId\\": 10,\\n \\"MacAddress\\": \\"00:00:00:00:00:00\\",\\n \\"DeviceType\\": \\"car_auto\\\\t\\",\\n \\"DeviceId\\": \\"cn.1234567890\\",\\n \\"ProjectId\\": \\"projectTest\\",\\n \\"DeviceModel\\": \\"ROEWE RX5\\\\t\\",\\n \\"Vin\\": \\"xxxxxxxx\\",\\n \\"UsageType\\": 0,\\n \\"UsageTypeDesc\\": \\"private\\",\\n \\"Uuid\\": \\"xxxxxxxx\\",\\n \\"HardwareId\\": \\"xxxxxxxx\\",\\n \\"Region\\": \\"cn\\",\\n \\"SoftwareId\\": \\"xxxxxxxx\\",\\n \\"Name\\": \\"我的设备\\",\\n \\"DeviceBrand\\": \\"ROEWE\\"\\n }\\n ]\\n}","errorExample":"{\\n \\"Code\\":\\"NoPermissionToAccessProject\\",\\n \\"HostId\\":\\"iovcc.cn-shanghai.aliyuncs.com\\",\\n \\"Message\\":\\"User is not authorized to access the specified project.\\",\\n \\"RequestId\\":\\"6F25F67C-F411-499F-BCE2-67CA563CB064\\"\\n}"},{"type":"xml","example":"<ListDevicesResponse>\\r\\n\\t<Devices>\\r\\n\\t\\t<DeviceBrand>ROEWE</DeviceBrand>\\r\\n\\t\\t<DeviceId>cn.1234567890</DeviceId>\\r\\n\\t\\t<DeviceModel>ROEWE RX5</DeviceModel>\\r\\n\\t\\t<DeviceModelId>10</DeviceModelId>\\r\\n\\t\\t<DeviceType>car_auto</DeviceType>\\r\\n\\t\\t<HardwareId>xxxxxxx</HardwareId>\\r\\n\\t\\t<MacAddress>00:00:00:00:00:00</MacAddress>\\r\\n\\t\\t<Name>我的设备</Name>\\r\\n\\t\\t<ProjectId>projectTest</ProjectId>\\r\\n\\t\\t<Region>cn</Region>\\r\\n\\t\\t<SerialNumber>xxxxxx</SerialNumber>\\r\\n\\t\\t<SoftwareId>xxxxxx</SoftwareId>\\r\\n\\t\\t<UsageType>0</UsageType>\\r\\n\\t\\t<UsageTypeDesc>private</UsageTypeDesc>\\r\\n <Status>0</Status>\\r\\n\\t\\t<Uuid>xxxxxx</Uuid>\\r\\n\\t</Devices>\\r\\n\\t<RequestId>E94C9864-56FB-44AD-AC0C-A1CEFB332254</RequestId>\\r\\n</ListDevicesResponse>","errorExample":""}]', - 'title' => 'ListDevices', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"629586FE-CB2E-4742-995E-121F952CEB72\\",\\n \\"PageList\\": {\\n \\"Pagination\\": {\\n \\"PageIndex\\": 1,\\n \\"TotalPageCount\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 10,\\n \\"SimpleSign\\": false,\\n \\"HasNextPage\\": false\\n },\\n \\"List\\": [\\n {\\n \\"AuthTypeDesc\\": \\"基于账号\\",\\n \\"DeviceModelId\\": 120,\\n \\"AuthType\\": 0,\\n \\"ProjectId\\": \\"PIC3UA0V\\",\\n \\"GmtCreate\\": 1537255499517,\\n \\"Namespace\\": \\"b09e93ce436aaf0dcfc2fb2004c1fde8\\",\\n \\"DeviceModel\\": \\"model_2nd\\",\\n \\"GmtModified\\": 1537255499517,\\n \\"ModuleSchema\\": \\"{\\\\\\"a\\\\\\":\\\\\\"b\\\\\\"}\\",\\n \\"Id\\": 12\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'Retrieve paginated schema data', + 'summary' => 'Retrieves paginated schema data based on the project ID and pagination information.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'ListDeviceTypes' => [ - 'methods' => [ - 'get', + 'changeSet' => [ + ['createdAt' => '2024-06-18T02:20:26.000Z', 'description' => 'Error codes changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], - 'security' => [ + 'ramActions' => [ [ - 'AK' => [], + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'iovcc:ListShadowSchemas', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], ], - 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - ], - 'parameters' => [ + ], + 'ListSupportFeatures' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'ProjectId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'projectTest', - ], + 'AK' => [], ], ], + 'operationType' => 'read', + 'systemTags' => ['operationType' => 'list'], + 'parameters' => [], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '9c7a3b09-a69a-43f5-8bf2-84f7119810eb', - ], - 'DeviceTypes' => [ - 'description' => '', + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '1B0DA203-B3BA-43CD-9506-5DF33ACEFF26', 'title' => ''], + 'SupportFeatures' => [ + 'description' => 'The activated service modules.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'DeviceType' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'car_auto', - ], - 'Name' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], + 'Name' => ['description' => 'The service name.', 'type' => 'string', 'example' => 'OTA', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"9c7a3b09-a69a-43f5-8bf2-84f7119810eb\\",\\n \\"DeviceTypes\\": [\\n {\\n \\"Name\\": \\"智能汽车\\",\\n \\"DeviceType\\": \\"car_auto\\"\\n }\\n ]\\n}","errorExample":"{\\n \\"Code\\":\\"NoPermissionToAccessProject\\",\\n \\"HostId\\":\\"iovcc.cn-shanghai.aliyuncs.com\\",\\n \\"Message\\":\\"User is not authorized to access the specified project.\\",\\n \\"RequestId\\":\\"6F25F67C-F411-499F-BCE2-67CA563CB064\\"\\n}"},{"type":"xml","example":"<ListDeviceTypesResponse>\\r\\n\\t<RequestId>E94C9864-56FB-44AD-AC0C-A1CEFB332254</RequestId>\\r\\n\\t<DeviceTypes>\\r\\n\\t\\t<Name>路由器</Name>\\r\\n\\t\\t<DeviceType>router</DeviceType>\\r\\n\\t</DeviceTypes>\\r\\n\\t<DeviceTypes>\\r\\n\\t\\t<Name>电视</Name>\\r\\n\\t\\t<DeviceType>tv</DeviceType>\\r\\n\\t</DeviceTypes>\\r\\n\\t<DeviceTypes>\\r\\n\\t\\t<Name>平板</Name>\\r\\n\\t\\t<DeviceType>pad</DeviceType>\\r\\n\\t</DeviceTypes>\\r\\n\\t<DeviceTypes>\\r\\n\\t\\t<Name>手机</Name>\\r\\n\\t\\t<DeviceType>phone</DeviceType>\\r\\n\\t</DeviceTypes>\\r\\n\\t<DeviceTypes>\\r\\n\\t\\t<Name>智能汽车</Name>\\r\\n\\t\\t<DeviceType>car_auto</DeviceType>\\r\\n\\t</DeviceTypes>\\r\\n\\t<DeviceTypes>\\r\\n\\t\\t<Name>考勤机</Name>\\r\\n\\t\\t<DeviceType>attendance</DeviceType>\\r\\n\\t</DeviceTypes>\\r\\n\\t<DeviceTypes>\\r\\n\\t\\t<Name>电子班牌</Name>\\r\\n\\t\\t<DeviceType>electronic_plate</DeviceType>\\r\\n\\t</DeviceTypes>\\r\\n</ListDeviceTypesResponse>","errorExample":""}]', - 'title' => 'ListDeviceTypes', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1B0DA203-B3BA-43CD-9506-5DF33ACEFF26\\",\\n \\"SupportFeatures\\": [\\n {\\n \\"Name\\": \\"OTA\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'Query activated services', + 'summary' => 'Queries the list of activated services by calling ListSupportFeatures.', + 'description' => '> Queries the IoVCC service modules that the user has activated.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'ListMessageReceivers' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [ + ['createdAt' => '2024-06-14T11:20:41.000Z', 'description' => 'Error codes changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'iovcc:ListSupportFeatures', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'ListTriggers' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'ProjectId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'sfgsghd6', - ], + 'schema' => ['description' => 'The project ID.', 'type' => 'string', 'required' => true, 'example' => 'PE9FQC48', 'title' => ''], ], [ - 'name' => 'MessageId', + 'name' => 'Namespace', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '32555', - ], + 'schema' => ['description' => 'The namespace, such as the namespace of syncstore.', 'type' => 'string', 'required' => true, 'example' => 'f323baa35c304751a4b1254adc8230bf', 'title' => ''], ], [ 'name' => 'PageIndex', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'The page number. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '20', - ], + 'schema' => ['description' => 'The number of items per page. Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], ], ], 'responses' => [ @@ -14503,150 +11823,149 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'MessageReceivers' => [ - 'description' => '', + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '629586FE-CB2E-4742-995E-121F952CEB72', 'title' => ''], + 'TriggerList' => [ + 'description' => 'The trigger list.', 'type' => 'object', 'properties' => [ 'Pagination' => [ - 'description' => '', + 'description' => 'The pagination information.', 'type' => 'object', 'properties' => [ - 'PageIndex' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'TotalPageCount' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '30', - ], - 'PageSize' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '20', - ], - 'TotalCount' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], + 'PageIndex' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'TotalPageCount' => ['description' => 'The total number of pages.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''], + 'PageSize' => ['description' => 'The number of items per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of records.', 'type' => 'integer', 'format' => 'int32', 'example' => '11', 'title' => ''], ], + 'title' => '', + 'example' => '', ], - 'List' => [ - 'description' => '', + 'Triggers' => [ + 'description' => 'The array of triggers.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'Type' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'uuid', - ], - 'Value' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'fc35429dff9b473c81d7ef5f62ab11dc', - ], - 'Mid' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '33566', + 'Status' => ['description' => 'The trigger status. Valid values:'."\n" + .'- -1: the associated function is deleted.'."\n" + .'- 1: the associated function is not deployed.'."\n" + .'- 2: the associated function is deployed.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''], + 'Type' => ['description' => 'The trigger type. Valid values:'."\n" + .'- 0: syncstore.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'Production' => ['description' => 'Specifies whether the trigger is executed in the production environment. Valid values:'."\n" + .'- 0: Not executed in this environment.'."\n" + .'- 1: Executed in this environment.'."\n" + ."\n" + .'Default value: 0.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'Functions' => [ + 'description' => 'The array of functions.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'GmtCreate' => ['description' => 'The creation time, in millisecond-precision UNIX timestamp.', 'type' => 'integer', 'format' => 'int64', 'example' => '1535872636000', 'title' => ''], + 'FileName' => ['description' => 'The file name.', 'type' => 'string', 'example' => 'hello.zip', 'title' => ''], + 'Name' => ['description' => 'The function name.', 'type' => 'string', 'example' => 'someFunc', 'title' => ''], + 'GmtModified' => ['description' => 'The modification time, in millisecond-precision UNIX timestamp.', 'type' => 'integer', 'format' => 'int64', 'example' => '1535872636000', 'title' => ''], + 'Id' => ['description' => 'The function ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'FileId' => ['description' => 'The file ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], + 'Sandbox' => ['description' => 'Specifies whether the trigger is executed in the sandbox environment. Valid values:'."\n" + .'- 0: Not executed in this environment.'."\n" + .'- 1: Executed in this environment.'."\n" + ."\n" + .'Default value: 0.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'Namespace' => ['description' => 'The namespace, such as the namespace of syncstore.', 'type' => 'string', 'example' => 'f323baa35c304751a4b1254adc8230bf', 'title' => ''], + 'GmtModified' => ['description' => 'The modification time, in millisecond-precision UNIX timestamp.', 'type' => 'integer', 'format' => 'int64', 'example' => '1535873636000', 'title' => ''], + 'Source' => ['description' => 'The event identifier that activates the trigger, such as a syncstore path.', 'type' => 'string', 'example' => '/', 'title' => ''], + 'ChainedFunctionIds' => ['description' => 'The chained function IDs, separated by commas (,). Each ID corresponds to an item in the Functions array.', 'type' => 'string', 'example' => '/', 'title' => ''], + 'GmtCreate' => ['description' => 'The creation time, in millisecond-precision UNIX timestamp.', 'type' => 'integer', 'format' => 'int64', 'example' => '1535873636000', 'title' => ''], + 'InvocationMode' => ['description' => 'The invocation mode. Valid values:'."\n" + .'- 0: sequential (synchronous) invocation.'."\n" + .'- 1: parallel (asynchronous) invocation.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'Id' => ['description' => 'The trigger ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '629586FE-CB2E-4742-995E-121F952CEB72', + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"629586FE-CB2E-4742-995E-121F952CEB72\\",\\n \\"MessageReceivers\\": {\\n \\"List\\": [\\n {\\n \\"Type\\": \\"uuid\\",\\n \\"Value\\": \\"fc35429dff9b473c81d7ef5f62ab11dc\\",\\n \\"Mid\\": 33566\\n }\\n ],\\n \\"Pagination\\": {\\n \\"PageIndex\\": 1,\\n \\"TotalPageCount\\": 30,\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 2\\n }\\n }\\n}","errorExample":"{\\n \\"Code\\":\\"MissingParameter\\",\\n \\"Message\\":\\"The MessageId is mandatory for this action\\",\\n \\"HostId\\": \\"iovcc.cn-shanghai.aliyuncs.com\\",\\n \\"RequestId\\":\\"629586FE-CB2E-4742-995E-121F952CEB72\\"\\n}"},{"type":"xml","example":"<ListMessageReceiversResponse>\\r\\n\\t<MessageReceivers>\\r\\n\\t\\t<Pagination>\\r\\n\\t\\t\\t<TotalCount>1</TotalCount>\\r\\n\\t\\t\\t<TotalPageCount>1</TotalPageCount>\\r\\n\\t\\t\\t<PageIndex>1</PageIndex>\\r\\n\\t\\t\\t<PageSize>20</PageSize>\\r\\n\\t\\t</Pagination>\\r\\n\\t\\t<List>\\r\\n\\t\\t\\t<Mid>106577</Mid>\\r\\n\\t\\t\\t<Type>deviceId</Type>\\r\\n\\t\\t\\t<Value>1583820a2cf345a8810b3e0a2435b16f</Value>\\r\\n\\t\\t</List>\\r\\n\\t</MessageReceivers>\\r\\n\\t<RequestId>629586FE-CB2E-4742-995E-121F952CEB72</RequestId>\\r\\n</ListMessageReceiversResponse>","errorExample":""}]', - 'title' => 'ListMessageReceivers', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"629586FE-CB2E-4742-995E-121F952CEB72\\",\\n \\"TriggerList\\": {\\n \\"Pagination\\": {\\n \\"PageIndex\\": 1,\\n \\"TotalPageCount\\": 2,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 11\\n },\\n \\"Triggers\\": [\\n {\\n \\"Status\\": 2,\\n \\"Type\\": 0,\\n \\"Production\\": 1,\\n \\"Functions\\": [\\n {\\n \\"GmtCreate\\": 1535872636000,\\n \\"FileName\\": \\"hello.zip\\",\\n \\"Name\\": \\"someFunc\\",\\n \\"GmtModified\\": 1535872636000,\\n \\"Id\\": 1,\\n \\"FileId\\": 1\\n }\\n ],\\n \\"Sandbox\\": 1,\\n \\"Namespace\\": \\"f323baa35c304751a4b1254adc8230bf\\",\\n \\"GmtModified\\": 1535873636000,\\n \\"Source\\": \\"/\\",\\n \\"ChainedFunctionIds\\": \\"/\\",\\n \\"GmtCreate\\": 1535873636000,\\n \\"InvocationMode\\": 0,\\n \\"Id\\": 1\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'List triggers by page', + 'summary' => 'Lists triggers with pagination support.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'DescribeDeviceBrand' => [ - 'methods' => [ - 'get', + 'changeSet' => [ + ['createdAt' => '2024-06-18T02:20:26.000Z', 'description' => 'Error codes changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'iovcc:ListTriggers', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + ], + 'ListUpstreamAppKeyRelations' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'list'], 'parameters' => [ [ - 'name' => 'ProjectId', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'projectTest', - ], + 'schema' => ['description' => 'The number of entries per page in a paged query.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', 'title' => ''], ], [ - 'name' => 'DeviceBrandId', + 'name' => 'ProjectId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'The ID of the IoVCC project.', 'type' => 'string', 'required' => true, 'example' => 'fsgtd5y5r', 'title' => ''], ], [ - 'name' => 'DeviceBrand', + 'name' => 'AppServerId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'TmallGenius', - ], + 'schema' => ['description' => 'The ID of the server application.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '2', 'title' => ''], ], [ - 'name' => 'Start', + 'name' => 'PageIndex', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '0', - ], - ], - [ - 'name' => 'Length', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '20', - ], + 'schema' => ['description' => 'The page number of the paged query.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], ], 'responses' => [ @@ -14654,100 +11973,106 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '9c7a3b09-a69a-43f5-8bf2-84f7119810eb', - ], - 'DeviceBrand' => [ - 'description' => '', + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '629586FE-CB2E-4742-995E-121F952CEB72', 'title' => ''], + 'RelationList' => [ + 'description' => 'The paging query data object for application mapping relationships.', 'type' => 'object', 'properties' => [ - 'DeviceBrandId' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'Description' => [ - 'description' => '', - 'type' => 'string', + 'Pagination' => [ + 'description' => 'The pagination object.', + 'type' => 'object', + 'properties' => [ + 'PageIndex' => ['description' => 'The page number of the paged query.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'TotalPageCount' => ['description' => 'The total number of pages.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''], + ], + 'title' => '', 'example' => '', ], - 'ProjectId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'projectTest', - ], - 'Manufacture' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Alibaba', - ], - 'DeviceBrand' => [ - 'description' => '', - 'type' => 'string', + 'List' => [ + 'description' => 'The mapping relationship list.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'AppName' => ['description' => 'The application name.', 'type' => 'string', 'example' => '会员中心', 'title' => ''], + 'AppKey' => ['description' => 'The client application identifier, which is the CMNS application AppKey.', 'type' => 'string', 'example' => 'afsgwewt', 'title' => ''], + 'AppPackage' => ['description' => 'The application package name.', 'type' => 'string', 'example' => 'com.test.member', 'title' => ''], + 'ProjectId' => ['description' => 'The ID of the IoVCC project.', 'type' => 'string', 'example' => 'fsgtd5y5r', 'title' => ''], + 'GmtCreate' => ['description' => 'The time when the record was created.', 'type' => 'integer', 'format' => 'int64', 'example' => '1525696592000', 'title' => ''], + 'PAppKey' => ['description' => 'The server application identifier.', 'type' => 'string', 'example' => 'cfsgweFv', 'title' => ''], + 'Id' => ['description' => 'The record ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"9c7a3b09-a69a-43f5-8bf2-84f7119810eb\\",\\n \\"DeviceBrand\\": {\\n \\"Manufacture\\": \\"Alibaba\\",\\n \\"DeviceBrandId\\": 1,\\n \\"Description\\": \\"天猫精灵品牌\\",\\n \\"DeviceBrand\\": \\"天猫精灵\\",\\n \\"ProjectId\\": \\"projectTest\\"\\n }\\n}","errorExample":"{\\n \\"Code\\":\\"NoPermissionToAccessProject\\",\\n \\"HostId\\":\\"iovcc.cn-shanghai.aliyuncs.com\\",\\n \\"Message\\":\\"User is not authorized to access the specified project.\\",\\n \\"RequestId\\":\\"6F25F67C-F411-499F-BCE2-67CA563CB064\\"\\n}"},{"type":"xml","example":"<DescribeDeviceBrandResponse>\\r\\n\\t<RequestId>E94C9864-56FB-44AD-AC0C-A1CEFB332254</RequestId>\\r\\n\\t<DeviceBrand>\\r\\n\\t\\t<Description>天猫精灵品牌</Description>\\r\\n\\t\\t<DeviceBrand>天猫精灵</DeviceBrand>\\r\\n\\t\\t<DeviceBrandId>1</DeviceBrandId>\\r\\n\\t\\t<Manufacture>Alibaba</Manufacture>\\r\\n\\t\\t<ProjectId>projectTest</ProjectId>\\r\\n\\t</DeviceBrand>\\r\\n</DescribeDeviceBrandResponse>","errorExample":""}]', - 'title' => 'DescribeDeviceBrand', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"629586FE-CB2E-4742-995E-121F952CEB72\\",\\n \\"RelationList\\": {\\n \\"Pagination\\": {\\n \\"PageIndex\\": 1,\\n \\"TotalPageCount\\": 1,\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 2\\n },\\n \\"List\\": [\\n {\\n \\"AppName\\": \\"会员中心\\",\\n \\"AppKey\\": \\"afsgwewt\\",\\n \\"AppPackage\\": \\"com.test.member\\",\\n \\"ProjectId\\": \\"fsgtd5y5r\\",\\n \\"GmtCreate\\": 1525696592000,\\n \\"PAppKey\\": \\"cfsgweFv\\",\\n \\"Id\\": 1\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'Query upstream message client-server mapping list', + 'summary' => 'Queries the mapping list between upstream message clients and servers by server application ID.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'DescribeDeviceIdByOuterInfo' => [ - 'methods' => [ - 'get', + 'changeSet' => [ + ['createdAt' => '2024-06-18T02:20:26.000Z', 'description' => 'Error codes changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'iovcc:ListUpstreamAppKeyRelations', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'ListUpstreamAppServers' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'list'], 'parameters' => [ [ 'name' => 'ProjectId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'projectTest', - ], + 'schema' => ['description' => 'The IoVCC project ID.', 'type' => 'string', 'required' => true, 'example' => 'fsgtd5y5r', 'title' => ''], ], [ - 'name' => 'QueryType', + 'name' => 'PageIndex', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'sn', - ], + 'schema' => ['description' => 'The page number for the paged query.', 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''], ], [ - 'name' => 'QueryValue', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '12345abcde', - ], + 'schema' => ['description' => 'The number of entries per page for the paged query.', 'type' => 'string', 'required' => false, 'example' => '20', 'title' => ''], ], ], 'responses' => [ @@ -14755,73 +12080,97 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '9c7a3b09-a69a-43f5-8bf2-84f7119810eb', - ], - 'DeviceId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'deviceabcde', + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '629586FE-CB2E-4742-995E-121F952CEB72', 'title' => ''], + 'AppServers' => [ + 'description' => 'The paging query data object for server-side applications.', + 'type' => 'object', + 'properties' => [ + 'Pagination' => [ + 'description' => 'The pagination object.', + 'type' => 'object', + 'properties' => [ + 'PageIndex' => ['description' => 'The page number of the paged query.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'TotalPageCount' => ['description' => 'The total number of pages.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'List' => [ + 'description' => 'The list of server-side applications.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ProjectId' => ['description' => 'The IoVCC project ID.', 'type' => 'string', 'example' => 'Gs6st7ye', 'title' => ''], + 'GmtCreate' => ['description' => 'The creation time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1525701500000', 'title' => ''], + 'Tags' => ['description' => 'The business labels for upstream messaging. Multiple labels are separated by commas.', 'type' => 'string', 'example' => 'tag1,tag2,tag3', 'title' => ''], + 'QueueNameList' => ['description' => 'The list of MNS consumption queues through which the server-side application receives upstream messages. Multiple queues are separated by commas.', 'type' => 'string', 'example' => 'com-yunos-iovcc-cmns-forward-qa-mRFG7Bee-tag1,com-yunos-iovcc-cmns-forward-qa-mRFG7Bee-tag2,com-yunos-aicc-cmns-forward-qa-mRFG7Bee-tag3', 'title' => ''], + 'PAppKey' => ['description' => 'The unique identifier of the server-side application.', 'type' => 'string', 'example' => 'fsgstyye', 'title' => ''], + 'GmtModified' => ['description' => 'The modification time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1525701500000', 'title' => ''], + 'Name' => ['description' => 'The name of the server-side application.', 'type' => 'string', 'example' => 'iovcc-test', 'title' => ''], + 'Id' => ['description' => 'The record ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"DeviceId\\": \\"deviceabcde\\",\\n \\"RequestId\\": \\"9c7a3b09-a69a-43f5-8bf2-84f7119810eb\\"\\n}","errorExample":"{\\n \\"Code\\":\\"NoPermissionToAccessProject\\",\\n \\"HostId\\":\\"iovcc.cn-shanghai.aliyuncs.com\\",\\n \\"Message\\":\\"User is not authorized to access the specified project.\\",\\n \\"RequestId\\":\\"6F25F67C-F411-499F-BCE2-67CA563CB064\\"\\n}"},{"type":"xml","example":"<DescribeDeviceIdByOuterInfoResponse>\\r\\n\\t<RequestId>E94C9864-56FB-44AD-AC0C-A1CEFB332254</RequestId>\\r\\n\\t<DeviceId>deviceabcde</DeviceId>\\r\\n</DescribeDeviceIdByOuterInfoResponse>","errorExample":""}]', - 'title' => 'DescribeDeviceIdByOuterInfo', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"629586FE-CB2E-4742-995E-121F952CEB72\\",\\n \\"AppServers\\": {\\n \\"Pagination\\": {\\n \\"PageIndex\\": 1,\\n \\"TotalPageCount\\": 1,\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 2\\n },\\n \\"List\\": [\\n {\\n \\"ProjectId\\": \\"Gs6st7ye\\",\\n \\"GmtCreate\\": 1525701500000,\\n \\"Tags\\": \\"tag1,tag2,tag3\\",\\n \\"QueueNameList\\": \\"com-yunos-iovcc-cmns-forward-qa-mRFG7Bee-tag1,com-yunos-iovcc-cmns-forward-qa-mRFG7Bee-tag2,com-yunos-aicc-cmns-forward-qa-mRFG7Bee-tag3\\",\\n \\"PAppKey\\": \\"fsgstyye\\",\\n \\"GmtModified\\": 1525701500000,\\n \\"Name\\": \\"iovcc-test\\",\\n \\"Id\\": 1\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'Retrieve upstream messaging server application list', + 'summary' => 'Retrieves the list of server-side applications for upstream messaging based on a project ID.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'DescribeDeviceInfo' => [ - 'methods' => [ - 'get', + 'changeSet' => [ + ['createdAt' => '2024-06-18T02:20:26.000Z', 'description' => 'Error codes changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'iovcc:ListUpstreamAppServers', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'ListVersionDeviceGroups' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'DeviceId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '100', - ], - ], - [ - 'name' => 'DeviceToken', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'cn.xxxxxxx', - ], - ], - [ 'name' => 'ProjectId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'projectTest', - ], + 'schema' => ['description' => 'The ID of the project.', 'type' => 'string', 'required' => true, 'example' => 'P0VFCREU', 'title' => ''], ], ], 'responses' => [ @@ -14829,202 +12178,150 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '9c7a3b09-a69a-43f5-8bf2-84f7119810eb', - ], - 'DeviceInfo' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'SerialNumber' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'xxxxxxxx', - ], - 'Status' => [ - 'description' => '', - 'type' => 'string', - 'example' => '1', - ], - 'DeviceModelId' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10', - ], - 'MacAddress' => [ - 'description' => '', - 'type' => 'string', - 'example' => '00:00:00:00:00:00', - ], - 'DeviceId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'cn.1234567890', - ], - 'DeviceType' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'ProjectId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'projectTest', - ], - 'DeviceModel' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'X1', - ], - 'UsageType' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'Vin' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'xxxxxxxx', - ], - 'UsageTypeDesc' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'private', - ], - 'Uuid' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'xxxxxxxx', - ], - 'HardwareId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'xxxxxxx', - ], - 'Region' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'cn', - ], - 'SoftwareId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'xxxxxxxx', - ], - 'Name' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'DeviceBrand' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'TmallGenuine', + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '6F25F67C-F411-499F-BCE2-67CA563CB064', 'title' => ''], + 'DeviceGroupList' => [ + 'description' => 'The list of results.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'GmtModify' => ['description' => 'The modification time.', 'type' => 'string', 'example' => '2018-01-01 00:01:00', 'title' => ''], + 'Description' => ['description' => 'The group description.', 'type' => 'string', 'example' => '测试', 'title' => ''], + 'GmtCreate' => ['description' => 'The creation time.', 'type' => 'string', 'example' => '2018-01-01 00:00:00', 'title' => ''], + 'Name' => ['description' => 'The group name.', 'type' => 'string', 'example' => '升级分组', 'title' => ''], + 'Id' => ['description' => 'ID', 'type' => 'string', 'example' => '1', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"9c7a3b09-a69a-43f5-8bf2-84f7119810eb\\",\\n \\"DeviceInfo\\": {\\n \\"Status\\": \\"1\\",\\n \\"SerialNumber\\": \\"xxxxxxxx\\",\\n \\"DeviceModelId\\": 10,\\n \\"MacAddress\\": \\"00:00:00:00:00:00\\",\\n \\"DeviceType\\": \\"智能家居\\",\\n \\"DeviceId\\": \\"cn.1234567890\\",\\n \\"ProjectId\\": \\"projectTest\\",\\n \\"DeviceModel\\": \\"X1\\",\\n \\"Vin\\": \\"xxxxxxxx\\",\\n \\"UsageType\\": 0,\\n \\"UsageTypeDesc\\": \\"private\\",\\n \\"Uuid\\": \\"xxxxxxxx\\",\\n \\"HardwareId\\": \\"xxxxxxx\\",\\n \\"Region\\": \\"cn\\",\\n \\"SoftwareId\\": \\"xxxxxxxx\\",\\n \\"Name\\": \\"我的天猫精灵\\",\\n \\"DeviceBrand\\": \\"TmallGenuine\\"\\n }\\n}","errorExample":"{\\n \\"Code\\":\\"NoPermissionToAccessProject\\",\\n \\"HostId\\":\\"iovcc.cn-shanghai.aliyuncs.com\\",\\n \\"Message\\":\\"User is not authorized to access the specified project.\\",\\n \\"RequestId\\":\\"6F25F67C-F411-499F-BCE2-67CA563CB064\\"\\n}"},{"type":"xml","example":"<DescribeDeviceInfoResponse>\\r\\n<RequestId>E94C9864-56FB-44AD-AC0C-A1CEFB332254</RequestId>\\r\\n\\t<DeviceInfo>\\r\\n\\t\\t<DeviceBrand>TmallGenuine</DeviceBrand>\\r\\n\\t\\t<DeviceId>cn.1234567890</DeviceId>\\r\\n\\t\\t<DeviceModel>X1</DeviceModel>\\r\\n\\t\\t<DeviceModelId>10</DeviceModelId>\\r\\n\\t\\t<DeviceType>智能家居</DeviceType>\\r\\n\\t\\t<HardwareId>xxxxxxx</HardwareId>\\r\\n\\t\\t<MacAddress>00:00:00:00:00:00</MacAddress>\\r\\n\\t\\t<Name>我的天猫精灵</Name>\\r\\n\\t\\t<ProjectId>projectTest</ProjectId>\\r\\n\\t\\t<Region>cn</Region>\\r\\n\\t\\t<SerialNumber>xxxxxx</SerialNumber>\\r\\n\\t\\t<SoftwareId>xxxxxx</SoftwareId>\\r\\n\\t\\t<UsageType>0</UsageType>\\r\\n\\t\\t<UsageTypeDesc>private</UsageTypeDesc>\\r\\n\\t\\t<Uuid>xxxxxx</Uuid>\\r\\n\\t</DeviceInfo>\\r\\n</DescribeDeviceInfoResponse>","errorExample":""}]', - 'title' => 'DescribeDeviceInfo', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6F25F67C-F411-499F-BCE2-67CA563CB064\\",\\n \\"DeviceGroupList\\": [\\n {\\n \\"GmtModify\\": \\"2018-01-01 00:01:00\\",\\n \\"Description\\": \\"测试\\",\\n \\"GmtCreate\\": \\"2018-01-01 00:00:00\\",\\n \\"Name\\": \\"升级分组\\",\\n \\"Id\\": \\"1\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'List all test device groups under a project', + 'summary' => 'Lists all test device group information under a project by calling ListVersionDeviceGroups.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'ConnectAssistDevice' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [ + ['createdAt' => '2024-06-18T02:20:26.000Z', 'description' => 'Error codes changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'iovcc:ListVersionDeviceGroups', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + ], + 'PublishAppVersion' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - ], + 'operationType' => 'write', + 'systemTags' => ['operationType' => 'create'], 'parameters' => [ [ - 'name' => 'HardwareId', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'BALFL8429HI', - ], + 'name' => 'ProjectId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the project to which the version belongs.', 'type' => 'string', 'required' => true, 'example' => 'P0VFCREU', 'title' => ''], ], [ - 'name' => 'AllowCommandExtension', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'name' => 'VersionId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the version.', 'type' => 'string', 'required' => true, 'example' => '1', 'title' => ''], ], [ - 'name' => 'DeviceId', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '6fde56979c484b93b99fba257e3cbe83', - ], + 'name' => 'SendMessage', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to send a notification.', 'type' => 'boolean', 'required' => true, 'example' => 'false', 'title' => ''], ], - [ - 'name' => 'SerialNumber', - 'in' => 'formData', + ], + 'responses' => [ + 200 => [ 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '6F25F67C-F411-499F-BCE2-67CA563CB064', 'title' => ''], + ], 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'BALFL8429SN', + 'title' => '', + 'example' => '', ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6F25F67C-F411-499F-BCE2-67CA563CB064\\"\\n}","type":"json"}]', + 'title' => 'Publish application version', + 'summary' => 'Publishes an application version with the option to control whether an upgrade notification is pushed.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2024-06-18T02:20:25.000Z', 'description' => 'Error codes changed'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ [ - 'name' => 'VIN', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'LHK000026VFAG7A31', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'iovcc:PublishAppVersion', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + ], + 'PublishOsVersion' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'UUID', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '842972B2C0F4C9F030E60769CA65806A', - ], + 'AK' => [], ], + ], + 'operationType' => 'write', + 'systemTags' => ['operationType' => 'create'], + 'parameters' => [ [ 'name' => 'ProjectId', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'PZ1HK7JZ', - ], + 'in' => 'query', + 'schema' => ['description' => 'The ID of the project.', 'type' => 'string', 'required' => true, 'example' => 'P0VFCREU', 'title' => ''], + ], + [ + 'name' => 'VersionId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the version.', 'type' => 'string', 'required' => true, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'SendMessage', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to push a notification.', 'type' => 'boolean', 'required' => true, 'example' => 'false', 'title' => ''], ], ], 'responses' => [ @@ -15032,151 +12329,129 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '9c7a3b09-a69a-43f5-8bf2-84f7119810eb', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '6F25F67C-F411-499F-BCE2-67CA563CB064', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"9c7a3b09-a69a-43f5-8bf2-84f7119810eb\\"\\n}","errorExample":"{\\n \\"Code\\":\\"NoPermissionToAccessProject\\",\\n \\"HostId\\":\\"iovcc.cn-shanghai.aliyuncs.com\\",\\n \\"Message\\":\\"User is not authorized to access the specified project.\\",\\n \\"RequestId\\":\\"6F25F67C-F411-499F-BCE2-67CA563CB064\\"\\n}"},{"type":"xml","example":"<ConnectAssistDeviceResponse>\\r\\n<RequestId>629586FE-CB2E-4742-995E-121F952CEB72</RequestId>\\r\\n</ConnectAssistDeviceResponse>","errorExample":""}]', - 'title' => 'ConnectAssistDevice', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6F25F67C-F411-499F-BCE2-67CA563CB064\\"\\n}","type":"json"}]', + 'title' => 'Publish system version', + 'summary' => 'Publishes a system version with the option to control whether an upgrade notification is pushed.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'CountActivatedOrNewRegistrationDevice' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [ + ['createdAt' => '2024-06-18T02:20:25.000Z', 'description' => 'Error codes changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'iovcc:PublishOsVersion', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'PushMessage' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'none'], 'parameters' => [ [ - 'name' => 'ProjectId', + 'name' => 'AppPackage', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'projectTest', - ], + 'schema' => ['description' => 'The package name of the client application to which the message belongs.', 'type' => 'string', 'required' => true, 'example' => 'com.aliyun.iovcc.cmns.test', 'title' => ''], ], [ - 'name' => 'DeviceType', + 'name' => 'Desc', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'car_auto', - ], + 'schema' => ['description' => 'The notification content details. This parameter is required when the message type is notification.', 'type' => 'string', 'required' => false, 'example' => 'this is desc test', 'title' => ''], ], [ - 'name' => 'DeviceBrandId', + 'name' => 'Act', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '15', - ], + 'schema' => ['description' => 'The broadcast listening channel, which is configured by agreement between the client and the server.', 'type' => 'string', 'required' => true, 'example' => 'com.aliyun.iovcc.action', 'title' => ''], ], [ - 'name' => 'DeviceBrand', + 'name' => 'Uri', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'ROEWE', - ], + 'schema' => ['description' => 'This parameter is specific to AliOS 4.0. This parameter is required for notification and pass-through messages on AliOS devices.', 'type' => 'string', 'required' => false, 'example' => 'page://broadcast.yunos.com', 'title' => ''], ], [ - 'name' => 'DeviceModelId', + 'name' => 'PkgContent', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '105', - ], + 'schema' => ['description' => 'The Android intent property value parameter. The value is a JSON string. You can set the following five intent property keys: "component", "uri", "type", "package", and "category".', 'type' => 'string', 'required' => true, 'example' => '{"package":"com.aliyun.iovcc.cmns.test"}', 'title' => ''], ], [ - 'name' => 'DeviceModel', + 'name' => 'CustomContent', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'ROEWE RX5', - ], + 'schema' => ['description' => 'The custom content defined by the user.'."\n" + ."\n" + .'The value is a JSON string. The keyword "cmns" must not be used as a field in the JSON string. This parameter is required when the message type is pass-through (type=1).', 'type' => 'string', 'required' => false, 'example' => '{"key1":"value1","key2":"value2"}', 'title' => ''], ], [ - 'name' => 'DeviceCountStatType', + 'name' => 'ReceiverType', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'byDay', - ], + 'schema' => ['description' => 'The message accept object type. Valid values: **uuid**, **imei**, **kp**, and **terminal**.'."\n" + ."\n" + .'- To send messages by device dimension, set this parameter to **uuid** or **imei**.'."\n" + .'- To send messages by account dimension, set this parameter to **kp**.'."\n" + .'- To send messages by device type dimension, set this parameter to **terminal**.', 'type' => 'string', 'required' => true, 'example' => 'uuid', 'title' => ''], ], [ - 'name' => 'IsQueryNewRegistrationDevice', + 'name' => 'ReceiverValues', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'false', - ], + 'schema' => ['description' => 'The values of the message recipients. Separate multiple recipients with commas (,).'."\n" + ."\n" + .'- When using **uuid** or **imei** values, a maximum of 1000 devices are supported.'."\n" + .'- When using **kp** values, a maximum of 100 accounts are supported.'."\n" + .'- When using **terminal** values, a maximum of 10 device models are supported.', 'type' => 'string', 'required' => true, 'example' => 'b81d39b0252a4ffdb750360b262cb442, b81d39b0252a4ffdb750360b262cb411', 'title' => ''], ], [ - 'name' => 'StartTime', + 'name' => 'ExpiredTime', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '2018-08-15 12:00:00', - ], + 'schema' => ['description' => 'The message expiration time.'."\n" + ."\n" + .'This is a relative time value (the number of seconds before the message expires). The maximum value is 7 days for unicast messages and 30 days for broadcast messages. Unit: seconds. Default value: 3600 (1 hour).', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '7200', 'title' => ''], ], [ - 'name' => 'EndTime', + 'name' => 'Title', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '2018-08-25 12:00:00', - ], + 'schema' => ['description' => 'The notification title. This parameter is required when the message type is notification.', 'type' => 'string', 'required' => false, 'example' => 'this is test test', 'title' => ''], ], [ - 'name' => 'IsQueryYearlyActivate', + 'name' => 'ProjectId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'false', - ], + 'schema' => ['description' => 'The IoVCC project ID.', 'type' => 'string', 'required' => true, 'example' => 'sfgsghd6', 'title' => ''], + ], + [ + 'name' => 'AppKey', + 'in' => 'query', + 'schema' => ['description' => 'The CMNS client application AppKey.', 'type' => 'string', 'required' => true, 'example' => 'com.aliyun.aicc.test', 'title' => ''], + ], + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => ['description' => 'The message type. Valid values:'."\n" + .'- **1**: pass-through message.'."\n" + .'- **2**: notification.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1', 'title' => ''], ], ], 'responses' => [ @@ -15184,105 +12459,67 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '6F25F67C-F411-499F-BCE2-67CA563CB064', - ], - 'Statistics' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Categories' => [ - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => '["1568217600000","1568649600000"]', - ], - ], - 'Series' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Data' => [ - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => '[3,3]', - ], - ], - 'Name' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'increment', - ], - ], - ], - ], - ], - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '629586FE-CB2E-4742-995E-121F952CEB72', 'title' => ''], + 'Mid' => ['description' => 'The message ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '354677', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"6F25F67C-F411-499F-BCE2-67CA563CB064\\",\\n \\"Statistics\\": {\\n \\"Series\\": [\\n {\\n \\"Name\\": \\"increment\\",\\n \\"Data\\": [\\n \\"[3,3]\\"\\n ]\\n }\\n ],\\n \\"Categories\\": [\\n \\"[\\\\\\"1568217600000\\\\\\",\\\\\\"1568649600000\\\\\\"]\\"\\n ]\\n }\\n}","errorExample":"{\\n \\"RequestId\\": \\"6F25F67C-F411-499F-BCE2-67CA563CB064\\",\\n \\"HostId\\": \\"iovcc.cn-shanghai.aliyuncs.com\\",\\n \\"Code\\": \\"NoPermission.NotOwner\\",\\n \\"Message\\": \\"You have no permission because you are not the owner of the data\\"\\n}"},{"type":"xml","example":"","errorExample":""}]', - 'title' => 'CountActivatedOrNewRegistrationDevice', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"629586FE-CB2E-4742-995E-121F952CEB72\\",\\n \\"Mid\\": 354677\\n}","type":"json"}]', + 'title' => 'Push message to device', + 'summary' => 'Pushes a message to devices. Two message types are supported: pass-through and notification.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'CountDeviceBrands' => [ - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'iovcc:PushMessage', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'PushVersionMessage' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'none'], 'parameters' => [ [ - 'name' => 'DeviceBrandId', + 'name' => 'ProjectId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'The ID of the project.', 'type' => 'string', 'required' => true, 'example' => 'P0VFCREU', 'title' => ''], ], [ - 'name' => 'DeviceBrand', + 'name' => 'VersionId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'Tmall', - ], + 'schema' => ['description' => 'The version ID.', 'type' => 'string', 'required' => true, 'example' => '1', 'title' => ''], ], [ - 'name' => 'ProjectId', + 'name' => 'VersionType', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'projectTest', - ], + 'schema' => ['description' => 'The version type. Valid values:'."\n" + ."\n" + .'- **FOTA**: system version.'."\n" + .'- **APP**: application version.', 'type' => 'string', 'required' => true, 'example' => 'FOTA', 'title' => ''], ], ], 'responses' => [ @@ -15290,85 +12527,151 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '9c7a3b09-a69a-43f5-8bf2-84f7119810eb', - ], - 'BrandCount' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '6F25F67C-F411-499F-BCE2-67CA563CB064', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"BrandCount\\": 2,\\n \\"RequestId\\": \\"9c7a3b09-a69a-43f5-8bf2-84f7119810eb\\"\\n}","errorExample":"{\\n \\"Code\\":\\"NoPermissionToAccessProject\\",\\n \\"HostId\\":\\"iovcc.cn-shanghai.aliyuncs.com\\",\\n \\"Message\\":\\"User is not authorized to access the specified project.\\",\\n \\"RequestId\\":\\"6F25F67C-F411-499F-BCE2-67CA563CB064\\"\\n}"},{"type":"xml","example":"<CountDeviceBrandsResponse>\\r\\n\\t<RequestId>E94C9864-56FB-44AD-AC0C-A1CEFB332254</RequestId>\\r\\n\\t<Results>2</Results>\\r\\n</CountDeviceBrandsResponse>","errorExample":""}]', - 'title' => 'CountDeviceBrands', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6F25F67C-F411-499F-BCE2-67CA563CB064\\"\\n}","type":"json"}]', + 'title' => 'Push upgrade message to all device models under a version', + 'summary' => 'Pushes an upgrade message to all device models under a specified version by calling PushVersionMessage.', + 'description' => '> You can push messages only to versions in the "Pre-release" or "Published" status.'."\n" + ."\n" + .'- For system version pushes, because a system version is associated with only one device model, the upgrade message is pushed to all devices under that device model.'."\n" + .'- For application version pushes, the upgrade message is pushed to devices covered by all device models associated with the application version.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'CountDeviceModels' => [ - 'methods' => [ - 'get', + 'changeSet' => [ + ['createdAt' => '2024-06-18T02:20:25.000Z', 'description' => 'Error codes changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'iovcc:PushVersionMessage', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + ], + 'QueryPrepublishPassedDeviceCount' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'ProjectId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'projectTest', - ], + 'schema' => ['description' => 'The ID of the project.', 'type' => 'string', 'required' => true, 'example' => 'P0VFCREU', 'title' => ''], ], [ - 'name' => 'DeviceModelId', + 'name' => 'PrepublishId', 'in' => 'query', + 'schema' => ['description' => 'The ID of the pre-release.', 'type' => 'string', 'required' => true, 'example' => '1', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '6F25F67C-F411-499F-BCE2-67CA563CB064', 'title' => ''], + 'Count' => ['description' => 'The number of queried devices for the pre-release.', 'type' => 'integer', 'format' => 'int32', 'example' => '1000', 'title' => ''], + ], 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', + 'title' => '', + 'example' => '', ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6F25F67C-F411-499F-BCE2-67CA563CB064\\",\\n \\"Count\\": 1000\\n}","type":"json"}]', + 'title' => 'Query the number of queried devices for a specified pre-release', + 'summary' => 'Queries the number of queried devices for a specified pre-release. The queried devices are deduplicated based on their cloud device IDs.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2024-06-18T02:20:25.000Z', 'description' => 'Error codes changed'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ [ - 'name' => 'DeviceModel', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'X1', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'iovcc:QueryPrepublishPassedDeviceCount', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + ], + 'SubmitAssistReport' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'DeviceBrand', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'TmallGenius', - ], + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => ['operationType' => 'create'], + 'parameters' => [ + [ + 'name' => 'ProjectId', + 'in' => 'formData', + 'schema' => ['description' => 'The project ID.', 'type' => 'string', 'required' => true, 'example' => 'PZ1HK7JZ', 'title' => ''], + ], + [ + 'name' => 'AssistId', + 'in' => 'formData', + 'schema' => ['description' => 'The diagnostic session ID.', 'type' => 'string', 'required' => true, 'example' => '510', 'title' => ''], + ], + [ + 'name' => 'AssistDescription', + 'in' => 'formData', + 'schema' => ['description' => 'The description of the diagnosed bug, including the symptoms and steps to reproduce the issue.', 'type' => 'string', 'required' => false, 'example' => '设备时间异常', 'title' => ''], + ], + [ + 'name' => 'AssistResult', + 'in' => 'formData', + 'schema' => ['description' => 'The diagnostic conclusion.', 'type' => 'string', 'required' => false, 'example' => '手动设置正确时间', 'title' => ''], + ], + [ + 'name' => 'AssistTag', + 'in' => 'formData', + 'schema' => ['description' => 'The diagnostic labels used for history queries. Separate multiple labels with spaces.', 'type' => 'string', 'required' => false, 'example' => '系统时间', 'title' => ''], + ], + [ + 'name' => 'AssistReason', + 'in' => 'formData', + 'schema' => ['description' => 'The root cause analysis of the diagnosis, describing the primary cause of the issue.', 'type' => 'string', 'required' => false, 'example' => '没有和时间服务器同步', 'title' => ''], + ], + [ + 'name' => 'DeviceModel', + 'in' => 'formData', + 'schema' => ['description' => 'The device model.', 'type' => 'string', 'required' => false, 'example' => 'ModelS', 'title' => ''], ], ], 'responses' => [ @@ -15376,75 +12679,68 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '9c7a3b09-a69a-43f5-8bf2-84f7119810eb', - ], - 'ModelCount' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '9c7a3b09-a69a-43f5-8bf2-84f7119810eb', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"ModelCount\\": 10,\\n \\"RequestId\\": \\"9c7a3b09-a69a-43f5-8bf2-84f7119810eb\\"\\n}","errorExample":"{\\n \\"Message\\": \\"NO_PERMISSION_TO_ACCESS_PROJECT\\",\\n \\"RequestId\\": \\"81275440-EF9D-4570-A78F-7576441D3BF8\\",\\n \\"Results\\": [],\\n \\"Code\\": 10007\\n }"},{"type":"xml","example":"<CountDeviceModelsResponse>\\r\\n\\t<Message>SUCCESS</Message>\\r\\n\\t<RequestId>E94C9864-56FB-44AD-AC0C-A1CEFB332254</RequestId>\\r\\n\\t<Results>1</Results>\\r\\n\\t<Code>200</Code>\\r\\n</CountDeviceModelsResponse>","errorExample":""}]', - 'title' => 'CountDeviceModels', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9c7a3b09-a69a-43f5-8bf2-84f7119810eb\\"\\n}","type":"json"}]', + 'title' => 'Submit a remote diagnostic report', + 'summary' => 'Submits a remote diagnostic report by calling SubmitAssistReport.', + 'description' => '> For a single diagnosis, the first submission creates a report, and subsequent submissions update the report content.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'CountDevices' => [ - 'methods' => [ - 'get', + 'changeSet' => [ + ['createdAt' => '2024-06-18T02:20:25.000Z', 'description' => 'Error codes changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'iovcc:SubmitAssistReport', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + ], + 'UpdateApiGatewayAppStatus' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - ], + 'operationType' => 'write', + 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ 'name' => 'ProjectId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'projectTest', - ], + 'schema' => ['description' => 'The project ID.', 'type' => 'string', 'required' => true, 'example' => 'PPCVFRG7', 'title' => ''], ], [ - 'name' => 'DeviceModelId', + 'name' => 'GatewayAppId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'The gateway application AppId.', 'type' => 'string', 'required' => true, 'example' => '5929076', 'title' => ''], ], [ - 'name' => 'DeviceModel', + 'name' => 'Status', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'Device Model', - ], + 'schema' => ['description' => 'The status. Valid values:'."\n" + .'- 0: Normal.'."\n" + .'- 1: disabled.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1', 'title' => ''], ], ], 'responses' => [ @@ -15452,197 +12748,231 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '9c7a3b09-a69a-43f5-8bf2-84f7119810eb', - ], - 'DeviceCount' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '100', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '6F25F67C-F411-499F-BCE2-67CA563CB064', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"DeviceCount\\": 100,\\n \\"RequestId\\": \\"9c7a3b09-a69a-43f5-8bf2-84f7119810eb\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => 'CountDevices', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6F25F67C-F411-499F-BCE2-67CA563CB064\\"\\n}","type":"json"}]', + 'title' => 'Modify the status of a gateway app associated with a project', + 'summary' => 'Modifies the status of a gateway app associated with a project by calling UpdateApiGatewayAppStatus.', + 'description' => '> When the app is disabled, clients cannot call the APIs exposed by IoVCC through API Gateway.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'CountYunIdInfo' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [ + ['createdAt' => '2024-06-18T02:20:25.000Z', 'description' => 'Error codes changed'], + ], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'iovcc:UpdateApiGatewayAppStatus', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'UpdateAppBlackWhiteVersions' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', + 'systemTags' => ['operationType' => 'update'], + 'parameters' => [ + [ + 'name' => 'WhiteAppVersions', + 'in' => 'query', + 'schema' => ['description' => 'The list of whitelisted version codes, separated by commas. Blacklists and whitelists cannot be configured at the same time in Settings.', 'type' => 'string', 'required' => false, 'example' => '12,13,14', 'title' => ''], + ], + [ + 'name' => 'ProjectId', + 'in' => 'query', + 'schema' => ['description' => 'The project ID.', 'type' => 'string', 'required' => true, 'example' => 'P0VFCREU', 'title' => ''], + ], + [ + 'name' => 'VersionId', + 'in' => 'query', + 'schema' => ['description' => 'The version ID.', 'type' => 'string', 'required' => true, 'example' => '12345', 'title' => ''], + ], + [ + 'name' => 'BlackAppVersions', + 'in' => 'query', + 'schema' => ['description' => 'The list of blacklisted version codes, separated by commas. Blacklists and whitelists cannot be configured at the same time in Settings.', 'type' => 'string', 'required' => false, 'example' => '12,13,14', 'title' => ''], + ], ], - 'parameters' => [], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'E94C9864-56FB-44AD-AC0C-A1CEFB332254', - ], - 'YunIdInfo' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'TotalBrandCount' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '5', - ], - 'TotalDeviceCount' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'TotalDeviceModelCount' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10', - ], - ], - ], - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '6F25F67C-F411-499F-BCE2-67CA563CB064', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"E94C9864-56FB-44AD-AC0C-A1CEFB332254\\",\\n \\"YunIdInfo\\": [\\n {\\n \\"TotalDeviceModelCount\\": 10,\\n \\"TotalBrandCount\\": 5,\\n \\"TotalDeviceCount\\": 100\\n }\\n ]\\n}","errorExample":"{\\n \\"Code\\":\\"NoPermissionToAccessProject\\",\\n \\"HostId\\":\\"iovcc.cn-shanghai.aliyuncs.com\\",\\n \\"Message\\":\\"User is not authorized to access the specified project.\\",\\n \\"RequestId\\":\\"6F25F67C-F411-499F-BCE2-67CA563CB064\\"\\n}"},{"type":"xml","example":"<RequestId>E94C9864-56FB-44AD-AC0C-A1CEFB332254</RequestId>\\n<YunIdInfo>\\n <TotalBrandCount>5</TotalBrandCount>\\n <TotalDeviceModelCount>10</TotalDeviceModelCount>\\n <TotalDeviceCount>100</TotalDeviceCount>\\n</YunIdInfo>","errorExample":""}]', - 'title' => 'CountYunIdInfo', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6F25F67C-F411-499F-BCE2-67CA563CB064\\"\\n}","type":"json"}]', + 'title' => 'Update blacklists and whitelists of an application version', + 'summary' => 'Invokes UpdateAppBlackWhiteVersions to update the blacklists and whitelists of an application version.', + 'description' => 'For example, if you want to configure an application version so that only specific earlier versions can be upgraded to this version, you can configure a version whitelist in Settings. Blacklists and whitelists cannot be configured at the same time.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'DiagnosisVersion' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [ + ['createdAt' => '2024-06-18T02:20:25.000Z', 'description' => 'Error codes changed'], + ], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'iovcc:UpdateAppBlackWhiteVersions', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'UpdateAppVersion' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ - 'name' => 'OriginalId', + 'name' => 'BlackVersionList', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'b8fe2e24ff2b48e0a3aa4e49809fc1b3', - ], + 'schema' => ['description' => 'The version blacklist. Separate multiple version codes with commas (,).', 'type' => 'string', 'required' => false, 'example' => '10,20,30', 'title' => ''], + ], + [ + 'name' => 'IsAllowNewInstall', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether the server is allowed to return this application version when the application does not exist on the client.', 'type' => 'string', 'required' => false, 'example' => 'N', 'title' => ''], ], [ 'name' => 'ProjectId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'P0VFCREU', - ], + 'schema' => ['description' => 'The project ID.', 'type' => 'string', 'required' => true, 'example' => 'P0VFCREU', 'title' => ''], ], [ - 'name' => 'VersionType', + 'name' => 'AppId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'FOTA', - ], + 'schema' => ['description' => 'The application ID. Specifies the application to upgrade.', 'type' => 'string', 'required' => false, 'example' => '123', 'title' => ''], ], [ - 'name' => 'VersionId', + 'name' => 'AppVersion', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '1', - ], + 'schema' => ['description' => 'The application version number.', 'type' => 'string', 'required' => false, 'example' => '1.0', 'title' => ''], ], [ - 'name' => 'IdType', + 'name' => 'VersionCode', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'device_id', - ], + 'schema' => ['description' => 'The version code of the application.', 'type' => 'string', 'required' => false, 'example' => '100', 'title' => ''], ], [ - 'name' => 'DiagnoseStyle', + 'name' => 'InstallType', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '1', - ], + 'schema' => ['description' => 'The installation method of the application upgrade package. Valid values: **auto** / **customize**.', 'type' => 'string', 'required' => false, 'example' => 'auto', 'title' => ''], ], [ - 'name' => 'StartTime', + 'name' => 'Remark', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '2019-09-18 10:44', - ], + 'schema' => ['description' => 'The remarks for the version.', 'type' => 'string', 'required' => false, 'example' => 'sample remark', 'title' => ''], ], [ - 'name' => 'EndTime', + 'name' => 'IsForceUpgrade', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => '2019-09-18 14:44', - ], + 'schema' => ['description' => 'Specifies whether to force an upgrade. Valid values: Y and N.', 'type' => 'string', 'required' => false, 'example' => 'N', 'title' => ''], + ], + [ + 'name' => 'IsSilentUpgrade', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to perform a silent upgrade. Valid values: Y and N.', 'type' => 'string', 'required' => false, 'example' => 'N', 'title' => ''], + ], + [ + 'name' => 'IsNeedRestart', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether a restart is required. Valid values: Y and N.', 'type' => 'string', 'required' => false, 'example' => 'N', 'title' => ''], + ], + [ + 'name' => 'PackageUrl', + 'in' => 'query', + 'schema' => ['description' => 'The URL of the upgrade package.', 'type' => 'string', 'required' => false, 'example' => 'http://www.oss-server.com/file.zip', 'title' => ''], + ], + [ + 'name' => 'ReleaseNote', + 'in' => 'query', + 'schema' => ['description' => 'The release notes for the version.', 'type' => 'string', 'required' => false, 'example' => 'sample release note', 'title' => ''], + ], + [ + 'name' => 'WhiteVersionList', + 'in' => 'query', + 'schema' => ['description' => 'The version whitelist. Separate multiple version codes with commas (,).', 'type' => 'string', 'required' => false, 'example' => '10,20,30', 'title' => ''], + ], + [ + 'name' => 'RestartType', + 'in' => 'query', + 'schema' => ['description' => 'The restart type after the application installation is complete. Valid values:'."\n" + ."\n" + .'- **system**: system restart.'."\n" + .'- **app**: application restart.', 'type' => 'string', 'required' => false, 'example' => 'app', 'title' => ''], + ], + [ + 'name' => 'RestartAppType', + 'in' => 'query', + 'schema' => ['description' => 'The type of application restart when restartType is set to application restart. Valid values:'."\n" + ."\n" + .'- **service**: Service restart.'."\n" + .'- **activity**: Activity restart.', 'type' => 'string', 'required' => false, 'example' => 'service', 'title' => ''], + ], + [ + 'name' => 'RestartAppParam', + 'in' => 'query', + 'schema' => ['description' => 'The restart parameters that can be specified by the server when the application restarts.', 'type' => 'string', 'required' => false, 'example' => '{"restartDelay":1}', 'title' => ''], + ], + [ + 'name' => 'DeviceAdapterList', + 'in' => 'query', + 'schema' => ['description' => 'The list of compatible device models for the application version.'."\n" + ."\n" + .'Format: `deviceModelId|minOsVersion|maxOsVersion`, which represents device model ID|minimum OS version|maximum OS version.', 'type' => 'string', 'required' => false, 'example' => '10|2.0.1-R-20180412.1024|3.0.1-R-20180412.1024,11|2.1.1-R-20180412.1024|3.1.1-R-20180412.1024', 'title' => ''], + ], + [ + 'name' => 'VersionId', + 'in' => 'query', + 'schema' => ['description' => 'The version ID.', 'type' => 'string', 'required' => false, 'example' => '11', 'title' => ''], + ], + [ + 'name' => 'ApkMd5', + 'in' => 'query', + 'schema' => ['description' => 'The MD5 value of the APK.', 'type' => 'string', 'required' => false, 'example' => '34653456wertwe234653retwewer3456', 'title' => ''], ], ], 'responses' => [ @@ -15650,95 +12980,132 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '6F25F67C-F411-499F-BCE2-67CA563CB064', - ], - 'DiagnosisResult' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '6F25F67C-F411-499F-BCE2-67CA563CB064', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"DiagnosisResult\\": \\"无效的机型\\",\\n \\"RequestId\\": \\"6F25F67C-F411-499F-BCE2-67CA563CB064\\"\\n}","errorExample":"{\\n \\"RequestId\\": \\"6F25F67C-F411-499F-BCE2-67CA563CB064\\",\\n \\"HostId\\": \\"iovcc.cn-shanghai.aliyuncs.com\\",\\n \\"Code\\": \\"NoPermission.NotOwner\\",\\n \\"Message\\": \\"You have no permission because you are not the owner of the data\\"\\n}"},{"type":"xml","example":"<DiagnosisVersionResponse>\\r\\n\\t<RequestId>6F25F67C-F411-499F-BCE2-67CA563CB064</RequestId>\\r\\n\\t<DiagnosisResult>无效的机型</DiagnosisResult>\\r\\n</DiagnosisVersionResponse>","errorExample":""}]', - 'title' => 'DiagnosisVersion', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6F25F67C-F411-499F-BCE2-67CA563CB064\\"\\n}","type":"json"}]', + 'title' => 'Update application upgrade version configuration', + 'summary' => 'Calls UpdateAppVersion to update the configuration of an application upgrade version.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'FindPrepublishPassedDevices' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [ + ['createdAt' => '2024-06-18T02:20:25.000Z', 'description' => 'Error codes changed'], ], - 'schemes' => [ - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'iovcc:UpdateAppVersion', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + ], + 'UpdateAppVersionReleaseNote' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ - 'name' => 'PrepublishId', + 'name' => 'ProjectId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '1', - ], + 'schema' => ['description' => 'The project ID.', 'type' => 'string', 'required' => true, 'example' => 'P0VFCREU', 'title' => ''], ], [ - 'name' => 'ProjectId', + 'name' => 'VersionId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'P0VFCREU', - ], + 'schema' => ['description' => 'The version ID.', 'type' => 'string', 'required' => true, 'example' => '12345', 'title' => ''], ], [ - 'name' => 'PageIndex', + 'name' => 'ReleaseNote', 'in' => 'query', + 'schema' => ['description' => 'The release notes.', 'type' => 'string', 'required' => true, 'example' => 'sample release note', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '6F25F67C-F411-499F-BCE2-67CA563CB064', 'title' => ''], + ], 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '1', + 'title' => '', + 'example' => '', ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6F25F67C-F411-499F-BCE2-67CA563CB064\\"\\n}","type":"json"}]', + 'title' => 'Update release notes of an application version', + 'summary' => 'Updates the release notes of an application version by calling UpdateAppVersionReleaseNote.', + 'description' => '> You can call this operation to update the release notes of a version that is in canary release or has been published.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2024-06-18T02:20:25.000Z', 'description' => 'Error codes changed'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '20', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'iovcc:UpdateAppVersionReleaseNote', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + ], + 'UpdateAppVersionRemark' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'DeviceId', + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => ['operationType' => 'update'], + 'parameters' => [ + [ + 'name' => 'ProjectId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'b8fe2e24ff2b48e0a3aa4e49809fc1b3', - ], + 'schema' => ['description' => 'The project ID.', 'type' => 'string', 'required' => true, 'example' => 'P0VFCREU', 'title' => ''], + ], + [ + 'name' => 'VersionId', + 'in' => 'query', + 'schema' => ['description' => 'The version ID.', 'type' => 'string', 'required' => true, 'example' => '123', 'title' => ''], + ], + [ + 'name' => 'Remark', + 'in' => 'query', + 'schema' => ['description' => 'The remark information of the version.', 'type' => 'string', 'required' => true, 'example' => 'sample remark', 'title' => ''], ], ], 'responses' => [ @@ -15746,147 +13113,159 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '6F25F67C-F411-499F-BCE2-67CA563CB064', - ], - 'DeviceList' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Items' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'GmtCreateTimestamp' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '124643600000', - ], - 'DeviceId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'b8fe2e24ff2b48e0a3aa4e49809fc1b3', - ], - 'GmtCreate' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2018-01-01 00:00:00', - ], - ], - ], - ], - 'TotalCount' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - ], - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '6F25F67C-F411-499F-BCE2-67CA563CB064', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"6F25F67C-F411-499F-BCE2-67CA563CB064\\",\\n \\"DeviceList\\": {\\n \\"TotalCount\\": 2,\\n \\"Items\\": [\\n {\\n \\"GmtCreate\\": \\"2018-01-01 00:00:00\\",\\n \\"GmtCreateTimestamp\\": 124643600000,\\n \\"DeviceId\\": \\"b8fe2e24ff2b48e0a3aa4e49809fc1b3\\"\\n }\\n ]\\n }\\n}","errorExample":"{\\n \\"RequestId\\": \\"6F25F67C-F411-499F-BCE2-67CA563CB064\\",\\n \\"HostId\\": \\"iovcc.cn-shanghai.aliyuncs.com\\",\\n \\"Code\\": \\"NoPermission.NotOwner\\",\\n \\"Message\\": \\"You have no permission because you are not the owner of the data\\"\\n}"},{"type":"xml","example":"<FindPrepublishPassedDevicesResponse>\\r\\n\\t<RequestId>6F25F67C-F411-499F-BCE2-67CA563CB064</RequestId>\\r\\n\\t<DeviceList>\\r\\n\\t\\t<TotalCount>30</TotalCount>\\r\\n\\t\\t<Items>\\r\\n\\t\\t\\t<DeviceId>b8fe2e24ff2b48e0a3aa4e49809fc1b3</DeviceId>\\r\\n\\t\\t\\t<GmtCreate>2018-01-01 00:00:00</GmtCreate>\\r\\n\\t\\t</Items>\\r\\n\\t</DeviceList>\\r\\n</FindPrepublishPassedDevicesResponse>","errorExample":""}]', - 'title' => 'FindPrepublishPassedDevices', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6F25F67C-F411-499F-BCE2-67CA563CB064\\"\\n}","type":"json"}]', + 'title' => 'Update remark information', + 'summary' => 'Updates the remark information after a version is created.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'FindVersionBlackDevices' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [ + ['createdAt' => '2024-06-18T02:20:25.000Z', 'description' => 'Error codes changed'], ], - 'schemes' => [ - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'iovcc:UpdateAppVersionRemark', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + ], + 'UpdateAppVersionStatus' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ 'name' => 'ProjectId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'P0VFCREU', - ], + 'schema' => ['description' => 'The project ID.', 'type' => 'string', 'required' => true, 'example' => 'P0VFCREU', 'title' => ''], ], [ - 'name' => 'VersionId', + 'name' => 'Id', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '12345', - ], + 'schema' => ['description' => 'The version ID.', 'type' => 'string', 'required' => true, 'example' => '12345', 'title' => ''], ], [ - 'name' => 'VersionType', + 'name' => 'Status', 'in' => 'query', + 'schema' => ['description' => 'The version status.', 'type' => 'string', 'required' => false, 'example' => 'PUBLISHED', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '6F25F67C-F411-499F-BCE2-67CA563CB064', 'title' => ''], + ], 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'FOTA', + 'title' => '', + 'example' => '', ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6F25F67C-F411-499F-BCE2-67CA563CB064\\"\\n}","type":"json"}]', + 'title' => 'Switch application version status', + 'summary' => 'Switches the status of an application version among test passed, published, delisted, and canceled.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2024-06-18T02:20:25.000Z', 'description' => 'Error codes changed'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ [ - 'name' => 'DeviceId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'AS23DG23SA5D43GA34SD23GW456E', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'iovcc:UpdateAppVersionStatus', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + ], + 'UpdateCustomizedFilter' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'OriginalId', + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => ['operationType' => 'update'], + 'parameters' => [ + [ + 'name' => 'BlackWhiteType', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '23452345234523452', - ], + 'schema' => ['description' => 'The type of blacklists and whitelists for comparison. Valid values: '."\n" + ."\n" + .'- **BLACK**: blacklist '."\n" + .'- **WHITE**: whitelist.', 'type' => 'string', 'required' => true, 'example' => 'BLACK', 'title' => ''], ], [ - 'name' => 'PageIndex', + 'name' => 'ProjectId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '1', - ], + 'schema' => ['description' => 'The ID of the project.', 'type' => 'string', 'required' => true, 'example' => 'P0VFCREU', 'title' => ''], ], [ - 'name' => 'PageSize', + 'name' => 'Name', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '20', - ], + 'schema' => ['description' => 'The name of the filter condition.', 'type' => 'string', 'required' => true, 'example' => 'AnotherFilter', 'title' => ''], + ], + [ + 'name' => 'Value', + 'in' => 'query', + 'schema' => ['description' => 'The value of the filter condition.', 'type' => 'string', 'required' => true, 'example' => '1,4', 'title' => ''], + ], + [ + 'name' => 'ValueType', + 'in' => 'query', + 'schema' => ['description' => 'The type of the filter condition value.'."\n" + ."\n" + .'The only valid value is **WRITE**.', 'type' => 'string', 'required' => true, 'example' => 'WRITE', 'title' => ''], + ], + [ + 'name' => 'ValueCompareType', + 'in' => 'query', + 'schema' => ['description' => 'The comparison type of the value. Valid values:'."\n" + ."\n" + .'- **NUMBER**: Compare by number. '."\n" + .'- **STRING**: Compare by string.', 'type' => 'string', 'required' => true, 'example' => 'NUMBER', 'title' => ''], + ], + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the custom filter condition to update.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1', 'title' => ''], ], ], 'responses' => [ @@ -15894,224 +13273,119 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '6F25F67C-F411-499F-BCE2-67CA563CB064', - ], - 'DeviceList' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Items' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'GmtCreateTimestamp' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '168566700000', - ], - 'OriginalId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '23452345234523452', - ], - 'DeviceId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'AS23DG23SA5D43GA34SD23GW456E', - ], - 'IdType' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'hardware_id', - ], - 'GmtCreate' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2018-02-14 14:20:18', - ], - 'Id' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '123', - ], - ], - ], - ], - 'TotalCount' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '25', - ], - ], - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '6F25F67C-F411-499F-BCE2-67CA563CB064', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"6F25F67C-F411-499F-BCE2-67CA563CB064\\",\\n \\"DeviceList\\": {\\n \\"TotalCount\\": 25,\\n \\"Items\\": [\\n {\\n \\"GmtCreateTimestamp\\": 168566700000,\\n \\"OriginalId\\": \\"23452345234523452\\",\\n \\"DeviceId\\": \\"AS23DG23SA5D43GA34SD23GW456E\\",\\n \\"IdType\\": \\"hardware_id\\",\\n \\"GmtCreate\\": \\"2018-02-14 14:20:18\\",\\n \\"Id\\": 123\\n }\\n ]\\n }\\n}","errorExample":"{\\n \\"RequestId\\": \\"6F25F67C-F411-499F-BCE2-67CA563CB064\\",\\n \\"HostId\\": \\"iovcc.cn-shanghai.aliyuncs.com\\",\\n \\"Code\\": \\"NoPermissionToAccessProject\\",\\n \\"Message\\": \\"User is not authorized to access the specified project.\\"\\n}"},{"type":"xml","example":"<FindVersionBlackDevicesResponse>\\r\\n\\t<RequestId>6F25F67C-F411-499F-BCE2-67CA563CB064</RequestId>\\r\\n\\t<DeviceList>\\r\\n\\t\\t<TotalCount>25</TotalCount>\\r\\n\\t\\t<Items>\\r\\n\\t\\t\\t<Id>1</Id>\\r\\n\\t\\t\\t<DeviceId>AS23DG23SA5D43GA34SD23GW456E</DeviceId>\\r\\n\\t\\t\\t<IdType>hardware_id</IdType>\\r\\n\\t\\t\\t<OriginalId>23452345234523452</OriginalId>\\r\\n\\t\\t\\t<GmtCreate>2018-02-14 14:20:18</GmtCreate>\\r\\n\\t\\t</Items>\\r\\n\\t</DeviceList>\\r\\n</FindVersionBlackDevicesResponse>","errorExample":""}]', - 'title' => 'FindVersionBlackDevices', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6F25F67C-F411-499F-BCE2-67CA563CB064\\"\\n}","type":"json"}]', + 'title' => 'Update a custom filter condition', + 'summary' => 'Calls UpdateCustomizedFilter to update a custom filter condition.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'PushMessage' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [ + ['createdAt' => '2024-06-18T02:20:25.000Z', 'description' => 'Error codes changed'], + ], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'iovcc:UpdateCustomizedFilter', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'UpdateDeviceModel' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'none', - ], + 'operationType' => 'write', + 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ - 'name' => 'AppPackage', + 'name' => 'InitUsageType', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'com.aliyun.iovcc.cmns.test', - ], + 'schema' => ['description' => 'The initial usage type of the device.'."\n" + ."\n" + .'Valid values:'."\n" + .'- 0: personal device.'."\n" + .'- 1: commercial or shared device.', 'type' => 'string', 'required' => false, 'example' => '0', 'title' => ''], ], [ - 'name' => 'Desc', + 'name' => 'ModelName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'this is desc test', - ], + 'schema' => ['description' => 'The name of the device model.', 'type' => 'string', 'required' => false, 'example' => 'X2', 'title' => ''], ], [ - 'name' => 'Act', + 'name' => 'Id', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'com.aliyun.iovcc.action', - ], + 'schema' => ['description' => 'The device model ID.', 'type' => 'string', 'required' => false, 'example' => '10', 'title' => ''], ], [ - 'name' => 'Uri', + 'name' => 'BrandName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'page://broadcast.yunos.com', - ], + 'schema' => ['description' => 'The brand name.', 'type' => 'string', 'required' => false, 'example' => 'ROEWE', 'title' => ''], ], [ - 'name' => 'PkgContent', + 'name' => 'Description', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '{"package":"com.aliyun.iovcc.cmns.test"}', - ], + 'schema' => ['description' => 'The model description.', 'type' => 'string', 'required' => false, 'example' => '荣威 RX5', 'title' => ''], ], [ - 'name' => 'CustomContent', + 'name' => 'DeviceType', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '{"key1":"value1","key2":"value2"}', - ], + 'schema' => ['description' => 'The device type.', 'type' => 'string', 'required' => false, 'example' => 'car_auto', 'title' => ''], ], [ - 'name' => 'ReceiverType', + 'name' => 'CanCreateDeviceId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'uuid', - ], + 'schema' => ['description' => 'Specifies whether the model is allowed to create device IDs.', 'type' => 'string', 'required' => false, 'example' => 'true', 'title' => ''], ], [ - 'name' => 'ReceiverValues', + 'name' => 'ProjectId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'b81d39b0252a4ffdb750360b262cb442, b81d39b0252a4ffdb750360b262cb411', - ], + 'schema' => ['description' => 'The project ID.', 'type' => 'string', 'required' => false, 'example' => 'projectTest', 'title' => ''], ], [ - 'name' => 'ExpiredTime', + 'name' => 'HardwareType', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '7200', - ], + 'schema' => ['description' => 'The hardware type.', 'type' => 'string', 'required' => false, 'example' => 'hardware_id', 'title' => ''], ], [ - 'name' => 'Title', + 'name' => 'SecurityChip', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'this is test test', - ], + 'schema' => ['description' => 'Specifies whether to enable chip ID2 authentication hardening.', 'type' => 'string', 'required' => false, 'example' => '0', 'title' => ''], ], [ - 'name' => 'ProjectId', + 'name' => 'OsPlatform', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'sfgsghd6', - ], + 'schema' => ['description' => 'The operating system platform.', 'type' => 'string', 'required' => false, 'example' => 'android', 'title' => ''], ], [ - 'name' => 'AppKey', + 'name' => 'ObjectKey', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'com.aliyun.aicc.test', - ], + 'schema' => ['description' => 'The OSS storage key.', 'type' => 'string', 'required' => false, 'example' => '1151125281886341/375KZRO8TARYBQY7P0E4/2019-04-12/1555062240807.jpg', 'title' => ''], ], [ - 'name' => 'Type', + 'name' => 'DeviceName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '1', - ], + 'schema' => ['description' => 'The device name.', 'type' => 'string', 'required' => false, 'example' => 'device', 'title' => ''], ], ], 'responses' => [ @@ -16119,106 +13393,111 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '629586FE-CB2E-4742-995E-121F952CEB72', - ], - 'Mid' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '354677', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '9c7a3b09-a69a-43f5-8bf2-84f7119810eb', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Mid\\": 354677,\\n \\"RequestId\\": \\"629586FE-CB2E-4742-995E-121F952CEB72\\"\\n}","errorExample":"{\\n \\"Code\\":\\"MissingParameter\\",\\n \\"Message\\":\\"The AppPackage is mandatory for this action\\",\\n \\"HostId\\": \\"iovcc.cn-shanghai.aliyuncs.com\\",\\n \\"RequestId\\":\\"629586FE-CB2E-4742-995E-121F952CEB72\\"\\n}"},{"type":"xml","example":"<PushMessageResponse>\\r\\n\\t<Mid>354677</Mid>\\r\\n\\t<RequestId>629586FE-CB2E-4742-995E-121F952CEB72</RequestId>\\r\\n</PushMessageResponse>","errorExample":""}]', - 'title' => 'PushMessage', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9c7a3b09-a69a-43f5-8bf2-84f7119810eb\\"\\n}","type":"json"}]', + 'title' => 'Modify device model information', + 'summary' => 'Calls UpdateDeviceModel to modify device model information.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'FindVersionDeviceGroups' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [ + ['createdAt' => '2024-06-18T02:20:25.000Z', 'description' => 'Error codes changed'], + ], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'iovcc:UpdateDeviceModel', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'UpdateNamespaceData' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - ], + 'operationType' => 'write', + 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ + 'name' => 'ProjectId', + 'in' => 'query', + 'schema' => ['description' => 'The project ID.', 'type' => 'string', 'required' => true, 'example' => 'PIY3UB0T', 'title' => ''], + ], + [ + 'name' => 'Namespace', + 'in' => 'query', + 'schema' => ['description' => 'The unique identifier of the namespace.', 'type' => 'string', 'required' => true, 'example' => 'cc6c29893f2be7d465db44ec7b5d593e', 'title' => ''], + ], + [ + 'name' => 'AuthType', + 'in' => 'query', + 'schema' => ['description' => 'The data space partitioning and authentication method. Valid values:'."\n" + .'- 1: account-based'."\n" + .'- 2: device-based'."\n" + .'- 101: account and device-based.', 'type' => 'string', 'required' => true, 'example' => '101', 'title' => ''], + ], + [ + 'name' => 'DeviceIdType', + 'in' => 'query', + 'schema' => ['description' => 'The device ID type. Valid values: **uuid**, **sn**, **vin**, and **hardware_id**.'."\n" + ."\n" + .'> This parameter is required when AuthType is set to 2 or 101.', 'type' => 'string', 'required' => false, 'example' => 'uuid', 'title' => ''], + ], + [ 'name' => 'DeviceId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'b8fe2e24ff2b48e0a3aa4e49809fc1b3', - ], + 'schema' => ['description' => 'The device ID.', 'type' => 'string', 'required' => false, 'example' => '1ac5e182e9634252a02d442a4d5d16fc', 'title' => ''], ], [ - 'name' => 'OriginalId', + 'name' => 'AccountType', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '23452345234523452', - ], + 'schema' => ['description' => 'The user ID type. This parameter is required when AuthType is set to 1 or 101.'."\n" + ."\n" + .'- `www.weibo.com`: Weibo'."\n" + .'- `www.openaccount.alios.cn`: AliOS'."\n" + .'- `www.amap.com`: AMAP'."\n" + .'- `www.yundevicedemo.aliyun.com`: YUNDEVICE_DEMO'."\n" + .'- `anonymous`: anonymous.', 'type' => 'string', 'required' => false, 'example' => 'www.weibo.com', 'title' => ''], ], [ - 'name' => 'PageIndex', + 'name' => 'AccountId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '1', - ], + 'schema' => ['description' => 'The user ID.', 'type' => 'string', 'required' => false, 'example' => '10000', 'title' => ''], ], [ - 'name' => 'PageSize', + 'name' => 'Path', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '20', - ], + 'schema' => ['description' => 'The path of the node to modify, such as `/CarService/Window/SunroofSlideCtrl`.', 'type' => 'string', 'required' => true, 'example' => '/CarService/Window/SunroofSlideCtrl', 'title' => ''], ], [ - 'name' => 'Name', + 'name' => 'OldData', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '', - ], + 'schema' => ['description' => 'The old data.', 'type' => 'string', 'required' => true, 'example' => '2', 'title' => ''], ], [ - 'name' => 'ProjectId', + 'name' => 'NewData', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'P0VFCREU', - ], + 'schema' => ['description' => 'The new data.', 'type' => 'string', 'required' => true, 'example' => '5', 'title' => ''], ], ], 'responses' => [ @@ -16226,164 +13505,70 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '6F25F67C-F411-499F-BCE2-67CA563CB064', - ], - 'DeviceGroupList' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Items' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'GmtModifyTimestamp' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '16834654000000', - ], - 'GmtCreateTimestamp' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '16834654000000', - ], - 'GmtModify' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2018-01-01 00:01:00', - ], - 'Description' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'GmtCreate' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2018-01-01 00:00:00', - ], - 'Name' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'Id' => [ - 'description' => 'ID', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'MaxCount' => [ - 'description' => '', - 'type' => 'string', - 'example' => '100', - ], - ], - ], - ], - 'TotalCount' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - ], - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'E94C9864-56FB-44AD-AC0C-A1CEFB332254', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"6F25F67C-F411-499F-BCE2-67CA563CB064\\",\\n \\"DeviceGroupList\\": {\\n \\"TotalCount\\": 10,\\n \\"Items\\": [\\n {\\n \\"GmtModifyTimestamp\\": 16834654000000,\\n \\"GmtCreateTimestamp\\": 16834654000000,\\n \\"GmtModify\\": \\"2018-01-01 00:01:00\\",\\n \\"Description\\": \\"测试\\",\\n \\"GmtCreate\\": \\"2018-01-01 00:00:00\\",\\n \\"Name\\": \\"升级分组\\",\\n \\"Id\\": 1,\\n \\"MaxCount\\": \\"100\\"\\n }\\n ]\\n }\\n}","errorExample":"{\\n \\"RequestId\\": \\"6F25F67C-F411-499F-BCE2-67CA563CB064\\",\\n \\"HostId\\": \\"iovcc.cn-shanghai.aliyuncs.com\\",\\n \\"Code\\": \\"NoPermissionToAccessProject\\",\\n \\"Message\\": \\"User is not authorized to access the specified project.\\"\\n}"},{"type":"xml","example":"<FindVersionDeviceGroupsResponse>\\r\\n\\t<RequestId>6F25F67C-F411-499F-BCE2-67CA563CB064</RequestId>\\r\\n\\t<DeviceGroupList>\\r\\n\\t\\t<TotalCount>10</TotalCount>\\r\\n\\t\\t<Items>\\r\\n\\t\\t\\t<Id>1</Id>\\r\\n\\t\\t\\t<Name>升级分组</Name>\\r\\n\\t\\t\\t<Description>测试</Description>\\r\\n\\t\\t\\t<GmtCreate>2018-01-01 00:00:00</GmtCreate>\\r\\n\\t\\t\\t<GmtModify>2018-01-01 00:01:00</GmtModify>\\r\\n\\t\\t</Items>\\r\\n\\t</DeviceGroupList>\\r\\n</FindVersionDeviceGroupsResponse>","errorExample":""}]', - 'title' => 'FindVersionDeviceGroups', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E94C9864-56FB-44AD-AC0C-A1CEFB332254\\"\\n}","type":"json"}]', + 'title' => 'Modify data in a namespace', + 'summary' => 'Calls UpdateNamespaceData to modify data stored in a namespace.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'FindVersionGroupDevices' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [ + ['createdAt' => '2024-06-18T02:20:25.000Z', 'description' => 'Error codes changed'], + ], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'iovcc:UpdateNamespaceData', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'UpdateOsBlackWhiteVersions' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ - 'name' => 'ProjectId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'P0VFCREU', - ], - ], - [ - 'name' => 'OriginalId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '23452345234523452', - ], - ], - [ - 'name' => 'PageIndex', + 'name' => 'WhiteVersions', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '1', - ], + 'schema' => ['description' => 'The whitelist version list, separated by commas.', 'type' => 'string', 'required' => false, 'example' => '2.0.1-R-20180402.1208,3.0.1-R-20180402.1208', 'title' => ''], ], [ - 'name' => 'PageSize', + 'name' => 'ProjectId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '20', - ], + 'schema' => ['description' => 'The project ID.', 'type' => 'string', 'required' => true, 'example' => 'P0VFCREU', 'title' => ''], ], [ - 'name' => 'DeviceGroupId', + 'name' => 'VersionId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '1', - ], + 'schema' => ['description' => 'The version ID.', 'type' => 'string', 'required' => true, 'example' => '12345', 'title' => ''], ], [ - 'name' => 'DeviceId', + 'name' => 'BlackVersions', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'b8fe2e24ff2b48e0a3aa4e49809fc1b3', - ], + 'schema' => ['description' => 'The blacklist version list, separated by commas. Blacklists and whitelists cannot be set at the same time.', 'type' => 'string', 'required' => false, 'example' => '2.0.1-R-20180402.1208,3.0.1-R-20180402.1208', 'title' => ''], ], ], 'responses' => [ @@ -16391,132 +13576,154 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '6F25F67C-F411-499F-BCE2-67CA563CB064', - ], - 'GroupDeviceList' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Items' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'GmtCreateTimestamp' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '18635800000', - ], - 'OriginalId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '23452345234523452', - ], - 'DeviceId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'AS23DG23SA5D43GA34SD23GW456E', - ], - 'IdType' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'device_id', - ], - 'GmtCreate' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2018-02-14 14:20:18', - ], - 'Id' => [ - 'description' => 'ID', - 'type' => 'string', - 'example' => '123', - ], - ], - ], - ], - 'TotalCount' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - ], - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '6F25F67C-F411-499F-BCE2-67CA563CB064', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"6F25F67C-F411-499F-BCE2-67CA563CB064\\",\\n \\"GroupDeviceList\\": {\\n \\"TotalCount\\": 2,\\n \\"Items\\": [\\n {\\n \\"GmtCreateTimestamp\\": 18635800000,\\n \\"OriginalId\\": \\"23452345234523452\\",\\n \\"DeviceId\\": \\"AS23DG23SA5D43GA34SD23GW456E\\",\\n \\"IdType\\": \\"device_id\\",\\n \\"GmtCreate\\": \\"2018-02-14 14:20:18\\",\\n \\"Id\\": \\"123\\"\\n }\\n ]\\n }\\n}","errorExample":"{\\n \\"RequestId\\": \\"6F25F67C-F411-499F-BCE2-67CA563CB064\\",\\n \\"HostId\\": \\"iovcc.cn-shanghai.aliyuncs.com\\",\\n \\"Code\\": \\"NoPermissionToAccessProject\\",\\n \\"Message\\": \\"User is not authorized to access the specified project.\\"\\n}"},{"type":"xml","example":"<FindVersionGroupDevicesResponse>\\r\\n\\t<GroupDeviceList>\\r\\n\\t\\t<Items>\\r\\n\\t\\t\\t<DeviceId>AS23DG23SA5D43GA34SD23GW456E</DeviceId>\\r\\n\\t\\t\\t<GmtCreate>2018-02-14 14:20:18</GmtCreate>\\r\\n\\t\\t\\t<Id>1</Id>\\r\\n\\t\\t\\t<IdType>hardware_id</IdType>\\r\\n\\t\\t\\t<OriginalId>23452345234523452</OriginalId>\\r\\n\\t\\t</Items>\\r\\n\\t\\t<TotalCount>25</TotalCount>\\r\\n\\t</GroupDeviceList>\\r\\n\\t<RequestId>6F25F67C-F411-499F-BCE2-67CA563CB064</RequestId>\\r\\n</FindVersionGroupDevicesResponse>","errorExample":""}]', - 'title' => 'FindVersionGroupDevices', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6F25F67C-F411-499F-BCE2-67CA563CB064\\"\\n}","type":"json"}]', + 'title' => 'Update blacklists and whitelists for an operating system version', + 'summary' => 'Updates the blacklists and whitelists for an operating system version by calling UpdateOsBlackWhiteVersions.', + 'description' => 'For example, if you want to configure a specific operating system version so that only certain earlier versions can be upgraded to it, set a version whitelist. Blacklists and whitelists cannot be set at the same time.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'CreateProjectApp' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [ + ['createdAt' => '2024-06-18T02:20:25.000Z', 'description' => 'Error codes changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'iovcc:UpdateOsBlackWhiteVersions', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'UpdateOsVersion' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', - 'systemTags' => [ - 'operationType' => 'create', - ], + 'operationType' => 'read', + 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ + 'name' => 'IsMilestone', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether the version is a milestone. Valid values: Y and N.', 'type' => 'string', 'required' => true, 'example' => 'Y', 'title' => ''], + ], + [ + 'name' => 'IsForceNightUpgrade', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to force a night upgrade. Valid values: Y and N. This parameter and IsForceUpgrade cannot both be set to Y.', 'type' => 'string', 'required' => true, 'example' => 'N', 'title' => ''], + ], + [ 'name' => 'ProjectId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'P0VFCREU', - ], + 'schema' => ['description' => 'The project ID.', 'type' => 'string', 'required' => true, 'example' => 'P0VFCREU', 'title' => ''], ], [ - 'name' => 'AppName', + 'name' => 'DeviceModelId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'calendar', - ], + 'schema' => ['description' => 'The device model ID.', 'type' => 'string', 'required' => true, 'example' => '12', 'title' => ''], ], [ - 'name' => 'AppPkgName', + 'name' => 'SystemVersion', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'com.demo.calendar', - ], + 'schema' => ['description' => 'The operating system version number.', 'type' => 'string', 'required' => true, 'example' => '2.0.1-R-20180501.1208', 'title' => ''], ], [ - 'name' => 'OsType', + 'name' => 'ReleaseNote', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '1', - ], + 'schema' => ['description' => 'The release notes for the version. This information is displayed to users on the client as upgrade instructions.', 'type' => 'string', 'required' => true, 'example' => '改用UI用户体验，提升系统稳定性', 'title' => ''], + ], + [ + 'name' => 'Remark', + 'in' => 'query', + 'schema' => ['description' => 'The remarks for the version. This information is used only for server-side management and maintenance.', 'type' => 'string', 'required' => false, 'example' => '版本备注信息', 'title' => ''], + ], + [ + 'name' => 'IsForceUpgrade', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to force an upgrade. Valid values: Y and N.', 'type' => 'string', 'required' => true, 'example' => 'N', 'title' => ''], + ], + [ + 'name' => 'BlackVersionList', + 'in' => 'query', + 'schema' => ['description' => 'The blacklist of operating system versions, separated by commas (,).', 'type' => 'string', 'required' => false, 'example' => '2.0.1-R-20180501.1208,2.0.1-R-20180501.1209', 'title' => ''], + ], + [ + 'name' => 'WhiteVersionList', + 'in' => 'query', + 'schema' => ['description' => 'The whitelist of operating system versions, separated by commas (,).', 'type' => 'string', 'required' => false, 'example' => '2.0.1-R-20180501.1208,2.0.1-R-20180501.1209', 'title' => ''], + ], + [ + 'name' => 'MaxClientVersion', + 'in' => 'query', + 'schema' => ['description' => 'The maximum version code of the allowed OTA SDK version.', 'type' => 'string', 'required' => false, 'example' => '100', 'title' => ''], + ], + [ + 'name' => 'MinClientVersion', + 'in' => 'query', + 'schema' => ['description' => 'The minimum version code of the allowed OTA SDK version.', 'type' => 'string', 'required' => false, 'example' => '90', 'title' => ''], + ], + [ + 'name' => 'NightUpgradeDownloadType', + 'in' => 'query', + 'schema' => ['description' => 'The download type for night upgrades. Valid values:'."\n" + .'- 1: download over Wi-Fi only'."\n" + .'- 2: download over any network.', 'type' => 'string', 'required' => true, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'NightUpgradeIsShowTip', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to display a prompt dialog box during a night upgrade. Valid values: Y and N.', 'type' => 'string', 'required' => true, 'example' => 'N', 'title' => ''], + ], + [ + 'name' => 'NightUpgradeIsAllowedCancel', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to display a prompt dialog box during a night upgrade. Valid values: Y and N.', 'type' => 'string', 'required' => true, 'example' => 'N', 'title' => ''], + ], + [ + 'name' => 'RomList', + 'in' => 'query', + 'schema' => ['description' => 'The list of upgrade packages, including full and incremental packages.'."\n" + ."\n" + .'Format: `id|baseVersion|romUrl,id|baseVersion|romUrl`.'."\n" + ."\n" + .'- The first field is the ID of the upgrade package. Set this field to 0 for a new upgrade package.'."\n" + .'- The second field is the base operating system version number. The base version number for a full package is 0.'."\n" + .'- The last field is the download URL of the upgrade package.', 'type' => 'string', 'required' => true, 'example' => '10|0|http://www.oss-server.com/file0.zip,11|123|http://www.oss-server.com/file1.zip,0|124|http://www.oss-server.com/file2.zip', 'title' => ''], + ], + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => ['description' => 'The version ID.', 'type' => 'string', 'required' => true, 'example' => '123456', 'title' => ''], + ], + [ + 'name' => 'EnableMobileDownload', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to allow downloading upgrade packages over a mobile network.', 'type' => 'string', 'required' => true, 'example' => 'Y', 'title' => ''], + ], + [ + 'name' => 'MobileDownloadMaxSize', + 'in' => 'query', + 'schema' => ['description' => 'The maximum size of packages that can be downloaded over a mobile network, in MB. When mobile network download is enabled, packages larger than this limit are not automatically downloaded.', 'type' => 'string', 'required' => false, 'example' => '10', 'title' => ''], ], ], 'responses' => [ @@ -16524,81 +13731,66 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '629586FE-CB2E-4742-995E-121F952CEB72', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '6F25F67C-F411-499F-BCE2-67CA563CB064', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"629586FE-CB2E-4742-995E-121F952CEB72\\"\\n}","errorExample":"{\\n \\"RequestId\\": \\"6F25F67C-F411-499F-BCE2-67CA563CB064\\",\\n \\"HostId\\": \\"iovcc.cn-shanghai.aliyuncs.com\\",\\n \\"Code\\": \\"InvalidTenant\\",\\n \\"Message\\": \\"User is not a valid tenant\\"\\n}"},{"type":"xml","example":"<CreateProjectAppResponse>\\r\\n<RequestId>629586FE-CB2E-4742-995E-121F952CEB72</RequestId>\\r\\n</CreateProjectAppResponse>","errorExample":""}]', - 'title' => 'CreateProjectApp', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6F25F67C-F411-499F-BCE2-67CA563CB064\\"\\n}","type":"json"}]', + 'title' => 'Update basic information of an operating system version', + 'summary' => 'Updates the basic information of an operating system version by calling UpdateOsVersion.', + 'description' => 'After you create an operating system version, you can call this operation to modify its basic information.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'ListProjectApps' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [ + ['createdAt' => '2024-06-18T02:20:25.000Z', 'description' => 'Error codes changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'iovcc:UpdateOsVersion', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'UpdateOsVersionReleaseNote' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ 'name' => 'ProjectId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '11', - ], + 'schema' => ['description' => 'The project ID.', 'type' => 'string', 'required' => true, 'example' => 'P0VFCREU', 'title' => ''], ], [ - 'name' => 'PageIndex', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], - ], - [ - 'name' => 'PageSize', + 'name' => 'VersionId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], + 'schema' => ['description' => 'The version ID.', 'type' => 'string', 'required' => true, 'example' => '10023', 'title' => ''], ], [ - 'name' => 'Keywords', + 'name' => 'ReleaseNote', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'app', - ], + 'schema' => ['description' => 'The release notes of the version.', 'type' => 'string', 'required' => true, 'example' => 'new release note', 'title' => ''], ], ], 'responses' => [ @@ -16606,248 +13798,132 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'A15971B1-DC63-4AEC-A8B1-85CB8CD78227', - ], - 'Result' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'ProjectApps' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Status' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'ProjectId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '11', - ], - 'UserId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '1768723179523459', - ], - 'GmtModified' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1524736376000', - ], - 'AppPkgName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'com.app1', - ], - 'AppName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'app1', - ], - 'AppSecret' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Q******F', - ], - 'AppKey' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'mPp7O4LW', - ], - 'AppId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'AX4R4JWQ', - ], - 'OsType' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'GmtCreate' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1524736376000', - ], - 'Id' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '78', - ], - ], - ], - ], - 'TotalPage' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'TotalCount' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - ], - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '6F25F67C-F411-499F-BCE2-67CA563CB064', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"A15971B1-DC63-4AEC-A8B1-85CB8CD78227\\",\\n \\"Result\\": {\\n \\"TotalCount\\": 1,\\n \\"TotalPage\\": 1,\\n \\"ProjectApps\\": [\\n {\\n \\"Status\\": 0,\\n \\"UserId\\": \\"1768723179523459\\",\\n \\"ProjectId\\": \\"11\\",\\n \\"GmtModified\\": 1524736376000,\\n \\"AppName\\": \\"app1\\",\\n \\"AppPkgName\\": \\"com.app1\\",\\n \\"AppSecret\\": \\"Q******F\\",\\n \\"AppKey\\": \\"mPp7O4LW\\",\\n \\"AppId\\": \\"AX4R4JWQ\\",\\n \\"OsType\\": 1,\\n \\"GmtCreate\\": 1524736376000,\\n \\"Id\\": 78\\n }\\n ]\\n }\\n}","errorExample":"{\\n \\"RequestId\\": \\"6F25F67C-F411-499F-BCE2-67CA563CB064\\",\\n \\"HostId\\": \\"iovcc.cn-shanghai.aliyuncs.com\\",\\n \\"Code\\": \\"NotFoundProject\\",\\n \\"Message\\": \\"Cannot find the specified project\\"\\n}"},{"type":"xml","example":"<ListProjectAppsResponse>\\r\\n\\t<Result>\\r\\n\\t\\t<TotalPage>1</TotalPage>\\r\\n\\t\\t<TotalCount>1</TotalCount>\\r\\n\\t\\t<ProjectApps>\\r\\n\\t\\t\\t<OsType>1</OsType>\\r\\n\\t\\t\\t<Status>0</Status>\\r\\n\\t\\t\\t<AppSecret>Q******F</AppSecret>\\r\\n\\t\\t\\t<AppPkgName>com.app1</AppPkgName>\\r\\n\\t\\t\\t<AppId>AX4R4JWQ</AppId>\\r\\n\\t\\t\\t<AppName>app1</AppName>\\r\\n\\t\\t\\t<Id>78</Id>\\r\\n\\t\\t\\t<UserId>1768723179523459</UserId>\\r\\n\\t\\t\\t<GmtCreate>1524736376000</GmtCreate>\\r\\n\\t\\t\\t<AppKey>mPp7O4LW</AppKey>\\r\\n\\t\\t\\t<GmtModified>1524736376000</GmtModified>\\r\\n\\t\\t\\t<ProjectId>11</ProjectId>\\r\\n\\t\\t</ProjectApps>\\r\\n\\t</Result>\\r\\n\\t<RequestId>18178DD4-70F9-4BA1-956E-5D8ED4D5B27C</RequestId>\\r\\n</ListProjectAppsResponse>","errorExample":""}]', - 'title' => 'ListProjectApps', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6F25F67C-F411-499F-BCE2-67CA563CB064\\"\\n}","type":"json"}]', + 'title' => 'Update operating system version release notes', + 'summary' => 'Updates the release notes of an operating system version by calling UpdateOsVersionReleaseNote.', + 'description' => 'When a version is in canary release or has been published and you want to update its release notes, call this operation to update the version release notes.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'ListProjects' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [ + ['createdAt' => '2024-06-18T02:20:24.000Z', 'description' => 'Error codes changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'iovcc:UpdateOsVersionReleaseNote', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + ], + 'UpdateOsVersionRemark' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', + 'systemTags' => ['operationType' => 'update'], + 'parameters' => [ + [ + 'name' => 'ProjectId', + 'in' => 'query', + 'schema' => ['description' => 'The project ID.', 'type' => 'string', 'required' => true, 'example' => 'P0VFCREU', 'title' => ''], + ], + [ + 'name' => 'VersionId', + 'in' => 'query', + 'schema' => ['description' => 'The version ID.', 'type' => 'string', 'required' => true, 'example' => '12304', 'title' => ''], + ], + [ + 'name' => 'Remark', + 'in' => 'query', + 'schema' => ['description' => 'The remarks.', 'type' => 'string', 'required' => true, 'example' => 'sample remark', 'title' => ''], + ], ], - 'parameters' => [], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '3305DEE5-4020-4FF0-9D42-5882B1580088', - ], - 'Projects' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Status' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'Description' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'test', - ], - 'UserId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '1768723179523459', - ], - 'ProjectId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '11', - ], - 'GmtCreate' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1508341160000', - ], - 'GmtModified' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1525687817000', - ], - 'Name' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'aicc_test11', - ], - 'Id' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '11', - ], - 'Creator' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'user001', - ], - ], - ], - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '6F25F67C-F411-499F-BCE2-67CA563CB064', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"3305DEE5-4020-4FF0-9D42-5882B1580088\\",\\n \\"Projects\\": [\\n {\\n \\"Status\\": 0,\\n \\"Description\\": \\"test\\",\\n \\"UserId\\": \\"1768723179523459\\",\\n \\"ProjectId\\": \\"11\\",\\n \\"GmtCreate\\": 1508341160000,\\n \\"GmtModified\\": 1525687817000,\\n \\"Name\\": \\"aicc_test11\\",\\n \\"Id\\": 11,\\n \\"Creator\\": \\"user001\\"\\n }\\n ]\\n}","errorExample":"{\\n \\"RequestId\\": \\"6F25F67C-F411-499F-BCE2-67CA563CB064\\",\\n \\"HostId\\": \\"iovcc.cn-shanghai.aliyuncs.com\\",\\n \\"Code\\": \\"InvalidTenant\\",\\n \\"Message\\": \\"User is not a valid tenant\\"\\n}"},{"type":"xml","example":"<ListProjectsResponse>\\r\\n\\t<Projects>\\r\\n\\t\\t<Name>aicc_test22</Name>\\r\\n\\t\\t<Status>0</Status>\\r\\n\\t\\t<Description>test3</Description>\\r\\n\\t\\t<Creator>aicc-qa</Creator>\\r\\n\\t\\t<Id>11</Id>\\r\\n\\t\\t<UserId>1768723179523459</UserId>\\r\\n\\t\\t<GmtCreate>1508341160000</GmtCreate>\\r\\n\\t\\t<GmtModified>1525687817000</GmtModified>\\r\\n\\t\\t<ProjectId>11</ProjectId>\\r\\n\\t</Projects>\\r\\n\\t<RequestId>3305DEE5-4020-4FF0-9D42-5882B1580088</RequestId>\\r\\n</ListProjectsResponse>","errorExample":""}]', - 'title' => 'ListProjects', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6F25F67C-F411-499F-BCE2-67CA563CB064\\"\\n}","type":"json"}]', + 'title' => 'Update system version remarks', + 'summary' => 'Updates the remarks of a system version after the version is created.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'DescribeProjectAppSecurity' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [ + ['createdAt' => '2024-06-18T02:20:24.000Z', 'description' => 'Error codes changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'iovcc:UpdateOsVersionRemark', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + ], + 'UpdateOsVersionStatus' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ 'name' => 'ProjectId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '11', - ], + 'schema' => ['description' => 'The project ID.', 'type' => 'string', 'required' => true, 'example' => 'P0VFCREU', 'title' => ''], ], [ - 'name' => 'AppId', + 'name' => 'Id', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'A3BU0HBO', - ], + 'schema' => ['description' => 'The version ID.', 'type' => 'string', 'required' => true, 'example' => '12304', 'title' => ''], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => ['description' => 'The version status.', 'type' => 'string', 'required' => false, 'example' => 'PUBLISHED', 'title' => ''], ], ], 'responses' => [ @@ -16855,162 +13931,137 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'B030DF87-3AC0-4096-A50B-98B16C98B6CC', - ], - 'ProjectAppSecurity' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'AppSecret' => [ - 'description' => '', - 'type' => 'string', - 'example' => '222222', - ], - 'AppKey' => [ - 'description' => '', - 'type' => 'string', - 'example' => '111111', - ], - 'AppId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'A3BU0HBO', - ], - 'GmtCreate' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1508737512000', - ], - 'GmtModified' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1508737512000', - ], - 'Id' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '4', - ], - ], - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '6F25F67C-F411-499F-BCE2-67CA563CB064', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"B030DF87-3AC0-4096-A50B-98B16C98B6CC\\",\\n \\"ProjectAppSecurity\\": {\\n \\"AppSecret\\": \\"222222\\",\\n \\"AppKey\\": \\"111111\\",\\n \\"AppId\\": \\"A3BU0HBO\\",\\n \\"GmtCreate\\": 1508737512000,\\n \\"GmtModified\\": 1508737512000,\\n \\"Id\\": 4\\n }\\n}","errorExample":"{\\n \\"RequestId\\": \\"6F25F67C-F411-499F-BCE2-67CA563CB064\\",\\n \\"HostId\\": \\"iovcc.cn-shanghai.aliyuncs.com\\",\\n \\"Code\\": \\"NotFoundProject\\",\\n \\"Message\\": \\"Cannot find the specified project\\"\\n}"},{"type":"xml","example":"<DescribeProjectAppSecurityResponse>\\r\\n\\t<RequestId>B030DF87-3AC0-4096-A50B-98B16C98B6CC</RequestId>\\r\\n\\t<ProjectAppSecurity>\\r\\n\\t\\t<AppSecret>222222</AppSecret>\\r\\n\\t\\t<AppId>A3BU0HBO</AppId>\\r\\n\\t\\t<Id>4</Id>\\r\\n\\t\\t<GmtCreate>1508737512000</GmtCreate>\\r\\n\\t\\t<AppKey>111111</AppKey>\\r\\n\\t\\t<GmtModified>1524736346000</GmtModified>\\r\\n\\t</ProjectAppSecurity>\\r\\n</DescribeProjectAppSecurityResponse>","errorExample":""}]', - 'title' => 'DescribeProjectAppSecurity', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6F25F67C-F411-499F-BCE2-67CA563CB064\\"\\n}","type":"json"}]', + 'title' => 'Switch operating system version status', + 'summary' => 'Switches the status of an operating system version by calling UpdateOsVersionStatus.', + 'description' => 'For example, the status can be switched to tested, published, delisted, or canceled.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'CreateRpcService' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [ + ['createdAt' => '2024-06-18T02:20:24.000Z', 'description' => 'Error codes changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'iovcc:UpdateOsVersionStatus', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'UpdateProject' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', - 'systemTags' => [ - 'operationType' => 'create', - ], + 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ 'name' => 'ProjectId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'ftewtwyy', - ], + 'schema' => ['description' => 'The project ID.', 'type' => 'string', 'required' => true, 'example' => '11', 'title' => ''], ], [ - 'name' => 'AppKey', + 'name' => 'Name', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'WH2MptXX', - ], + 'schema' => ['description' => 'The project name.', 'type' => 'string', 'required' => true, 'example' => 'test', 'title' => ''], ], [ - 'name' => 'InterfaceName', + 'name' => 'Description', 'in' => 'query', + 'schema' => ['description' => 'The project description.', 'type' => 'string', 'required' => true, 'example' => 'test', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '6F25F67C-F411-499F-BCE2-67CA563CB064', 'title' => ''], + ], 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'http://www.aliyun.com/aicc/testRpc', + 'title' => '', + 'example' => '', ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6F25F67C-F411-499F-BCE2-67CA563CB064\\"\\n}","type":"json"}]', + 'title' => 'Modify basic project information', + 'summary' => 'Calls UpdateProject to modify the basic information of a project.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2024-06-17T02:56:09.000Z', 'description' => 'Error codes changed'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ [ - 'name' => 'InvokeType', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'http', - 'enum' => [ - 'http', - 'hsf', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'iovcc:UpdateProject', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], + ], + ], + 'UpdateSchemaSubscribe' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => ['operationType' => 'update'], + 'parameters' => [ [ - 'name' => 'Params', + 'name' => 'DeviceModel', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'param1,param2', - ], + 'schema' => ['description' => 'The device name.', 'type' => 'string', 'required' => true, 'example' => 'model_2nd', 'title' => ''], ], [ - 'name' => 'GroupName', + 'name' => 'SubscribeList', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'rpcTestGroup', - ], + 'schema' => ['description' => 'The subscription list.', 'type' => 'string', 'required' => false, 'example' => '[{\\"path\\":\\"/car_body_hvac/cooling/water_temperature\\",\\"description\\":\\"水温\\",\\"required\\":false,\\"type\\":\\"number\\",\\"minimum\\":20,\\"exclusiveMinimum\\":false,\\"maximum\\":30,\\"exclusiveMaximum\\":false},{\\"path\\":\\"/car_body_hvac/lubricating/oil_level\\",\\"description\\":\\"机油油位\\",\\"required\\":false,\\"type\\":\\"number\\",\\"minimum\\":3,\\"exclusiveMinimum\\":false,\\"maximum\\":6,\\"exclusiveMaximum\\":false}]', 'title' => ''], ], [ - 'name' => 'MethodName', + 'name' => 'ProjectId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'testMethodName', - ], + 'schema' => ['description' => 'The project ID.', 'type' => 'string', 'required' => true, 'example' => 'PIC3UA0V', 'title' => ''], ], [ - 'name' => 'VersionCode', + 'name' => 'SchemaVersion', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '1.0', - ], + 'schema' => ['description' => 'The version.', 'type' => 'string', 'required' => false, 'example' => '1.0', 'title' => ''], ], ], 'responses' => [ @@ -17018,65 +14069,80 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '629586FE-CB2E-4742-995E-121F952CEB72', - ], - 'Id' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '6F25F67C-F411-499F-BCE2-67CA563CB064', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Id\\": 1,\\n \\"RequestId\\": \\"629586FE-CB2E-4742-995E-121F952CEB72\\"\\n}","errorExample":"{\\n \\"Code\\":\\"MissingParameter\\",\\n \\"Message\\":\\"The InterfaceName is mandatory for this action\\",\\n \\"HostId\\": \\"iovcc.cn-shanghai.aliyuncs.com\\",\\n \\"RequestId\\":\\"629586FE-CB2E-4742-995E-121F952CEB72\\"\\n}"},{"type":"xml","example":"<CreateRpcServiceResponse>\\r\\n\\t<Id>1</Id>\\r\\n\\t<RequestId>629586FE-CB2E-4742-995E-121F952CEB72</RequestId>\\r\\n</CreateRpcServiceResponse>","errorExample":""}]', - 'title' => 'CreateRpcService', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6F25F67C-F411-499F-BCE2-67CA563CB064\\"\\n}","type":"json"}]', + 'title' => 'Modify subscription information', + 'summary' => 'Modifies subscription information by calling UpdateSchemaSubscribe.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'DeleteProjectApp' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [ + ['createdAt' => '2024-06-18T02:20:24.000Z', 'description' => 'Error codes changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'iovcc:UpdateSchemaSubscribe', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + ], + 'UpdateShadowSchema' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', - 'systemTags' => [ - 'operationType' => 'delete', - ], + 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ + 'name' => 'DeviceModelId', + 'in' => 'query', + 'schema' => ['description' => 'The device model ID.', 'type' => 'string', 'required' => true, 'example' => '120', 'title' => ''], + ], + [ + 'name' => 'AuthType', + 'in' => 'query', + 'schema' => ['description' => 'The authentication type.', 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'Namespace', + 'in' => 'query', + 'schema' => ['description' => 'The namespace.', 'type' => 'string', 'required' => false, 'example' => 'b09e93ce436aaf0dcfc2fb2004c1fde8', 'title' => ''], + ], + [ 'name' => 'ProjectId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'PPCVFRG7', - ], + 'schema' => ['description' => 'The project ID.', 'type' => 'string', 'required' => true, 'example' => 'PIC3UA0V', 'title' => ''], ], [ - 'name' => 'AppId', + 'name' => 'Schema', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'AJROOEWE', - ], + 'schema' => ['description' => 'The schema information.', 'type' => 'string', 'required' => false, 'example' => '{"ecu":{"node_desc":"动力系统","brake_controll":{"handbrake":"手刹状态"}},"device_info":{"vin":"车架号","uuid":"uuid","brand":"设备品牌","plugin_version":{"ra":"远程诊断","control":"远程控制","node_desc":"插件版本号","yundevice":"yundevice版本号"},"system_version":"系统版本号"},"car_body_hvac":{"node_desc":"车身与HVAC","cigar_lighter":{"node_desc":"点烟器"},"cleaning_fluid":"清洗液"}}', 'title' => ''], + ], + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the data record to be modified.', 'type' => 'string', 'required' => true, 'example' => '12', 'title' => ''], ], ], 'responses' => [ @@ -17084,59 +14150,76 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '629586FE-CB2E-4742-995E-121F952CEB72', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '629586FE-CB2E-4742-995E-121F952CEB72', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"629586FE-CB2E-4742-995E-121F952CEB72\\"\\n}","errorExample":"{\\n \\"RequestId\\": \\"6F25F67C-F411-499F-BCE2-67CA563CB064\\",\\n \\"HostId\\": \\"iovcc.cn-shanghai.aliyuncs.com\\",\\n \\"Code\\": \\"NotFoundProject\\",\\n \\"Message\\": \\"Cannot find the specified project\\"\\n}"},{"type":"xml","example":"<DeleteProjectAppResponse>\\r\\n<RequestId>629586FE-CB2E-4742-995E-121F952CEB72</RequestId>\\r\\n</DeleteProjectAppResponse>","errorExample":""}]', - 'title' => 'DeleteProjectApp', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"629586FE-CB2E-4742-995E-121F952CEB72\\"\\n}","type":"json"}]', + 'title' => 'Modify schema information of a device model', + 'summary' => 'Modifies the schema information of a specified device model by calling UpdateShadowSchema.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'DeleteRpcService' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [ + ['createdAt' => '2024-06-18T02:20:24.000Z', 'description' => 'Error codes changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'iovcc:UpdateShadowSchema', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + ], + 'UpdateTrigger' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', - 'systemTags' => [ - 'operationType' => 'delete', - ], + 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ + 'name' => 'ProjectId', + 'in' => 'query', + 'schema' => ['description' => 'The project ID.', 'type' => 'string', 'required' => true, 'example' => 'PE9FQC48', 'title' => ''], + ], + [ 'name' => 'Id', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '1', - ], + 'schema' => ['description' => 'The trigger ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1', 'title' => ''], ], [ - 'name' => 'ProjectId', + 'name' => 'Sandbox', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'sghghshr', - ], + 'schema' => ['description' => 'Specifies whether to trigger in the sandbox environment.'."\n" + ."\n" + .'- **0** (default): does not execute in this environment'."\n" + .'- **1**: executes in this environment.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'Production', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to trigger in the production environment.'."\n" + ."\n" + .'- **0** (default): does not execute in this environment'."\n" + .'- **1**: executes in this environment.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], ], 'responses' => [ @@ -17144,58 +14227,70 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '629586FE-CB2E-4742-995E-121F952CEB72', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '629586FE-CB2E-4742-995E-121F952CEB72', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"629586FE-CB2E-4742-995E-121F952CEB72\\"\\n}","errorExample":"{\\n \\"Code\\":\\"MissingParameter\\",\\n \\"Message\\":\\"The id is mandatory for this action\\",\\n \\"HostId\\": \\"iovcc.cn-shanghai.aliyuncs.com\\",\\n \\"RequestId\\":\\"629586FE-CB2E-4742-995E-121F952CEB72\\"\\n}"},{"type":"xml","example":"<DeleteRpcServiceResponse>\\r\\n<RequestId>629586FE-CB2E-4742-995E-121F952CEB72</RequestId>\\r\\n</DeleteRpcServiceResponse>","errorExample":""}]', - 'title' => 'DeleteRpcService', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"629586FE-CB2E-4742-995E-121F952CEB72\\"\\n}","type":"json"}]', + 'title' => 'Modify a trigger', + 'summary' => 'Calls UpdateTrigger to modify a trigger.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'DescribeAssistWSServerAddress' => [ - 'methods' => [ - 'get', + 'changeSet' => [ + ['createdAt' => '2024-06-18T02:20:24.000Z', 'description' => 'Error codes changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'iovcc:UpdateTrigger', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + ], + 'UpdateUpstreamAppServer' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - ], + 'operationType' => 'write', + 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ - 'name' => 'ProjectId', + 'name' => 'Id', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'PZ1HK7JZ', - ], + 'schema' => ['description' => 'The ID of the server application.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1', 'title' => ''], ], [ - 'name' => 'DeviceId', + 'name' => 'Name', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '6fde56979c484b93b99fba257e3cbc12', - ], + 'schema' => ['description' => 'The name of the server application.', 'type' => 'string', 'required' => false, 'example' => 'upstreamTest', 'title' => ''], + ], + [ + 'name' => 'Tags', + 'in' => 'query', + 'schema' => ['description' => 'The business tags for upstream messages. Separate multiple tags with commas (,).', 'type' => 'string', 'required' => false, 'example' => 'tag1,tag2', 'title' => ''], + ], + [ + 'name' => 'ProjectId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the iovcc project.', 'type' => 'string', 'required' => false, 'example' => 'ewtwtt4f', 'title' => ''], ], ], 'responses' => [ @@ -17203,65 +14298,70 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '9c7a3b09-a69a-43f5-8bf2-84f7119810eb', - ], - 'WsServer' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'ws://ra-service-qa.aicc.aliyun.com:7001', - ], - 'OTP' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'ewga5dxHOB8Lm9VH', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '629586FE-CB2E-4742-995E-121F952CEB72', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"OTP\\": \\"ewga5dxHOB8Lm9VH\\",\\n \\"RequestId\\": \\"9c7a3b09-a69a-43f5-8bf2-84f7119810eb\\",\\n \\"WsServer\\": \\"ws://ra-service-qa.aicc.aliyun.com:7001\\"\\n}","errorExample":"{\\n \\"Code\\":\\"NoPermissionToAccessProject\\",\\n \\"HostId\\":\\"iovcc.cn-shanghai.aliyuncs.com\\",\\n \\"Message\\":\\"User is not authorized to access the specified project.\\",\\n \\"RequestId\\":\\"6F25F67C-F411-499F-BCE2-67CA563CB064\\"\\n}"},{"type":"xml","example":"","errorExample":""}]', - ], - 'FindPrepublishesByParentId' => [ - 'methods' => [ - 'post', - 'get', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"629586FE-CB2E-4742-995E-121F952CEB72\\"\\n}","type":"json"}]', + 'title' => 'Update upstream message server application name and tags', + 'summary' => 'Updates the name, tags, and other information of an upstream message server application by calling UpdateUpstreamAppServer.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2024-06-18T02:20:24.000Z', 'description' => 'Error codes changed'], + ], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'iovcc:UpdateUpstreamAppServer', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'UpdateVersionDeviceGroup' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ 'name' => 'ProjectId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'P0VFCREU', - ], + 'schema' => ['description' => 'The ID of the project to which the device group belongs.', 'type' => 'string', 'required' => true, 'example' => 'P0VFCREU', 'title' => ''], ], [ - 'name' => 'ParentId', + 'name' => 'Name', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '1', - ], + 'schema' => ['description' => 'The name of the group.', 'type' => 'string', 'required' => true, 'example' => '测试分组-2', 'title' => ''], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => ['description' => 'The description of the group.', 'type' => 'string', 'required' => false, 'example' => '测试描述', 'title' => ''], + ], + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the test device group.', 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''], ], ], 'responses' => [ @@ -17269,148 +14369,65 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '6F25F67C-F411-499F-BCE2-67CA563CB064', - ], - 'PrepublishList' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Items' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'GmtCreateTimestamp' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '165465000000', - ], - 'DeviceModelId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '12', - ], - 'GmtModify' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2018-01-01 00:01:00', - ], - 'IsActive' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Y', - ], - 'VersionId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '1', - ], - 'BarrierCount' => [ - 'description' => '', - 'type' => 'string', - 'example' => '1000', - ], - 'IsTotalPrepublish' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'N', - ], - 'GmtModifyTimestamp' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '165465000000', - ], - 'ParentId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '1', - ], - 'GmtCreate' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2018-01-01 00:00:00', - ], - 'Name' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'Id' => [ - 'description' => 'ID', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2', - ], - 'VersionType' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'FOTA', - ], - ], - ], - ], - 'TotalCount' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '30', - ], - ], - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '6F25F67C-F411-499F-BCE2-67CA563CB064', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"6F25F67C-F411-499F-BCE2-67CA563CB064\\",\\n \\"PrepublishList\\": {\\n \\"TotalCount\\": 30,\\n \\"Items\\": [\\n {\\n \\"GmtCreateTimestamp\\": 165465000000,\\n \\"DeviceModelId\\": \\"12\\",\\n \\"GmtModify\\": \\"2018-01-01 00:01:00\\",\\n \\"IsActive\\": \\"Y\\",\\n \\"VersionId\\": \\"1\\",\\n \\"BarrierCount\\": \\"1000\\",\\n \\"GmtModifyTimestamp\\": 165465000000,\\n \\"IsTotalPrepublish\\": \\"N\\",\\n \\"ParentId\\": \\"1\\",\\n \\"GmtCreate\\": \\"2018-01-01 00:00:00\\",\\n \\"Name\\": \\"第一次预发布\\",\\n \\"Id\\": 2,\\n \\"VersionType\\": \\"FOTA\\"\\n }\\n ]\\n }\\n}","errorExample":"{\\n \\"RequestId\\": \\"6F25F67C-F411-499F-BCE2-67CA563CB064\\",\\n \\"HostId\\": \\"iovcc.cn-shanghai.aliyuncs.com\\",\\n \\"Code\\": \\"NoPermissionToAccessProject\\",\\n \\"Message\\": \\"User is not authorized to access the specified project.\\"\\n}"},{"type":"xml","example":"<FindPrepublishesByParentIdResponse>\\r\\n\\t<PrepublishList>\\r\\n\\t\\t<BarrierCount>1000</BarrierCount>\\r\\n\\t\\t<DeviceModelId>12</DeviceModelId>\\r\\n\\t\\t<GmtCreate>2018-01-01 00:00:00</GmtCreate>\\r\\n\\t\\t<GmtModify>2018-01-01 00:01:00</GmtModify>\\r\\n\\t\\t<Id>2</Id>\\r\\n\\t\\t<IsActive>Y</IsActive>\\r\\n\\t\\t<IsTotalPrepublish>N</IsTotalPrepublish>\\r\\n\\t\\t<Name>第一次预发布</Name>\\r\\n\\t\\t<ParentId>1</ParentId>\\r\\n\\t\\t<VersionId>1</VersionId>\\r\\n\\t\\t<VersionType>1.0,2.0</VersionType>\\r\\n\\t</PrepublishList>\\r\\n\\t<RequestId>6F25F67C-F411-499F-BCE2-67CA563CB064</RequestId>\\r\\n</FindPrepublishesByParentIdResponse>","errorExample":""}]', - 'title' => 'FindPrepublishesByParentId', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6F25F67C-F411-499F-BCE2-67CA563CB064\\"\\n}","type":"json"}]', + 'title' => 'Update a test device group', + 'summary' => 'Updates a test device group by calling UpdateVersionDeviceGroup.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'GenerateOssUploadMeta' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [ + ['createdAt' => '2024-06-18T02:20:24.000Z', 'description' => 'Error codes changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'iovcc:UpdateVersionDeviceGroup', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'UpdateVersionPrepublishActiveStatus' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ 'name' => 'ProjectId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '11', - ], + 'schema' => ['description' => 'The ID of the project.', 'type' => 'string', 'required' => true, 'example' => 'P0VFCREU', 'title' => ''], ], [ - 'name' => 'Ext', + 'name' => 'PrepublishId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'rsa', - ], + 'schema' => ['description' => 'The ID of the pre-release.', 'type' => 'string', 'required' => true, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'IsActive', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether the pre-release is enabled.', 'type' => 'string', 'required' => true, 'example' => 'Y', 'title' => ''], ], ], 'responses' => [ @@ -17418,1335 +14435,2425 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '7676B259-FFA5-4971-A9D7-7B3F48D1DEEB', - ], - 'OssUploadMeta' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'SecurityToken' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'xxxxxxxxxxxxxxxxx+YHAPgNwi7yfRecMFydL2uPOgBI7LDio0RkbYLmJfIxHM2nGBPdml7kYEOXmJp2aDhbvvwVYIyt/8iES/R6N208wQh0Pk2bu+/9dvalp6wOHF4gkFGhhTVFMuTDRhQlNDU0pWTXVLZzVVMXZGRHciBTQzMjc0KgVhbGljZTCpnJjwySk6BlJzYU1ENUJuCgExGmkKBUFsbG93Eh8KDEFjdGlvbkVxdWFscxIGQWN0aW9uGgcKBW9zczoqEj8KDlJlc291cmNlRXF1YWxzEghSZXNvdXJjZRojCiFhY3M6b3NzOio6NDMyNzQ6c2FtcGxlYm94L2FsaWNlLyo=', - ], - 'ObjectKey' => [ - 'description' => '', - 'type' => 'string', - 'example' => '1768723179523459/11/2018-05-07/cert.rsa', - ], - 'AccessKeySecret' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'xxxxxxxxxxxxxxxxx', - ], - 'AccessKeyId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'STS.xxxxxxxxxxxxxxxxx', - ], - 'Bucket' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'xxxx', - ], - ], - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '6F25F67C-F411-499F-BCE2-67CA563CB064', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"7676B259-FFA5-4971-A9D7-7B3F48D1DEEB\\",\\n \\"OssUploadMeta\\": {\\n \\"AccessKeySecret\\": \\"xxxxxxxxxxxxxxxxx\\",\\n \\"SecurityToken\\": \\"xxxxxxxxxxxxxxxxx+YHAPgNwi7yfRecMFydL2uPOgBI7LDio0RkbYLmJfIxHM2nGBPdml7kYEOXmJp2aDhbvvwVYIyt/8iES/R6N208wQh0Pk2bu+/9dvalp6wOHF4gkFGhhTVFMuTDRhQlNDU0pWTXVLZzVVMXZGRHciBTQzMjc0KgVhbGljZTCpnJjwySk6BlJzYU1ENUJuCgExGmkKBUFsbG93Eh8KDEFjdGlvbkVxdWFscxIGQWN0aW9uGgcKBW9zczoqEj8KDlJlc291cmNlRXF1YWxzEghSZXNvdXJjZRojCiFhY3M6b3NzOio6NDMyNzQ6c2FtcGxlYm94L2FsaWNlLyo=\\",\\n \\"ObjectKey\\": \\"1768723179523459/11/2018-05-07/cert.rsa\\",\\n \\"AccessKeyId\\": \\"STS.xxxxxxxxxxxxxxxxx\\",\\n \\"Bucket\\": \\"xxxx\\"\\n }\\n}","errorExample":"{\\n \\"RequestId\\": \\"6F25F67C-F411-499F-BCE2-67CA563CB064\\",\\n \\"HostId\\": \\"iovcc.cn-shanghai.aliyuncs.com\\",\\n \\"Code\\": \\"NotFoundProject\\",\\n \\"Message\\": \\"Cannot find the specified project\\"\\n}"},{"type":"xml","example":"<RequestId>F3BAE77D-1954-48C5-95F6-D4937B29E2F4</RequestId>\\n<OssUploadMeta>\\n <AccessKeyId>STS.xxxxxxxxxxxxxxxxx</AccessKeyId>\\n <AccessKeySecret>xxxxxxxxxxxxxxxxx</AccessKeySecret>\\n <Bucket>xxx</Bucket>\\n <ObjectKey>1768723179523459/11/2018-05-07/cert.rsa</ObjectKey>\\n <SecurityToken>xxxxxxxxxxxxxxxxx+YHAPgNwi7yfRecMFydL2uPOgBI7LDio0RkbYLmJfIxHM2nGBPdml7kYEOXmJp2aDhbvvwVYIyt/8iES/R6N208wQh0Pk2bu+/9dvalp6wOHF4gkFGhhTVFMuTDRhQlNDU0pWTXVLZzVVMXZGRHciBTQzMjc0KgVhbGljZTCpnJjwySk6BlJzYU1ENUJuCgExGmkKBUFsbG93Eh8KDEFjdGlvbkVxdWFscxIGQWN0aW9uGgcKBW9zczoqEj8KDlJlc291cmNlRXF1YWxzEghSZXNvdXJjZRojCiFhY3M6b3NzOio6NDMyNzQ6c2FtcGxlYm94L2FsaWNlLyo=</SecurityToken>\\n</OssUploadMeta>","errorExample":""}]', - 'title' => 'GenerateOssUploadMeta', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6F25F67C-F411-499F-BCE2-67CA563CB064\\"\\n}","type":"json"}]', + 'title' => 'Update the enabling status of a specified pre-release', + 'summary' => 'Updates the enabling status of a specified pre-release by calling UpdateVersionPrepublishActiveStatus.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'GenerateSysAppDownloadInfo' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [ + ['createdAt' => '2024-06-18T02:20:24.000Z', 'description' => 'Error codes changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], - 'security' => [ + 'ramActions' => [ [ - 'AK' => [], + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'iovcc:UpdateVersionPrepublishActiveStatus', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], ], - 'operationType' => 'read', - 'systemTags' => [ + ], + ], + 'endpoints' => [ + ['regionId' => 'cn-shanghai', 'regionName' => 'China (Shanghai)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'iovcc.cn-shanghai.aliyuncs.com', 'endpoint' => 'iovcc.cn-shanghai.aliyuncs.com', 'vpc' => 'iovcc-vpc.cn-shanghai.aliyuncs.com'], + ], + 'errorCodes' => [ + ['code' => 'AccountLinkNotFound', 'message' => 'The third-party account mapping cannot be found.', 'http_code' => 400, 'description' => ''], + ['code' => 'AccountNotFound', 'message' => 'The cloud user cannot be found.', 'http_code' => 400, 'description' => ''], + ['code' => 'ActivePrepublishExistInCurrentVersion', 'message' => 'An active prepublication already exists under the current version.', 'http_code' => 400, 'description' => ''], + ['code' => 'AliyunIdNull', 'message' => 'The specified AliyunId is empty.', 'http_code' => 400, 'description' => ''], + ['code' => 'ApkSignFailed', 'message' => 'Error signing the APK package.', 'http_code' => 400, 'description' => ''], + ['code' => 'ApkZipalignFailed', 'message' => 'Error zipaligning the APK package.', 'http_code' => 400, 'description' => ''], + ['code' => 'AppKeyRelationAlreadyExist', 'message' => 'The mapping between application and appKey already exists.', 'http_code' => 400, 'description' => ''], + ['code' => 'AppRestartTypeRequired', 'message' => 'The application restart type is required.', 'http_code' => 400, 'description' => ''], + ['code' => 'AssistIdNotExist', 'message' => 'The specified Assist Id is invalid.', 'http_code' => 400, 'description' => ''], + ['code' => 'AuthTypeError', 'message' => 'The specified authentication type is invalid.', 'http_code' => 400, 'description' => ''], + ['code' => 'AuthTypeNotExist', 'message' => 'The specified authentication type does not exist.', 'http_code' => 404, 'description' => ''], + ['code' => 'BaseVersionExistInBlackList', 'message' => 'The base version is in the version blacklist.', 'http_code' => 400, 'description' => ''], + ['code' => 'BaseVersionNotExistInWhiteList', 'message' => 'The base version is not in the version whitelist.', 'http_code' => 400, 'description' => ''], + ['code' => 'BlackVersionMustSmallThanCurrentVersion', 'message' => 'The blacklist version must be smaller than the current version.', 'http_code' => 400, 'description' => ''], + ['code' => 'BlackWhiteAreaCannotBothSet', 'message' => 'You cannot configure the area blacklist and whitelist at the same time.', 'http_code' => 400, 'description' => ''], + ['code' => 'BlackWhiteDeviceCannotBothSet', 'message' => 'You cannot configure the device blacklist and whitelist at the same time.', 'http_code' => 400, 'description' => ''], + ['code' => 'BlackWhiteVersionCannotBothSet', 'message' => 'You cannot configure the version blacklist and whitelist at the same time.', 'http_code' => 400, 'description' => ''], + ['code' => 'CallApiGatewayError', 'message' => 'Error calling the API gateway interface.', 'http_code' => 400, 'description' => ''], + ['code' => 'CallFunctionComputeError', 'message' => 'Error calling the FunctionCompute interface.', 'http_code' => 400, 'description' => ''], + ['code' => 'CallSyncStoreError', 'message' => 'Error calling the SyncStore interface.', 'http_code' => 400, 'description' => ''], + ['code' => 'CanCreateDeviceIdInvalid', 'message' => 'The format of the parameter canCreateDeviceId is invalid.', 'http_code' => 400, 'description' => ''], + ['code' => 'ChangedBrandNotFound', 'message' => 'The new brand configured does not exist.', 'http_code' => 400, 'description' => ''], + ['code' => 'CreateNamespaceError', 'message' => 'An error occurred while creating a namespace.', 'http_code' => 400, 'description' => ''], + ['code' => 'CreateSchemaError', 'message' => 'An error occurred while creating the device schema.', 'http_code' => 400, 'description' => ''], + ['code' => 'CreateSubscribeError', 'message' => 'An error occurred while creating the device data subscription.', 'http_code' => 400, 'description' => ''], + ['code' => 'DeleteDeviceFailed', 'message' => 'Error while deleting the device.', 'http_code' => 400, 'description' => ''], + ['code' => 'DeleteDeviceGroupDenied', 'message' => 'You are not allowed to delete the specified device group.', 'http_code' => 400, 'description' => ''], + ['code' => 'DeleteDeviceShadowSchemaError', 'message' => 'An error occurred while deleting the device schema.', 'http_code' => 400, 'description' => ''], + ['code' => 'DeleteSubscribeError', 'message' => 'An error occurred while deleting the device data subscription.', 'http_code' => 400, 'description' => ''], + ['code' => 'DescribeDefaultShadowSchemaError', 'message' => 'An error occurred while obtaining the default device schema.', 'http_code' => 400, 'description' => ''], + ['code' => 'DescribeDeviceShadowError', 'message' => 'An error occurred while obtaining the device shadow.', 'http_code' => 400, 'description' => ''], + ['code' => 'DescribeSchemaError', 'message' => 'An error occurred while obtaining the device schema.', 'http_code' => 400, 'description' => ''], + ['code' => 'DescriptionTooLong', 'message' => 'The maximum length of the description is exceeded.', 'http_code' => 400, 'description' => ''], + ['code' => 'DeviceBrandNotFound', 'message' => 'The device brand information does not exist.', 'http_code' => 400, 'description' => ''], + ['code' => 'DeviceConnectFailed', 'message' => 'An error occurred while establishing assist connection.', 'http_code' => 500, 'description' => ''], + ['code' => 'DeviceConnectionTimeout', 'message' => 'Assist connection creation is timed out.', 'http_code' => 500, 'description' => ''], + ['code' => 'DeviceCountExceedLimit', 'message' => 'The maximum number of devices is exceeded.', 'http_code' => 403, 'description' => 'The maximum number of devices is exceeded.'], + ['code' => 'DeviceDebugTimeout', 'message' => 'The device diagnosis has timed out.', 'http_code' => 400, 'description' => ''], + ['code' => 'DeviceGroupIsFull', 'message' => 'The number of devices in the test device group has reached the limit.', 'http_code' => 400, 'description' => ''], + ['code' => 'DeviceGroupSingleAddDeviceCountExceedMaxRemainingCount', 'message' => 'The maximum number of devices in the device group is exceeded.', 'http_code' => 400, 'description' => ''], + ['code' => 'DeviceIdUnresolved', 'message' => 'An error occurred while resolving the specified device ID.', 'http_code' => 400, 'description' => ''], + ['code' => 'DeviceModelAdapterRequired', 'message' => 'The device model adapter is required.', 'http_code' => 400, 'description' => ''], + ['code' => 'DeviceModelAlreadyExist', 'message' => 'The deviceModel already exists.', 'http_code' => 400, 'description' => ''], + ['code' => 'DeviceModelBrandNull', 'message' => 'The DeviceModel brand is empty.', 'http_code' => 400, 'description' => ''], + ['code' => 'DeviceModelCountExceedLimit', 'message' => 'The number of device models in a single project exceeds the limit.', 'http_code' => 400, 'description' => ''], + ['code' => 'DeviceModelIdNull', 'message' => 'The DeviceModelId is empty.', 'http_code' => 400, 'description' => ''], + ['code' => 'DeviceModelNotFound', 'message' => 'The DeviceModel does not exist.', 'http_code' => 400, 'description' => ''], + ['code' => 'DeviceNeverConnectCMNS', 'message' => 'The device has never been connected to the CMNS server.', 'http_code' => 400, 'description' => ''], + ['code' => 'DeviceNotFound', 'message' => 'The device record does not exist.', 'http_code' => 400, 'description' => ''], + ['code' => 'DeviceNotOnline', 'message' => 'The device is offline. You cannot establish assist connections.', 'http_code' => 400, 'description' => ''], + ['code' => 'DeviceShadowNotExist', 'message' => 'The device shadow does not exist.', 'http_code' => 404, 'description' => ''], + ['code' => 'DeviceTypeInvalid', 'message' => 'The parameter deviceType is invalid.', 'http_code' => 400, 'description' => ''], + ['code' => 'DeviceTypeNull', 'message' => 'You must specify the device type.', 'http_code' => 400, 'description' => ''], + ['code' => 'DeviceValiditySchemaError', 'message' => 'An error occurred while obtaining the subscription rule.', 'http_code' => 400, 'description' => ''], + ['code' => 'DisAuthServiceError', 'message' => 'An error occurred while authenticating.', 'http_code' => 400, 'description' => ''], + ['code' => 'DuplicateAppName', 'message' => 'The application name already exists.', 'http_code' => 400, 'description' => 'The application name already exists.'], + ['code' => 'DuplicateAppPkgName', 'message' => 'The application package name already exists.', 'http_code' => 400, 'description' => 'The application package name already exists.'], + ['code' => 'DuplicateAppVersionDeviceAdapter', 'message' => 'The device model of the app version already exists.', 'http_code' => 400, 'description' => ''], + ['code' => 'DuplicateCustomizedFilterName', 'message' => 'The customized filter name already exists.', 'http_code' => 400, 'description' => ''], + ['code' => 'DuplicateDeviceGroupName', 'message' => 'The specified device group name already exists.', 'http_code' => 400, 'description' => ''], + ['code' => 'DuplicateDeviceModelGroupName', 'message' => 'The device model group name already exists.', 'http_code' => 400, 'description' => ''], + ['code' => 'DuplicateDeviceModelInGroup', 'message' => 'The device model name already exists in the current group.', 'http_code' => 400, 'description' => ''], + ['code' => 'DuplicateMultiLangName', 'message' => 'The multilingual name already exists.', 'http_code' => 400, 'description' => ''], + ['code' => 'DuplicateNamespace', 'message' => 'The specified namespace already exists.', 'http_code' => 400, 'description' => ''], + ['code' => 'DuplicatePrepublishName', 'message' => 'The pre-publication name already exists.', 'http_code' => 400, 'description' => ''], + ['code' => 'DuplicateProjectName', 'message' => 'The project name already exists.', 'http_code' => 400, 'description' => 'The project name already exists.'], + ['code' => 'ExceedLimitFunction', 'message' => 'The specified number of functions exceeds the limit.', 'http_code' => 400, 'description' => ''], + ['code' => 'FunctionCountLimitError', 'message' => 'The maximum number of functions is exceeded.', 'http_code' => 400, 'description' => ''], + ['code' => 'FunctionFileContentParseError', 'message' => 'An error occurred while parsing the function file.', 'http_code' => 400, 'description' => ''], + ['code' => 'FunctionFileDeployError', 'message' => 'An error occurred while deploying the function file.', 'http_code' => 400, 'description' => ''], + ['code' => 'FunctionFileNotExist', 'message' => 'The function file does not exist.', 'http_code' => 404, 'description' => ''], + ['code' => 'FunctionFileStatusError', 'message' => 'A function file status error has occurred.', 'http_code' => 500, 'description' => ''], + ['code' => 'FunctionFileVerifyError', 'message' => 'An error occurred while verifying the function file.', 'http_code' => 400, 'description' => ''], + ['code' => 'FunctionInvokeError', 'message' => 'An error occurred while invoking the function.', 'http_code' => 400, 'description' => ''], + ['code' => 'FunctionProductionEnvNotBeenDeployed', 'message' => 'The function has not been deployed in the production environment.', 'http_code' => 400, 'description' => ''], + ['code' => 'FunctionRuntimeServiceCreateError', 'message' => 'An error occurred while creating the function runtime service.', 'http_code' => 400, 'description' => ''], + ['code' => 'FunctionRuntimeServiceUpdateError', 'message' => 'An error occurred while updating the function runtime service.', 'http_code' => 400, 'description' => ''], + ['code' => 'FunctionSandboxEnvNotBeenDeployed', 'message' => 'The function has not been deployed in the sandbox environment.', 'http_code' => 400, 'description' => ''], + ['code' => 'GenerateSecurityPictureFailed', 'message' => 'Error generating security picture.', 'http_code' => 400, 'description' => ''], + ['code' => 'GenerateStsTokenError', 'message' => 'Error calling the STS interface to generate a token.', 'http_code' => 400, 'description' => ''], + ['code' => 'GroupMessageExceedDayLimit', 'message' => 'The number of group messages sent under a single app exceeds the limit of single day.', 'http_code' => 400, 'description' => ''], + ['code' => 'HardwareTypeNull', 'message' => 'The device hardware type is empty.', 'http_code' => 400, 'description' => ''], + ['code' => 'HasAlreadyRegistered', 'message' => 'The data has already been registered.', 'http_code' => 400, 'description' => ''], + ['code' => 'IasAuthServiceError', 'message' => 'An error occurred while authenticating.', 'http_code' => 400, 'description' => ''], + ['code' => 'IdentityIdNotFound', 'message' => 'The cloud user ID cannot be found.', 'http_code' => 400, 'description' => ''], + ['code' => 'IdentityIdNull', 'message' => 'The cloud user ID is empty.', 'http_code' => 400, 'description' => ''], + ['code' => 'IdpInvalid', 'message' => 'The third-party account platform labeling is invalid.', 'http_code' => 400, 'description' => ''], + ['code' => 'IdTokenInvalid', 'message' => 'The specified IdToken is invalid.', 'http_code' => 403, 'description' => ''], + ['code' => 'InsertDbFailed', 'message' => 'Error saving the new record.', 'http_code' => 400, 'description' => ''], + ['code' => 'Invalid%s', 'message' => 'The specified parameter %s is invalid.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidAliosUri', 'message' => 'The specified message URI is invalid.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidAppPackage', 'message' => 'The name of the application package in which the message is located is invalid.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidCustomContent', 'message' => 'The specified custom content of the message is invalid.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidDelayTaskTime', 'message' => 'The specified time for the scheduled task is invalid.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidDeviceToken', 'message' => 'The deviceToken is invalid or has expired.', 'http_code' => 403, 'description' => ''], + ['code' => 'InvalidDeviceVerifyToken', 'message' => 'The deviceVerifyToken is invalid.', 'http_code' => 403, 'description' => ''], + ['code' => 'InvalidMailAddress', 'message' => 'The specified email address is invalid.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidMessageAction', 'message' => 'The specified message action is invalid.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidMessageExpiration', 'message' => 'The specified expiration of the message is invalid.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidMessageType', 'message' => 'The specified message type is invalid.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidMsgBody', 'message' => 'The specified message body is invalid.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidNode', 'message' => 'The specified node value is invalid.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidPackage', 'message' => 'The specified package name in the message parameter is invalid.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidPackageContent', 'message' => 'The specified package content of the message is invalid.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidReceiverType', 'message' => 'The specified type of message recipient is invalid.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidSignature', 'message' => 'The signature parameter is invalid.', 'http_code' => 403, 'description' => ''], + ['code' => 'InvalidTenant', 'message' => 'You have not activated the IoVCC platform. Please go to the product page and activate it first.', 'http_code' => 403, 'description' => ''], + ['code' => 'InvalidVersionScale', 'message' => 'The format of the adaptor model version range is invalid.', 'http_code' => 400, 'description' => ''], + ['code' => 'ListDeviceModelError', 'message' => 'An error occurred while obtaining the device model.', 'http_code' => 400, 'description' => ''], + ['code' => 'MessageBodyExceedDayLimit', 'message' => 'The length of message body exceeds the limit.', 'http_code' => 400, 'description' => ''], + ['code' => 'MessageDescTooLong', 'message' => 'The maximum length of the description is exceeded.', 'http_code' => 400, 'description' => ''], + ['code' => 'MessageDeviceCountExceedLimit', 'message' => 'The number of devices pushed by a single message exceeds the limit.', 'http_code' => 400, 'description' => ''], + ['code' => 'MessageDeviceModelCountExceedLimit', 'message' => 'The number of device models pushed by a single message exceeds the limit.', 'http_code' => 400, 'description' => ''], + ['code' => 'MessageKpCountExceedLimit', 'message' => 'The number of accounts pushed by a single message exceeds the limit.', 'http_code' => 400, 'description' => ''], + ['code' => 'MessageNotExist', 'message' => 'The message does not exist.', 'http_code' => 404, 'description' => ''], + ['code' => 'MessageTitleTooLong', 'message' => 'The maximum length of the title is exceeded.', 'http_code' => 400, 'description' => ''], + ['code' => 'MethodAlreadyExist', 'message' => 'The method name of RPC service already exists.', 'http_code' => 400, 'description' => ''], + ['code' => 'Missing%s', 'message' => 'The %s parameter is required.', 'http_code' => 400, 'description' => ''], + ['code' => 'MissingCallerUid', 'message' => 'The specified CallerUid is empty.', 'http_code' => 400, 'description' => ''], + ['code' => 'MissingCustomContent', 'message' => 'You must specify the custom content of the message.', 'http_code' => 400, 'description' => ''], + ['code' => 'MissingHardwareId', 'message' => 'You must specify the hardware ID.', 'http_code' => 400, 'description' => 'You must specify the hardware ID.'], + ['code' => 'MissingMessageDesc', 'message' => 'You must specify the message description.', 'http_code' => 400, 'description' => ''], + ['code' => 'MissingMessageReceiver', 'message' => 'You must specify the message recipient.', 'http_code' => 400, 'description' => ''], + ['code' => 'MissingMessageTitle', 'message' => 'You must specify the message title.', 'http_code' => 400, 'description' => ''], + ['code' => 'MissingPackageContent', 'message' => 'You must specify the package content of the message.', 'http_code' => 400, 'description' => ''], + ['code' => 'MissingProjectId', 'message' => 'The specified ProjectId is empty.', 'http_code' => 400, 'description' => ''], + ['code' => 'MissingReceiverData', 'message' => 'You must specify the list of message recipients.', 'http_code' => 400, 'description' => ''], + ['code' => 'NameTooLong', 'message' => 'The maximum length of the name is exceeded.', 'http_code' => 400, 'description' => ''], + ['code' => 'NodeCannotUpdate', 'message' => 'You cannot modify the node value.', 'http_code' => 400, 'description' => ''], + ['code' => 'NoFunctionDefined', 'message' => 'No function is defined in the function file.', 'http_code' => 400, 'description' => ''], + ['code' => 'NoPermission', 'message' => 'You are not authorized to operate on the specified resource.', 'http_code' => 403, 'description' => ''], + ['code' => 'NoPermissionToAccessProject', 'message' => 'You are not authorized to access the current project.', 'http_code' => 403, 'description' => ''], + ['code' => 'NotFoundCustomizedFilter', 'message' => 'The customized filter of the version does not exist.', 'http_code' => 400, 'description' => 'The customized filter of the version does not exist.'], + ['code' => 'NotFoundCustomizedProperty', 'message' => 'The customized property of the version does not exist.', 'http_code' => 400, 'description' => 'The customized property of the version does not exist.'], + ['code' => 'NotFoundDevice', 'message' => 'The specified device is not found in the current project.', 'http_code' => 404, 'description' => ''], + ['code' => 'NotFoundDeviceGroup', 'message' => 'The test device group does not exist.', 'http_code' => 404, 'description' => ''], + ['code' => 'NotFoundDeviceModel', 'message' => 'The specified device model is not found in the current project.', 'http_code' => 404, 'description' => ''], + ['code' => 'NotFoundDeviceModelGroup', 'message' => 'The device model group does not exist.', 'http_code' => 404, 'description' => ''], + ['code' => 'NotFoundLargeDeviceGroup', 'message' => 'The large device group does not exist.', 'http_code' => 404, 'description' => ''], + ['code' => 'NotFoundPackage', 'message' => 'The upgrade package does not exist.', 'http_code' => 404, 'description' => ''], + ['code' => 'NotFoundPrepublish', 'message' => 'The prepublish does not exist.', 'http_code' => 404, 'description' => ''], + ['code' => 'NotFoundProject', 'message' => 'The specified project does not exist.', 'http_code' => 404, 'description' => ''], + ['code' => 'NotFoundProjectAccessKey', 'message' => 'The AccessKey under the current project cannot be found.', 'http_code' => 404, 'description' => ''], + ['code' => 'NotFoundProjectApp', 'message' => 'The specified app is not found in the current project.', 'http_code' => 404, 'description' => ''], + ['code' => 'NotFoundTest', 'message' => 'The test does not exist.', 'http_code' => 404, 'description' => ''], + ['code' => 'NotFoundVersion', 'message' => 'The version does not exist.', 'http_code' => 404, 'description' => ''], + ['code' => 'OnlyCanCancelBeforeRun', 'message' => 'Scheduled tasks can only be canceled before they are executed.', 'http_code' => 400, 'description' => ''], + ['code' => 'OpenIdNotFound', 'message' => 'The third-party user account ID cannot be mapped to the cloud user ID.', 'http_code' => 400, 'description' => ''], + ['code' => 'OuterHardwareIdInvalid', 'message' => 'The specified format of DeviceHardwareId is invalid.', 'http_code' => 400, 'description' => ''], + ['code' => 'PrepublishExistBeforePublish', 'message' => 'Active prepublication versions are not allowed before the version is published.', 'http_code' => 400, 'description' => ''], + ['code' => 'PrepublishMaxDeviceCountExceedConfigCount', 'message' => 'The number of authorized devices in prepublication exceeds the limit.', 'http_code' => 400, 'description' => ''], + ['code' => 'PrepublishNotAllowedToActive', 'message' => 'Only versions with a prepublish status can activate prepublishing.', 'http_code' => 400, 'description' => ''], + ['code' => 'ProductionUndeployed', 'message' => 'The function is not deployed in the production environment.', 'http_code' => 400, 'description' => ''], + ['code' => 'ProjectCountExceedLimit', 'message' => 'The number of projects has exceeded the limit.', 'http_code' => 403, 'description' => 'The number of projects has exceeded the limit.'], + ['code' => 'RemoveAccountFailed', 'message' => 'Error deleting the account.', 'http_code' => 400, 'description' => ''], + ['code' => 'RemoveAccountLinkFailed', 'message' => 'Error deleting account link.', 'http_code' => 400, 'description' => ''], + ['code' => 'RestartTypeRequired', 'message' => 'The restart type is required.', 'http_code' => 400, 'description' => ''], + ['code' => 'RomRequired', 'message' => 'The upgrade package cannot be empty.', 'http_code' => 400, 'description' => ''], + ['code' => 'RomSizeExceedMaxAllowSize', 'message' => 'The maximum size of the upgrade package exceeds the limit.', 'http_code' => 400, 'description' => ''], + ['code' => 'SandboxUndeployed', 'message' => 'The function is not deployed in the sandbox environment.', 'http_code' => 400, 'description' => ''], + ['code' => 'SchemaHasExist', 'message' => 'The device schema already exists.', 'http_code' => 400, 'description' => ''], + ['code' => 'SchemaNotExist', 'message' => 'The device schema does not exist.', 'http_code' => 404, 'description' => ''], + ['code' => 'SendMailError', 'message' => 'An error occurred while sending the email.', 'http_code' => 400, 'description' => ''], + ['code' => 'SourcePackageNotExist', 'message' => 'The upgrade package with the corresponding URL does not exist.', 'http_code' => 400, 'description' => ''], + ['code' => 'UnknownError', 'message' => 'An unknown error occurred.', 'http_code' => 400, 'description' => ''], + ['code' => 'UpdateNamespaceDataError', 'message' => 'An error occurred while modifying the namespace data.', 'http_code' => 400, 'description' => ''], + ['code' => 'UpdateSubscribeError', 'message' => 'An error occurred while modifying the device data subscription.', 'http_code' => 400, 'description' => ''], + ['code' => 'UsageTypeInvalid', 'message' => 'The format of the parameter usageType is invalid.', 'http_code' => 400, 'description' => ''], + ['code' => 'UserIdUnresolved', 'message' => 'An error occurred while resolving the specified user ID.', 'http_code' => 400, 'description' => ''], + ['code' => 'VersionBatchAddBlackDeviceCountExceed', 'message' => 'The maximum number of blacklisted devices that you have added for this version is exceeded.', 'http_code' => 400, 'description' => ''], + ['code' => 'VersionBatchAddWhiteDeviceCountExceed', 'message' => 'The maximum number of whitelisted devices that you have added for this version is exceeded.', 'http_code' => 400, 'description' => ''], + ['code' => 'VersionNotAllowedToEdit', 'message' => 'The current status version cannot be modified.', 'http_code' => 400, 'description' => ''], + ['code' => 'VersionStatusChangeNotAllowed', 'message' => 'Switching the version status is not allowed.', 'http_code' => 400, 'description' => ''], + ['code' => 'VersionStatusNotAllowedToCreatePrepublish', 'message' => 'The current version status does not allow you to create the prepublish record', 'http_code' => 400, 'description' => ''], + ['code' => 'WhiteVersionMustSmallThanCurrentVersion', 'message' => 'The whitelist version must be smaller than the current version.', 'http_code' => 400, 'description' => ''], + ['code' => 'YunFunctionPackageFileUploadError', 'message' => 'An error occurred while uploading the function package file.', 'http_code' => 400, 'description' => ''], + ['code' => 'YunFunctionTriggerExist', 'message' => 'The specified trigger already exists.', 'http_code' => 400, 'description' => ''], + ['code' => 'YunFunctionTriggerOfSyncStoreCreateError', 'message' => 'An error occurred while creating the SyncStore trigger.', 'http_code' => 400, 'description' => ''], + ], + 'changeSet' => [ + [ + 'apis' => [ + ['description' => 'Error codes changed', 'api' => 'AddUploadedFunctionFileInfo'], + ['description' => 'Error codes changed', 'api' => 'AddVersionBlackDevices'], + ['description' => 'Error codes changed', 'api' => 'AddVersionGroupDevices'], + ['description' => 'Error codes changed', 'api' => 'AddVersionWhiteDevices'], + ['description' => 'Error codes changed', 'api' => 'AddVersionWhiteDevicesByDeviceGroups'], + ['description' => 'Error codes changed', 'api' => 'ConnectAssistDevice'], + ['description' => 'Error codes changed', 'api' => 'CountDeviceBrands'], + ['description' => 'Error codes changed', 'api' => 'CountDeviceModels'], + ['description' => 'Error codes changed', 'api' => 'CountDevices'], + ], + 'createdAt' => '2024-06-18T02:21:07.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Error codes changed', 'api' => 'UpdateProject'], + ], + 'createdAt' => '2024-06-17T02:56:29.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Error codes changed', 'api' => 'ListSupportFeatures'], + ], + 'createdAt' => '2024-06-14T11:21:03.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Error codes changed', 'api' => 'ListProjects'], + ], + 'createdAt' => '2024-06-13T11:40:45.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Error codes changed', 'api' => 'CreateProjectApp'], + ], + 'createdAt' => '2023-08-21T07:11:42.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Error codes changed', 'api' => 'DescribeMessage'], + ], + 'createdAt' => '2023-01-06T13:52:29.000Z', + 'description' => 'QPS调整', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'ExecuteVehicleControl'], + ['description' => 'Request parameters changed', 'api' => 'GetVehicleControlResult'], + ], + 'createdAt' => '2021-06-30T05:57:23.000Z', + 'description' => '虚拟车接口发布', + ], + [ + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'CountActivatedOrNewRegistrationDevice'], + ['description' => 'OpenAPI offline', 'api' => 'GetNamespaceStatisticsData'], + ], + 'createdAt' => '2021-05-26T12:51:04.000Z', + 'description' => '线上老接口返回字段按pop规范调整', + ], + [ + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'DescribeProject'], + ['description' => 'OpenAPI offline', 'api' => 'ListCommercialVehicleDevices'], + ], + 'createdAt' => '2021-05-26T12:29:17.000Z', + 'description' => '支持车联网国标jt808协议', + ], + [ + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'ListVehicle'], + ], + 'createdAt' => '2021-04-25T08:57:22.000Z', + 'description' => '虚拟车pop api初始化发布', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '-1', 'countWindow' => 1, 'regionId' => '*'], + ], + ], + 'ram' => [ + 'productCode' => 'IoVCommandCenter', + 'productName' => 'Autodrive Cloud Develop Platform', + 'ramCodes' => ['iovcc'], + 'ramLevel' => 'OPERATION', + 'ramActions' => [ + [ + 'apiName' => 'GenerateOssUploadMeta', + 'description' => '', 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'iovcc:GenerateOssUploadMeta', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'parameters' => [ - [ - 'name' => 'Plugins', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '[{"PkgName":"com.aliyun.aicc.yundevice","VersionCode":20180228},{"PkgName":"com.aliyun.aicc.remoteassistant","VersionCode":""}]', + [ + 'apiName' => 'DescribeMessage', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'iovcc:DescribeMessage', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'SignMode', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'customized', + ], + [ + 'apiName' => 'UpdateOsVersionStatus', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'iovcc:UpdateOsVersionStatus', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'OsType', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '1', + ], + [ + 'apiName' => 'CountYunIdInfo', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'iovcc:CountYunIdInfo', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'PkgName', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'com.aliyun.aicc', + ], + [ + 'apiName' => 'UpdateAppVersionRemark', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'iovcc:UpdateAppVersionRemark', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'ProjectId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '11', + ], + [ + 'apiName' => 'FindVersionBlackDevices', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'iovcc:FindVersionBlackDevices', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'CertFileObjectKey', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '1768723179523459/11/2018-05-07/1525699039841.rsa', + ], + [ + 'apiName' => 'DescribeAppVersion', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'iovcc:DescribeAppVersion', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'F3BAE77D-1954-48C5-95F6-D4937B29E2F4', - ], - 'SysAppDownloadInfo' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Url' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'http://iovcc-pm-tenant.oss-cn-shanghai.aliyuncs.com/1768723179523459/11/2018-05-07/1525699039841-com.aliyun.aicc-20180507.apk?OSSAccessKeyId=nz2pc56s936**9l&Expires=1141889120&Signature=vjbyPxybdZaNmGa%2ByT272YEAiv4%3D', - ], - ], - ], - ], + [ + 'apiName' => 'DeleteVersionWhiteDevicesById', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'iovcc:DeleteVersionWhiteDevicesById', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"F3BAE77D-1954-48C5-95F6-D4937B29E2F4\\",\\n \\"SysAppDownloadInfo\\": {\\n \\"Url\\": \\"http://iovcc-pm-tenant.oss-cn-shanghai.aliyuncs.com/1768723179523459/11/2018-05-07/1525699039841-com.aliyun.aicc-20180507.apk?OSSAccessKeyId=nz2pc56s936**9l&Expires=1141889120&Signature=vjbyPxybdZaNmGa%2ByT272YEAiv4%3D\\"\\n }\\n}","errorExample":"{\\n \\"RequestId\\": \\"6F25F67C-F411-499F-BCE2-67CA563CB064\\",\\n \\"HostId\\": \\"iovcc.cn-shanghai.aliyuncs.com\\",\\n \\"Code\\": \\"NotFoundProject\\",\\n \\"Message\\": \\"Cannot find the specified project\\"\\n}"},{"type":"xml","example":"<GenerateSysAppDownloadInfoResponse>\\r\\n\\t<RequestId>F3BAE77D-1954-48C5-95F6-D4937B29E2F4</RequestId>\\r\\n\\t<SysAppDownloadInfo>\\r\\n\\t\\t<Url>http://iovcc-pm-tenant.oss-cn-shanghai.aliyuncs.com/1768723179523459/11/2018-05-07/1525699039841-com.aliyun.aicc-20180507.apk?OSSAccessKeyId=nz2pc56s936**9l&Expires=1141889120&Signature=vjbyPxybdZaNmGa%2ByT272YEAiv4%3D</Url>\\r\\n\\t</SysAppDownloadInfo>\\r\\n</GenerateSysAppDownloadInfoResponse>","errorExample":""}]', - 'title' => 'GenerateSysAppDownloadInfo', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'GetOssUploadMeta' => [ - 'methods' => [ - 'post', - 'get', + [ + 'apiName' => 'ListOpenAccountLinks', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'iovcc:ListOpenAccountLinks', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'schemes' => [ - 'https', + [ + 'apiName' => 'AddVersionGroupDevices', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'iovcc:AddVersionGroupDevices', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'ListVersionDeviceGroups', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'iovcc:ListVersionDeviceGroups', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'operationType' => 'read', - 'systemTags' => [ + [ + 'apiName' => 'DeleteAllCustomizedFilters', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'iovcc:DeleteAllCustomizedFilters', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'UpdateSchemaSubscribe', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'iovcc:UpdateSchemaSubscribe', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GenerateSysAppDownloadInfo', + 'description' => '', 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'iovcc:GenerateSysAppDownloadInfo', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'parameters' => [ - [ - 'name' => 'ProjectId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'P0VFCREU', + [ + 'apiName' => 'FindVersionDeviceGroups', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'iovcc:FindVersionDeviceGroups', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'Ext', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'zip', + ], + [ + 'apiName' => 'ListMessageAcks', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'iovcc:ListMessageAcks', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '6F25F67C-F411-499F-BCE2-67CA563CB064', - ], - 'OssUploadMeta' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'AccessKey' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'STS.xxxxxxxxxxx', - ], - 'Signature' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'xxxxxxxxxxxx=', - ], - 'Host' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'http://xxxxxx.oss-cn-shanghai.aliyuncs.com', - ], - 'Policy' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'xxxxxxxxxxxxxx', - ], - 'SecurityToken' => [ - 'description' => 'STS token', - 'type' => 'string', - 'example' => 'xxxxxxxxxxxxxx', - ], - 'ObjectKey' => [ - 'description' => '', - 'type' => 'string', - 'example' => '11/1527911483513.zip', - ], - ], - ], - ], + [ + 'apiName' => 'FindPrepublishesByVersionId', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'iovcc:FindPrepublishesByVersionId', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"6F25F67C-F411-499F-BCE2-67CA563CB064\\",\\n \\"OssUploadMeta\\": {\\n \\"AccessKey\\": \\"STS.xxxxxxxxxxx\\",\\n \\"Signature\\": \\"xxxxxxxxxxxx=\\",\\n \\"Host\\": \\"http://xxxxxx.oss-cn-shanghai.aliyuncs.com\\",\\n \\"Policy\\": \\"xxxxxxxxxxxxxx\\",\\n \\"SecurityToken\\": \\"xxxxxxxxxxxxxx\\",\\n \\"ObjectKey\\": \\"11/1527911483513.zip\\"\\n }\\n}","errorExample":"{\\n \\"RequestId\\": \\"6F25F67C-F411-499F-BCE2-67CA563CB064\\",\\n \\"HostId\\": \\"iovcc.cn-shanghai.aliyuncs.com\\",\\n \\"Code\\": \\"NoPermissionToAccessProject\\",\\n \\"Message\\": \\"User is not authorized to access the specified project.\\"\\n}"},{"type":"xml","example":"<RequestId>4EFF678D-DD88-4AEB-B81C-B760AFDFA250</RequestId>\\n<OssUploadMeta>\\n <Policy>xxxxxxxxx</Policy>\\n <SecurityToken>xxxxxxxxxx</SecurityToken>\\n <Signature>xxxxxxxxxxx=</Signature>\\n <ObjectKey>11/1527911483513.zip</ObjectKey>\\n <Host>http://xxxxxxx.oss-cn-shanghai.aliyuncs.com</Host>\\n <AccessKey>STS.xxxxxxxx</AccessKey>\\n</OssUploadMeta>","errorExample":""}]', - 'title' => 'GetOssUploadMeta', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'ListApiGatewayApps' => [ - 'methods' => [ - 'post', - 'get', + [ + 'apiName' => 'CreateNamespace', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'iovcc:CreateNamespace', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + [ + 'apiName' => 'ListFunctionExecuteLog', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'iovcc:ListFunctionExecuteLog', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'DeleteRpcService', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'iovcc:DeleteRpcService', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'operationType' => 'read', - 'systemTags' => [ + [ + 'apiName' => 'ListUpstreamAppKeyRelations', + 'description' => '', 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'iovcc:ListUpstreamAppKeyRelations', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'parameters' => [ - [ - 'name' => 'ProjectId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '11', + [ + 'apiName' => 'CountActivatedOrNewRegistrationDevice', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'iovcc:CountActivatedOrNewRegistrationDevice', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'ApiGatewayApps' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'GatewayAppKey' => [ - 'description' => '', - 'type' => 'string', - 'example' => '24659924', - ], - 'Status' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'GatewayAppSecret' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'a******1', - ], - 'GatewayAppId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '1111111', - ], - 'UserId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '1768723179523459', - ], - 'ProjectId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '11', - ], - 'GmtCreate' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1508400744000', - ], - 'GmtModified' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1525340035000', - ], - 'Id' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '8', - ], - ], - ], - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '9CC2A1F1-DAE4-47DA-A682-240AF2DEED84', - ], - ], + [ + 'apiName' => 'GetOssUploadMeta', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'iovcc:GetOssUploadMeta', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"9CC2A1F1-DAE4-47DA-A682-240AF2DEED84\\",\\n \\"ApiGatewayApps\\": [\\n {\\n \\"GatewayAppKey\\": \\"24659924\\",\\n \\"Status\\": 0,\\n \\"GatewayAppSecret\\": \\"a******1\\",\\n \\"GatewayAppId\\": \\"1111111\\",\\n \\"UserId\\": \\"1768723179523459\\",\\n \\"ProjectId\\": \\"11\\",\\n \\"GmtCreate\\": 1508400744000,\\n \\"GmtModified\\": 1525340035000,\\n \\"Id\\": 8\\n }\\n ]\\n}","errorExample":"{\\n \\"RequestId\\": \\"6F25F67C-F411-499F-BCE2-67CA563CB064\\",\\n \\"HostId\\": \\"iovcc.cn-shanghai.aliyuncs.com\\",\\n \\"Code\\": \\"NotFoundProject\\",\\n \\"Message\\": \\"Cannot find the specified project\\"\\n}"},{"type":"xml","example":"<ListApiGatewayAppsResponse>\\r\\n\\t<ApiGatewayApps>\\r\\n\\t\\t<Status>0</Status>\\r\\n\\t\\t<GatewayAppId>1111111</GatewayAppId>\\r\\n\\t\\t<Id>8</Id>\\r\\n\\t\\t<UserId>1768723179523459</UserId>\\r\\n\\t\\t<GatewayAppKey>24659924</GatewayAppKey>\\r\\n\\t\\t<GmtCreate>1508400744000</GmtCreate>\\r\\n\\t\\t<GmtModified>1525340035000</GmtModified>\\r\\n\\t\\t<ProjectId>11</ProjectId>\\r\\n\\t\\t<GatewayAppSecret>a******1</GatewayAppSecret>\\r\\n\\t</ApiGatewayApps>\\r\\n\\t<RequestId>9CC2A1F1-DAE4-47DA-A682-240AF2DEED84</RequestId>\\r\\n</ListApiGatewayAppsResponse>","errorExample":""}]', - 'title' => 'ListApiGatewayApps', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'ListApps' => [ - 'methods' => [ - 'post', - 'get', + [ + 'apiName' => 'DeleteUpstreamAppServer', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'iovcc:DeleteUpstreamAppServer', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + [ + 'apiName' => 'ListConnectLogs', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'iovcc:ListConnectLogs', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'InvokeFunction', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'iovcc:InvokeFunction', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'operationType' => 'read', - 'systemTags' => [ + [ + 'apiName' => 'GenerateFunctionFileUploadMeta', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'iovcc:GenerateFunctionFileUploadMeta', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'CreateTrigger', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'iovcc:CreateTrigger', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DescribeDeviceInfo', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'iovcc:DescribeDeviceInfo', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListAssistHistoryDetails', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'iovcc:ListAssistHistoryDetails', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DeleteNamespace', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'iovcc:DeleteNamespace', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'PushMessage', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'iovcc:PushMessage', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DeleteVersionBlackDevices', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'iovcc:DeleteVersionBlackDevices', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'UpdateVersionDeviceGroup', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'iovcc:UpdateVersionDeviceGroup', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetDeviceSystemUpdateFunnelEvents', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'iovcc:GetDeviceSystemUpdateFunnelEvents', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DescribeVersionDeviceGroup', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'iovcc:DescribeVersionDeviceGroup', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DeleteCustomizedProperty', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'iovcc:DeleteCustomizedProperty', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListFunctionFiles', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'iovcc:ListFunctionFiles', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'FindCustomizedFilters', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'iovcc:FindCustomizedFilters', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'AddVersionBlackDevices', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'iovcc:AddVersionBlackDevices', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'FindVersionMessageSendRecords', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'iovcc:FindVersionMessageSendRecords', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DeleteTrigger', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'iovcc:DeleteTrigger', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'UpdateOsVersion', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'iovcc:UpdateOsVersion', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DelayPublishOsVersion', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'iovcc:DelayPublishOsVersion', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'SubmitAssistReport', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'iovcc:SubmitAssistReport', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListFunctionFilesByProjectId', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'iovcc:ListFunctionFilesByProjectId', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DeleteVersionGroupDeviceById', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'iovcc:DeleteVersionGroupDeviceById', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListPreChecks', + 'description' => '', 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'iovcc:ListPreChecks', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'parameters' => [ - [ - 'name' => 'ProjectId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'PV37HJ8Q', + [ + 'apiName' => 'CreateShadowSchema', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'iovcc:CreateShadowSchema', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '629586FE-CB2E-4742-995E-121F952CEB72', - ], - 'Apps' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'AppName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'app_test', - ], - 'AppKey' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'ZBjeuffe', - ], - 'OsType' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'AppPackage' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'com.aliyun.test', - ], - ], - ], - ], - ], + [ + 'apiName' => 'ListShadowSchemas', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'iovcc:ListShadowSchemas', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"629586FE-CB2E-4742-995E-121F952CEB72\\",\\n \\"Apps\\": [\\n {\\n \\"AppName\\": \\"app_test\\",\\n \\"AppKey\\": \\"ZBjeuffe\\",\\n \\"OsType\\": 1,\\n \\"AppPackage\\": \\"com.aliyun.test\\"\\n }\\n ]\\n}","errorExample":"{\\n \\"Code\\":\\"MissingParameter\\",\\n \\"Message\\":\\"The Type is mandatory for this action\\",\\n \\"HostId\\": \\"iovcc.cn-shanghai.aliyuncs.com\\",\\n \\"RequestId\\":\\"629586FE-CB2E-4742-995E-121F952CEB72\\"\\n}"},{"type":"xml","example":"<ListAppsResponse>\\n\\t<Apps>\\n\\t\\t<AppKey>ZBjeuffe</AppKey>\\n\\t\\t<AppName>app_test</AppName>\\n\\t\\t<AppPackage>com.aliyun.test</AppPackage>\\n\\t\\t<OsType>6</OsType>\\n\\t</Apps>\\n\\t<RequestId>D1BE8AC4-BE5B-4B04-B78B-A64C6BDB2AC2</RequestId>\\n</ListAppsResponse>","errorExample":""}]', - 'title' => 'ListApps', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'ListClientPlugins' => [ - 'methods' => [ - 'post', - 'get', + [ + 'apiName' => 'ListShadowSchemaDeviceModels', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'iovcc:ListShadowSchemaDeviceModels', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + [ + 'apiName' => 'PublishAppVersion', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'iovcc:PublishAppVersion', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'DescribeDeviceShadow', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'iovcc:DescribeDeviceShadow', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'operationType' => 'read', - 'systemTags' => [ + [ + 'apiName' => 'ListUpstreamAppServers', + 'description' => '', 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'iovcc:ListUpstreamAppServers', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'parameters' => [ - [ - 'name' => 'OsType', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '1', + [ + 'apiName' => 'CreateDeviceBrand', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'iovcc:CreateDeviceBrand', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '647D4B28-7646-424E-88DD-61B7969E5C1E', - ], - 'ClientPlugins' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'PkgName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'com.aliyun.aicc.yundevice', - ], - 'Name' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'YunDevice', - ], - ], - ], - ], - ], + [ + 'apiName' => 'DeleteVersionGroupDevice', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'iovcc:DeleteVersionGroupDevice', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"647D4B28-7646-424E-88DD-61B7969E5C1E\\",\\n \\"ClientPlugins\\": [\\n {\\n \\"PkgName\\": \\"com.aliyun.aicc.yundevice\\",\\n \\"Name\\": \\"YunDevice\\"\\n }\\n ]\\n}","errorExample":"{\\n \\"RequestId\\": \\"6F25F67C-F411-499F-BCE2-67CA563CB064\\",\\n \\"HostId\\": \\"iovcc.cn-shanghai.aliyuncs.com\\",\\n \\"Code\\": \\"InvalidTenant\\",\\n \\"Message\\": \\"User is not a valid tenant\\"\\n}"},{"type":"xml","example":"<ListClientPluginsResponse>\\r\\n\\t<RequestId>647D4B28-7646-424E-88DD-61B7969E5C1E</RequestId>\\r\\n\\t<ClientPlugins>\\r\\n\\t\\t<Name>YunDevice</Name>\\r\\n\\t\\t<PkgName>com.aliyun.aicc.yundevice</PkgName>\\r\\n\\t</ClientPlugins>\\r\\n\\t<ClientPlugins>\\r\\n\\t\\t<Name>RemoteAssistant</Name>\\r\\n\\t\\t<PkgName>com.aliyun.aicc.remoteassistant</PkgName>\\r\\n\\t</ClientPlugins>\\r\\n\\t<ClientPlugins>\\r\\n\\t\\t<Name>YunControl</Name>\\r\\n\\t\\t<PkgName>com.aliyun.aicc.yuncontrol</PkgName>\\r\\n\\t</ClientPlugins>\\r\\n</ListClientPluginsResponse>","errorExample":""}]', - 'title' => 'ListClientPlugins', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'ListDeviceBrands' => [ - 'methods' => [ - 'get', + [ + 'apiName' => 'UpdateNamespaceData', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'iovcc:UpdateNamespaceData', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + [ + 'apiName' => 'DeleteOpenAccount', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'iovcc:DeleteOpenAccount', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'DeleteDevice', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'iovcc:DeleteDevice', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'operationType' => 'read', - 'systemTags' => [ + [ + 'apiName' => 'DescribeCustomizedFilter', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'iovcc:DescribeCustomizedFilter', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'AddVersionWhiteDevicesByDeviceGroups', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'iovcc:AddVersionWhiteDevicesByDeviceGroups', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'UpdateAppVersionReleaseNote', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'iovcc:UpdateAppVersionReleaseNote', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DeleteVersionBlackDevicesById', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'iovcc:DeleteVersionBlackDevicesById', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'CreateCustomizedProperty', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'iovcc:CreateCustomizedProperty', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'AddUploadedFunctionFileInfo', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'iovcc:AddUploadedFunctionFileInfo', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'CreateDeviceModel', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'iovcc:CreateDeviceModel', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'CountDeviceModels', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'iovcc:CountDeviceModels', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListNamespaces', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'iovcc:ListNamespaces', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'CreateProjectApp', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'iovcc:CreateProjectApp', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DeleteCustomizedFilter', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'iovcc:DeleteCustomizedFilter', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListProjects', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'iovcc:ListProjects', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DescribeOsVersion', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'iovcc:DescribeOsVersion', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'UpdateTrigger', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'iovcc:UpdateTrigger', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'CreateOsVersion', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'iovcc:CreateOsVersion', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DeleteSchemaSubscribe', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'iovcc:DeleteSchemaSubscribe', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DeleteAllVersionGroupDevices', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'iovcc:DeleteAllVersionGroupDevices', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DescribeDeviceIdByOuterInfo', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'iovcc:DescribeDeviceIdByOuterInfo', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListMessageReceivers', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'iovcc:ListMessageReceivers', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListOpenAccounts', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'iovcc:ListOpenAccounts', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'FindOsVersions', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'iovcc:FindOsVersions', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'CreateRpcService', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'iovcc:CreateRpcService', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListDeployedFunctions', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'iovcc:ListDeployedFunctions', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ConnectAssistDevice', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'iovcc:ConnectAssistDevice', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DescribeAssistRTMPServerAddress', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'iovcc:DescribeAssistRTMPServerAddress', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'AddVersionWhiteDevices', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'iovcc:AddVersionWhiteDevices', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DeleteProjectApp', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'iovcc:DeleteProjectApp', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'CreateSchemaSubscribe', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'iovcc:CreateSchemaSubscribe', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'FindVersionTests', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'iovcc:FindVersionTests', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DeleteVersionAllWhiteDevices', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'iovcc:DeleteVersionAllWhiteDevices', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'QueryPrepublishPassedDeviceCount', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'iovcc:QueryPrepublishPassedDeviceCount', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListAssistActionDetails', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'iovcc:ListAssistActionDetails', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'CreateVersionPrepublish', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'iovcc:CreateVersionPrepublish', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DeleteFunctionFile', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'iovcc:DeleteFunctionFile', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'UpdateProject', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'iovcc:UpdateProject', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListRpcServices', + 'description' => '', 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'iovcc:ListRpcServices', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'parameters' => [ - [ - 'name' => 'ProjectId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'projectTest', + [ + 'apiName' => 'UpdateCustomizedFilter', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'iovcc:UpdateCustomizedFilter', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'DeviceBrandId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1', + ], + [ + 'apiName' => 'CreateAppVersion', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'iovcc:CreateAppVersion', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'DeviceBrand', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'Tmall', + ], + [ + 'apiName' => 'CreateUpstreamAppKeyRelation', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'iovcc:CreateUpstreamAppKeyRelation', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'Start', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '10', + ], + [ + 'apiName' => 'GenerateSdkDownloadInfo', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'iovcc:GenerateSdkDownloadInfo', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'Length', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '20', + ], + [ + 'apiName' => 'DescribeDeviceBrand', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'iovcc:DescribeDeviceBrand', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'DeviceBrands' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'DeviceBrandId' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'Description' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'ProjectId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'projectTest', - ], - 'Manufacture' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'SAIC', - ], - 'DeviceBrand' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'ROEWE', - ], - ], - ], - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '9c7a3b09-a69a-43f5-8bf2-84f7119810eb', - ], - ], + [ + 'apiName' => 'DeleteShadowSchema', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'iovcc:DeleteShadowSchema', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"9c7a3b09-a69a-43f5-8bf2-84f7119810eb\\",\\n \\"DeviceBrands\\": [\\n {\\n \\"Manufacture\\": \\"SAIC\\",\\n \\"DeviceBrandId\\": 1,\\n \\"Description\\": \\"荣威\\\\t\\",\\n \\"DeviceBrand\\": \\"ROEWE\\",\\n \\"ProjectId\\": \\"projectTest\\"\\n }\\n ]\\n}","errorExample":"{\\n \\"Code\\":\\"NoPermissionToAccessProject\\",\\n \\"HostId\\":\\"iovcc.cn-shanghai.aliyuncs.com\\",\\n \\"Message\\":\\"User is not authorized to access the specified project.\\",\\n \\"RequestId\\":\\"6F25F67C-F411-499F-BCE2-67CA563CB064\\"\\n}"},{"type":"xml","example":"<ListDeviceBrandsResponse>\\r\\n\\t<DeviceBrands>\\r\\n\\t\\t<Description>荣威</Description>\\r\\n\\t\\t<DeviceBrand>ROEWE</DeviceBrand>\\r\\n\\t\\t<DeviceBrandId>1</DeviceBrandId>\\r\\n\\t\\t<Manufacture>SAIC</Manufacture>\\r\\n\\t\\t<ProjectId>projectTest</ProjectId>\\r\\n\\t</DeviceBrands>\\r\\n\\t<RequestId>E94C9864-56FB-44AD-AC0C-A1CEFB332254</RequestId>\\r\\n</ListDeviceBrandsResponse>","errorExample":""}]', - 'title' => 'ListDeviceBrands', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'ListPreChecks' => [ - 'methods' => [ - 'post', - 'get', + [ + 'apiName' => 'DeleteVersionDeviceGroup', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'iovcc:DeleteVersionDeviceGroup', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + [ + 'apiName' => 'DescribeProjectAppSecurity', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'iovcc:DescribeProjectAppSecurity', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'CountDeviceBrands', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'iovcc:CountDeviceBrands', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'operationType' => 'read', - 'systemTags' => [ + [ + 'apiName' => 'ListDeviceBrands', + 'description' => '', 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'iovcc:ListDeviceBrands', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'parameters' => [], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'BB80AC68-1E8A-4A46-B348-7D875AE9132A', - ], - 'PreChecks' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'IovccEnabled', - ], - 'Link' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'https://www.aliyun.com/product/iovcc', - ], - 'Price' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'FreeTrial', - ], - 'State' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Enabled', - ], - ], - ], - ], - ], + [ + 'apiName' => 'ListAssistHistories', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'iovcc:ListAssistHistories', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"BB80AC68-1E8A-4A46-B348-7D875AE9132A\\",\\n \\"PreChecks\\": [\\n {\\n \\"Key\\": \\"IovccEnabled\\",\\n \\"Link\\": \\"https://www.aliyun.com/product/iovcc\\",\\n \\"Price\\": \\"FreeTrial\\",\\n \\"State\\": \\"Enabled\\"\\n }\\n ]\\n}","errorExample":"{\\n \\"RequestId\\": \\"6F25F67C-F411-499F-BCE2-67CA563CB064\\",\\n \\"HostId\\": \\"iovcc.cn-shanghai.aliyuncs.com\\",\\n \\"Code\\": \\"InvalidTenant\\",\\n \\"Message\\": \\"User is not a valid tenant\\"\\n}"},{"type":"xml","example":"<ListPreChecksResponse>\\n\\t<PreChecks>\\n\\t\\t<Link>https://www.aliyun.com/product/iovcc</Link>\\n\\t\\t<Key>IovccEnabled</Key>\\n\\t\\t<State>Enabled</State>\\n\\t\\t<Price>FreeTrial</Price>\\n\\t</PreChecks>\\n\\t<RequestId>D1BE8AC4-BE5B-4B04-B78B-A64C6BDB2AC2</RequestId>\\n</ListPreChecksResponse>","errorExample":""}]', - 'title' => 'ListPreChecks', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'ListRpcServices' => [ - 'methods' => [ - 'post', - 'get', + [ + 'apiName' => 'FindAppVersions', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'iovcc:FindAppVersions', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + [ + 'apiName' => 'DescribeAssistReport', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'iovcc:DescribeAssistReport', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'CountDevices', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'iovcc:CountDevices', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'operationType' => 'read', - 'systemTags' => [ + [ + 'apiName' => 'GetNamespaceData', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'iovcc:GetNamespaceData', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'UpdateApiGatewayAppStatus', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'iovcc:UpdateApiGatewayAppStatus', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListClientPlugins', + 'description' => '', 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'iovcc:ListClientPlugins', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'parameters' => [ - [ - 'name' => 'ProjectId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'sfgsghd6', + [ + 'apiName' => 'UpdateShadowSchema', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'iovcc:UpdateShadowSchema', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'PageIndex', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', + ], + [ + 'apiName' => 'ListSchemaSubscribes', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'iovcc:ListSchemaSubscribes', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '20', + ], + [ + 'apiName' => 'CreateVersionDeviceGroup', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'iovcc:CreateVersionDeviceGroup', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '629586FE-CB2E-4742-995E-121F952CEB72', - ], - 'RpcServices' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Pagination' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'PageIndex' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'TotalPageCount' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - 'PageSize' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '20', - ], - 'TotalCount' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '30', - ], - ], - ], - 'List' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'MethodName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'rpcTest', - ], - 'Type' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'http', - ], - 'InterfaceName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'https://portal.aicc.aliyun.com/rpcServiceTest.html', - ], - 'Params' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'param1,param2', - ], - 'AppKey' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'aorlFafJ', - ], - 'GroupName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'lbs', - ], - 'GmtCreate' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1525684245000', - ], - 'IsDelete' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'N', - ], - 'VersionCode' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2018-05-01', - ], - 'GmtModified' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1525684245000', - ], - 'Id' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - ], - ], - ], - ], - ], - ], + [ + 'apiName' => 'FindPrepublishesByParentId', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'iovcc:FindPrepublishesByParentId', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"629586FE-CB2E-4742-995E-121F952CEB72\\",\\n \\"RpcServices\\": {\\n \\"List\\": [\\n {\\n \\"MethodName\\": \\"rpcTest\\",\\n \\"Type\\": \\"http\\",\\n \\"InterfaceName\\": \\"https://portal.aicc.aliyun.com/rpcServiceTest.html\\",\\n \\"Params\\": \\"param1,param2\\",\\n \\"AppKey\\": \\"aorlFafJ\\",\\n \\"GroupName\\": \\"lbs\\",\\n \\"GmtCreate\\": 1525684245000,\\n \\"IsDelete\\": \\"N\\",\\n \\"VersionCode\\": \\"2018-05-01\\",\\n \\"GmtModified\\": 1525684245000,\\n \\"Id\\": 1\\n }\\n ],\\n \\"Pagination\\": {\\n \\"PageIndex\\": 1,\\n \\"TotalPageCount\\": 2,\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 30\\n }\\n }\\n}","errorExample":"{\\n \\"Code\\":\\"MissingParameter\\",\\n \\"Message\\":\\"The ProjectId is mandatory for this action\\",\\n \\"HostId\\": \\"iovcc.cn-shanghai.aliyuncs.com\\",\\n \\"RequestId\\":\\"629586FE-CB2E-4742-995E-121F952CEB72\\"\\n}"},{"type":"xml","example":"<ListRpcServicesResponse>\\r\\n\\t<RpcServices>\\r\\n\\t\\t<Pagination>\\r\\n\\t\\t\\t<TotalCount>2</TotalCount>\\r\\n\\t\\t\\t<TotalPageCount>1</TotalPageCount>\\r\\n\\t\\t\\t<PageIndex>1</PageIndex>\\r\\n\\t\\t\\t<PageSize>20</PageSize>\\r\\n\\t\\t</Pagination>\\r\\n\\t\\t<List>\\r\\n\\t\\t\\t<Id>1</Id>\\r\\n\\t\\t\\t<AppKey>cH8Rj1CF</AppKey>\\r\\n\\t\\t\\t<Method>rpcTest1</Method>\\r\\n <MethodName>rpcTest1</MethodName>\\r\\n <VersionCode>2018-05-01</VersionCode> \\r\\n\\t\\t\\t<InterfaceName>https://portal.aicc.aliyun.com/rpcServiceTest.html</InterfaceName>\\r\\n\\t\\t\\t<GroupName>rpcTest</GroupName>\\r\\n\\t\\t\\t<Version>1.0.0</Version>\\r\\n\\t\\t\\t<Type>http</Type>\\r\\n\\t\\t\\t<Params>param1,param2</Params>\\r\\n\\t\\t\\t<IsDelete>N</IsDelete>\\r\\n\\t\\t\\t<GmtCreate>1513846288000</GmtCreate>\\r\\n\\t\\t\\t<GmtModified>1513846288000</GmtModified>\\r\\n\\t\\t</List>\\r\\n\\t\\t<List>\\r\\n\\t\\t\\t<Id>2</Id>\\r\\n\\t\\t\\t<AppKey>cH8Rj1CF</AppKey>\\r\\n\\t\\t\\t<Method>rpcTest2</Method>\\r\\n <MethodName>rpcTest2</MethodName>\\r\\n <VersionCode>2018-05-02</VersionCode>\\r\\n\\t\\t\\t<InterfaceName>https://portal.aicc.aliyun.com/rpcServiceTest.html</InterfaceName>\\r\\n\\t\\t\\t<GroupName>rpcTest</GroupName>\\r\\n\\t\\t\\t<Version>1.0.0</Version>\\r\\n\\t\\t\\t<Type>http</Type>\\r\\n\\t\\t\\t<Params>param1,param2</Params>\\r\\n\\t\\t\\t<IsDelete>N</IsDelete>\\r\\n\\t\\t\\t<GmtCreate>1513846284000</GmtCreate>\\r\\n\\t\\t\\t<GmtModified>1513846284000</GmtModified>\\r\\n\\t\\t</List>\\r\\n\\t</RpcServices>\\r\\n\\t<RequestId>629586FE-CB2E-4742-995E-121F952CEB72</RequestId>\\r\\n</ListRpcServicesResponse>","errorExample":""}]', - 'title' => 'ListRpcServices', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'ListSupportFeatures' => [ - 'methods' => [ - 'post', - 'get', + [ + 'apiName' => 'DescribeAssistWSServerAddress', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'iovcc:DescribeAssistWSServerAddress', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + [ + 'apiName' => 'UpdateAppBlackWhiteVersions', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'iovcc:UpdateAppBlackWhiteVersions', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'UpdateVersionPrepublishActiveStatus', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'iovcc:UpdateVersionPrepublishActiveStatus', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'operationType' => 'read', - 'systemTags' => [ + [ + 'apiName' => 'ListDeviceModels', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'iovcc:ListDeviceModels', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DiagnosisVersion', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'iovcc:DiagnosisVersion', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'UpdateAppVersion', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'iovcc:UpdateAppVersion', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListClientSdks', + 'description' => '', 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'iovcc:ListClientSdks', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'parameters' => [], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '1B0DA203-B3BA-43CD-9506-5DF33ACEFF26', - ], - 'SupportFeatures' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'OTA', - ], - ], - ], - ], - ], + [ + 'apiName' => 'UpdateOsBlackWhiteVersions', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'iovcc:UpdateOsBlackWhiteVersions', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1B0DA203-B3BA-43CD-9506-5DF33ACEFF26\\",\\n \\"SupportFeatures\\": [\\n {\\n \\"Name\\": \\"OTA\\"\\n }\\n ]\\n}","errorExample":"{\\n \\"RequestId\\": \\"6F25F67C-F411-499F-BCE2-67CA563CB064\\",\\n \\"HostId\\": \\"iovcc.cn-shanghai.aliyuncs.com\\",\\n \\"Code\\": \\"InvalidTenant\\",\\n \\"Message\\": \\"User is not a valid tenant\\"\\n}"},{"type":"xml","example":"<ListSupportFeaturesResponse>\\r\\n\\t<SupportFeatures>\\r\\n\\t\\t<Name>OTA</Name>\\r\\n\\t</SupportFeatures>\\r\\n\\t<SupportFeatures>\\r\\n\\t\\t<Name>DIS</Name>\\r\\n\\t</SupportFeatures>\\r\\n\\t<SupportFeatures>\\r\\n\\t\\t<Name>IAS</Name>\\r\\n\\t</SupportFeatures>\\r\\n\\t<SupportFeatures>\\r\\n\\t\\t<Name>RA</Name>\\r\\n\\t</SupportFeatures>\\r\\n\\t<SupportFeatures>\\r\\n\\t\\t<Name>CMNS</Name>\\r\\n\\t</SupportFeatures>\\r\\n\\t<RequestId>1B0DA203-B3BA-43CD-9506-5DF33ACEFF26</RequestId>\\r\\n</ListSupportFeaturesResponse>","errorExample":""}]', - 'title' => 'ListSupportFeatures', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'ListUpstreamAppKeyRelations' => [ - 'methods' => [ - 'post', - 'get', + [ + 'apiName' => 'GetDeviceAppUpdateFunnelEvents', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'iovcc:GetDeviceAppUpdateFunnelEvents', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + [ + 'apiName' => 'UpdateUpstreamAppServer', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'iovcc:UpdateUpstreamAppServer', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'FindPrepublishPassedDevices', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'iovcc:FindPrepublishPassedDevices', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'list', + [ + 'apiName' => 'FindVersionMessages', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'iovcc:FindVersionMessages', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'parameters' => [ - [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '20', + [ + 'apiName' => 'ListProjectApps', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'iovcc:ListProjectApps', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'ProjectId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'fsgtd5y5r', + ], + [ + 'apiName' => 'DescribeDeviceValiditySchema', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'iovcc:DescribeDeviceValiditySchema', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'AppServerId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '2', + ], + [ + 'apiName' => 'CreateUpstreamAppServer', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'iovcc:CreateUpstreamAppServer', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'PageIndex', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', + ], + [ + 'apiName' => 'DeployFunctionFile', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'iovcc:DeployFunctionFile', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '629586FE-CB2E-4742-995E-121F952CEB72', - ], - 'RelationList' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Pagination' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'PageIndex' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'TotalPageCount' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '20', - ], - 'TotalCount' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - ], - ], - 'List' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'AppName' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'AppKey' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'afsgwewt', - ], - 'AppPackage' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'com.test.member', - ], - 'ProjectId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'fsgtd5y5r', - ], - 'GmtCreate' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1525696592000', - ], - 'PAppKey' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'cfsgweFv', - ], - 'Id' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - ], - ], - ], - ], - ], - ], + [ + 'apiName' => 'FindCustomizedProperties', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'iovcc:FindCustomizedProperties', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"629586FE-CB2E-4742-995E-121F952CEB72\\",\\n \\"RelationList\\": {\\n \\"List\\": [\\n {\\n \\"AppName\\": \\"会员中心\\",\\n \\"AppKey\\": \\"afsgwewt\\",\\n \\"AppPackage\\": \\"com.test.member\\",\\n \\"ProjectId\\": \\"fsgtd5y5r\\",\\n \\"GmtCreate\\": 1525696592000,\\n \\"PAppKey\\": \\"cfsgweFv\\",\\n \\"Id\\": 1\\n }\\n ],\\n \\"Pagination\\": {\\n \\"PageIndex\\": 1,\\n \\"TotalPageCount\\": 1,\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 2\\n }\\n }\\n}","errorExample":"{\\n \\"Code\\":\\"MissingParameter\\",\\n \\"Message\\":\\"The AppServerId is mandatory for this action\\",\\n \\"HostId\\": \\"iovcc.cn-shanghai.aliyuncs.com\\",\\n \\"RequestId\\":\\"629586FE-CB2E-4742-995E-121F952CEB72\\"\\n}"},{"type":"xml","example":"<ListUpstreamAppKeyRelationsResponse>\\r\\n\\t<RelationList>\\r\\n\\t\\t<List>\\r\\n\\t\\t\\t<AppKey>gU4bcOff</AppKey>\\r\\n <AppName>会员中心</AppName>\\r\\n <AppPackage>com.test.member</AppPackage>\\r\\n\\t\\t\\t<GmtCreate>1525696754000</GmtCreate>\\r\\n\\t\\t\\t<Id>275</Id>\\r\\n\\t\\t\\t<PAppKey>JU3ffOub</PAppKey>\\r\\n\\t\\t\\t<ProjectId>fJCR8g2I</ProjectId>\\r\\n\\t\\t</List>\\r\\n\\t\\t<Pagination>\\r\\n\\t\\t\\t<PageIndex>1</PageIndex>\\r\\n\\t\\t\\t<PageSize>20</PageSize>\\r\\n\\t\\t\\t<TotalCount>1</TotalCount>\\r\\n\\t\\t\\t<TotalPageCount>1</TotalPageCount>\\r\\n\\t\\t</Pagination>\\r\\n\\t</RelationList>\\r\\n\\t<RequestId>629586FE-CB2E-4742-995E-121F952CEB72</RequestId>\\r\\n</ListUpstreamAppKeyRelationsResponse>","errorExample":""}]', - 'title' => 'ListUpstreamAppKeyRelations', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'ListUpstreamAppServers' => [ - 'methods' => [ - 'post', - 'get', + [ + 'apiName' => 'PublishOsVersion', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'iovcc:PublishOsVersion', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + [ + 'apiName' => 'DescribeOpenAccount', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'iovcc:DescribeOpenAccount', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'ListDeviceTypes', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'iovcc:ListDeviceTypes', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'operationType' => 'read', - 'systemTags' => [ + [ + 'apiName' => 'UpdateDeviceModel', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'iovcc:UpdateDeviceModel', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListTriggers', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'iovcc:ListTriggers', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'CreateCustomizedFilter', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'iovcc:CreateCustomizedFilter', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'CreateVersionTest', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'iovcc:CreateVersionTest', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'UpdateAppVersionStatus', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'iovcc:UpdateAppVersionStatus', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListApiGatewayApps', + 'description' => '', 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'iovcc:ListApiGatewayApps', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'parameters' => [ - [ - 'name' => 'ProjectId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'fsgtd5y5r', + [ + 'apiName' => 'PushVersionMessage', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'iovcc:PushVersionMessage', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'PageIndex', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '1', + ], + [ + 'apiName' => 'DescribeDefaultSchema', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'iovcc:DescribeDefaultSchema', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '20', + ], + [ + 'apiName' => 'UpdateOsVersionReleaseNote', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'iovcc:UpdateOsVersionReleaseNote', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '629586FE-CB2E-4742-995E-121F952CEB72', - ], - 'AppServers' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Pagination' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'PageIndex' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'TotalPageCount' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '20', - ], - 'TotalCount' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - ], - ], - 'List' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'ProjectId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Gs6st7ye', - ], - 'GmtCreate' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1525701500000', - ], - 'Tags' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'tag1,tag2,tag3', - ], - 'QueueNameList' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'com-yunos-iovcc-cmns-forward-qa-mRFG7Bee-tag1,com-yunos-iovcc-cmns-forward-qa-mRFG7Bee-tag2,com-yunos-aicc-cmns-forward-qa-mRFG7Bee-tag3', - ], - 'PAppKey' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'fsgstyye', - ], - 'GmtModified' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1525701500000', - ], - 'Name' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'iovcc-test', - ], - 'Id' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - ], - ], - ], - ], - ], - ], + [ + 'apiName' => 'ListAssistDevices', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'iovcc:ListAssistDevices', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"629586FE-CB2E-4742-995E-121F952CEB72\\",\\n \\"AppServers\\": {\\n \\"List\\": [\\n {\\n \\"ProjectId\\": \\"Gs6st7ye\\",\\n \\"GmtCreate\\": 1525701500000,\\n \\"Tags\\": \\"tag1,tag2,tag3\\",\\n \\"QueueNameList\\": \\"com-yunos-iovcc-cmns-forward-qa-mRFG7Bee-tag1,com-yunos-iovcc-cmns-forward-qa-mRFG7Bee-tag2,com-yunos-aicc-cmns-forward-qa-mRFG7Bee-tag3\\",\\n \\"PAppKey\\": \\"fsgstyye\\",\\n \\"GmtModified\\": 1525701500000,\\n \\"Name\\": \\"iovcc-test\\",\\n \\"Id\\": 1\\n }\\n ],\\n \\"Pagination\\": {\\n \\"PageIndex\\": 1,\\n \\"TotalPageCount\\": 1,\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 2\\n }\\n }\\n}","errorExample":"{\\n \\"Code\\":\\"MissingParameter\\",\\n \\"Message\\":\\"The ProjectId is mandatory for this action\\",\\n \\"HostId\\": \\"iovcc.cn-shanghai.aliyuncs.com\\",\\n \\"RequestId\\":\\"629586FE-CB2E-4742-995E-121F952CEB72\\"\\n}"},{"type":"xml","example":"<ListUpstreamAppServersResponse>\\r\\n\\t<AppServers>\\r\\n\\t\\t<Pagination>\\r\\n\\t\\t\\t<TotalCount>2</TotalCount>\\r\\n\\t\\t\\t<TotalPageCount>1</TotalPageCount>\\r\\n\\t\\t\\t<PageIndex>1</PageIndex>\\r\\n\\t\\t\\t<PageSize>20</PageSize>\\r\\n\\t\\t</Pagination>\\r\\n\\t\\t<List>\\r\\n\\t\\t\\t<Id>7</Id>\\r\\n\\t\\t\\t<PAppKey>jRfe7P5k</PAppKey>\\r\\n\\t\\t\\t<ProjectId>8ZJH0595</ProjectId>\\r\\n\\t\\t\\t<Name>test1</Name>\\r\\n\\t\\t\\t<Tags>testTag</Tags>\\r\\n\\t\\t\\t<IsDelete>N</IsDelete>\\r\\n\\t\\t\\t<GmtCreate>1514357674000</GmtCreate>\\r\\n\\t\\t\\t<GmtModified>1525427071182</GmtModified>\\r\\n\\t\\t\\t<QueueNameList>com-yunos-iovcc-cmns-forward-qa-jRfe7P5k-testTag</QueueNameList>\\r\\n\\t\\t</List>\\r\\n\\t\\t<List>\\r\\n\\t\\t\\t<Id>6</Id>\\r\\n\\t\\t\\t<PAppKey>mRFG7Bee</PAppKey>\\r\\n\\t\\t\\t<ProjectId>8ZJH0595</ProjectId>\\r\\n\\t\\t\\t<Name>test2</Name>\\r\\n\\t\\t\\t<Tags>tag1,tag2,tag3</Tags>\\r\\n\\t\\t\\t<IsDelete>N</IsDelete>\\r\\n\\t\\t\\t<GmtCreate>1514344420000</GmtCreate>\\r\\n\\t\\t\\t<GmtModified>1525427071182</GmtModified>\\r\\n\\t\\t\\t<QueueNameList>com-yunos-iovcc-cmns-forward-qa-mRFG7Bee-tag1,com-yunos-iovcc-cmns-forward-qa-mRFG7Bee-tag2,com-yunos-aicc-cmns-forward-qa-mRFG7Bee-tag3</QueueNameList>\\r\\n\\t\\t</List>\\r\\n\\t</AppServers>\\r\\n\\t<RequestId>629586FE-CB2E-4742-995E-121F952CEB72</RequestId>\\r\\n</ListUpstreamAppServersResponse>","errorExample":""}]', - 'title' => 'ListUpstreamAppServers', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'UpdateVersionPrepublishActiveStatus' => [ - 'methods' => [ - 'post', - 'get', + [ + 'apiName' => 'ListDevices', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'iovcc:ListDevices', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'schemes' => [ - 'https', + [ + 'apiName' => 'DescribeShadowSchema', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'iovcc:DescribeShadowSchema', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'ListOfflineMessages', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'iovcc:ListOfflineMessages', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'operationType' => 'read', - 'systemTags' => [ + [ + 'apiName' => 'FindVersionWhiteDevices', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'iovcc:FindVersionWhiteDevices', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'UpdateOsVersionRemark', + 'description' => '', 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'iovcc:UpdateOsVersionRemark', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'parameters' => [ - [ - 'name' => 'ProjectId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'P0VFCREU', + [ + 'apiName' => 'ListSupportFeatures', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'iovcc:ListSupportFeatures', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'PrepublishId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '1', + ], + [ + 'apiName' => 'FindVersionGroupDevices', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'iovcc:FindVersionGroupDevices', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'IsActive', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'Y', + ], + [ + 'apiName' => 'DeleteVersionAllBlackDevices', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'iovcc:DeleteVersionAllBlackDevices', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '6F25F67C-F411-499F-BCE2-67CA563CB064', - ], - ], + [ + 'apiName' => 'DescribeDeviceOnlineInfo', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'iovcc:DescribeDeviceOnlineInfo', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DeleteUpstreamAppKeyRelation', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'iovcc:DeleteUpstreamAppKeyRelation', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DeleteVersionTest', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'iovcc:DeleteVersionTest', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListApps', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'iovcc:ListApps', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetNamespaceStatisticsData', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'iovcc:GetNamespaceStatisticsData', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DeleteVersionWhiteDevices', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'iovcc:DeleteVersionWhiteDevices', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DescribeDeviceModel', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'iovcc:DescribeDeviceModel', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListClientPluginVersions', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'iovcc:ListClientPluginVersions', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'IoVCommandCenter', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"6F25F67C-F411-499F-BCE2-67CA563CB064\\"\\n}","errorExample":"{\\n \\"RequestId\\": \\"6F25F67C-F411-499F-BCE2-67CA563CB064\\",\\n \\"HostId\\": \\"iovcc.cn-shanghai.aliyuncs.com\\",\\n \\"Code\\": \\"NoPermission.NotOwner\\",\\n \\"Message\\": \\"You have no permission because you are not the owner of the data\\"\\n}"},{"type":"xml","example":"<UpdateVersionPrepublishActiveStatusResponse>\\r\\n\\t<RequestId>6F25F67C-F411-499F-BCE2-67CA563CB064</RequestId>\\r\\n</UpdateVersionPrepublishActiveStatusResponse>","errorExample":""}]', - 'title' => 'UpdateVersionPrepublishActiveStatus', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - ], - 'endpoints' => [ - [ - 'regionId' => 'cn-shanghai', - 'endpoint' => 'iovcc.cn-shanghai.aliyuncs.com', ], + 'resourceTypes' => [], ], ]; |