summaryrefslogtreecommitdiff
path: root/data/zh_cn/iot/2017-07-20/api-docs.php
diff options
context:
space:
mode:
Diffstat (limited to 'data/zh_cn/iot/2017-07-20/api-docs.php')
-rw-r--r--data/zh_cn/iot/2017-07-20/api-docs.php827
1 files changed, 827 insertions, 0 deletions
diff --git a/data/zh_cn/iot/2017-07-20/api-docs.php b/data/zh_cn/iot/2017-07-20/api-docs.php
new file mode 100644
index 0000000..910d27f
--- /dev/null
+++ b/data/zh_cn/iot/2017-07-20/api-docs.php
@@ -0,0 +1,827 @@
+<?php return [
+ 'version' => '1.0',
+ 'info' => [
+ 'style' => 'RPC',
+ 'product' => 'Iot',
+ 'version' => '2017-07-20',
+ ],
+ 'directories' => [
+ [
+ 'id' => 0,
+ 'title' => '其它',
+ 'type' => 'directory',
+ 'children' => [
+ 'QueryDeviceByPkAndVersion',
+ 'QueryDeviceUpgradeInfo',
+ 'QueryFirmwareByName',
+ 'QueryFirmwareVerifyInfo',
+ 'QueryFirmwareByUid',
+ 'QueryFirmwareVersionById',
+ 'QueryVersionsByPk',
+ ],
+ ],
+ ],
+ 'components' => [
+ 'schemas' => [],
+ ],
+ 'apis' => [
+ 'QueryDeviceByPkAndVersion' => [
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'systemTags' => [],
+ 'parameters' => [
+ [
+ 'name' => 'PageNumber',
+ 'in' => 'query',
+ 'schema' => [
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ ],
+ ],
+ [
+ 'name' => 'PageSize',
+ 'in' => 'query',
+ 'schema' => [
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ ],
+ ],
+ [
+ 'name' => 'ProductKey',
+ 'in' => 'query',
+ 'schema' => [
+ 'type' => 'string',
+ 'required' => true,
+ ],
+ ],
+ [
+ 'name' => 'IndistinctDevName',
+ 'in' => 'query',
+ 'schema' => [
+ 'type' => 'string',
+ 'required' => false,
+ ],
+ ],
+ [
+ 'name' => 'FirmwareVersion',
+ 'in' => 'query',
+ 'style' => 'repeatList',
+ 'schema' => [
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'string',
+ ],
+ 'required' => true,
+ 'maxItems' => 20,
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'type' => 'string',
+ ],
+ 'ErrorMessage' => [
+ 'type' => 'string',
+ ],
+ 'Success' => [
+ 'type' => 'boolean',
+ ],
+ 'PageSize' => [
+ 'type' => 'integer',
+ 'format' => 'int32',
+ ],
+ 'TotalNum' => [
+ 'type' => 'integer',
+ 'format' => 'int32',
+ ],
+ 'PageCount' => [
+ 'type' => 'integer',
+ 'format' => 'int32',
+ ],
+ 'Page' => [
+ 'type' => 'integer',
+ 'format' => 'int32',
+ ],
+ 'Data' => [
+ 'type' => 'object',
+ 'itemNode' => true,
+ 'properties' => [
+ 'DeviceInfo' => [
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'ProductKey' => [
+ 'type' => 'string',
+ ],
+ 'DeviceName' => [
+ 'type' => 'string',
+ ],
+ 'FirmwareVersion' => [
+ 'type' => 'string',
+ ],
+ 'IotId' => [
+ 'type' => 'string',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'errorCodes' => [],
+ 'responseDemo' => '',
+ ],
+ 'QueryDeviceUpgradeInfo' => [
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'systemTags' => [],
+ 'parameters' => [
+ [
+ 'name' => 'PageSize',
+ 'in' => 'query',
+ 'schema' => [
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => true,
+ ],
+ ],
+ [
+ 'name' => 'ProductKey',
+ 'in' => 'query',
+ 'schema' => [
+ 'type' => 'string',
+ 'required' => false,
+ ],
+ ],
+ [
+ 'name' => 'Type',
+ 'in' => 'query',
+ 'schema' => [
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => true,
+ ],
+ ],
+ [
+ 'name' => 'DeviceName',
+ 'in' => 'query',
+ 'schema' => [
+ 'type' => 'string',
+ 'required' => false,
+ ],
+ ],
+ [
+ 'name' => 'FirmwareName',
+ 'in' => 'query',
+ 'schema' => [
+ 'type' => 'string',
+ 'required' => true,
+ ],
+ ],
+ [
+ 'name' => 'CurrentPage',
+ 'in' => 'query',
+ 'schema' => [
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => true,
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'type' => 'string',
+ ],
+ 'ErrorMessage' => [
+ 'type' => 'string',
+ ],
+ 'Success' => [
+ 'type' => 'boolean',
+ ],
+ 'PageSize' => [
+ 'type' => 'integer',
+ 'format' => 'int32',
+ ],
+ 'Total' => [
+ 'type' => 'integer',
+ 'format' => 'int32',
+ ],
+ 'PageCount' => [
+ 'type' => 'integer',
+ 'format' => 'int32',
+ ],
+ 'Page' => [
+ 'type' => 'integer',
+ 'format' => 'int32',
+ ],
+ 'Data' => [
+ 'type' => 'object',
+ 'itemNode' => true,
+ 'properties' => [
+ 'JobInfo' => [
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'CurrentUpgradePercent' => [
+ 'type' => 'string',
+ ],
+ 'ProductKey' => [
+ 'type' => 'string',
+ ],
+ 'JobStatus' => [
+ 'type' => 'integer',
+ 'format' => 'int32',
+ ],
+ 'ProductName' => [
+ 'type' => 'string',
+ ],
+ 'JobDesc' => [
+ 'type' => 'string',
+ ],
+ 'DeviceName' => [
+ 'type' => 'string',
+ ],
+ 'Version' => [
+ 'type' => 'string',
+ ],
+ 'JobId' => [
+ 'type' => 'integer',
+ 'format' => 'int64',
+ ],
+ 'GmtModified' => [
+ 'type' => 'string',
+ ],
+ 'JobResult' => [
+ 'type' => 'integer',
+ 'format' => 'int32',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'errorCodes' => [],
+ 'responseDemo' => '',
+ ],
+ 'QueryFirmwareByName' => [
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'systemTags' => [],
+ 'parameters' => [
+ [
+ 'name' => 'FirmwareName',
+ 'in' => 'query',
+ 'schema' => [
+ 'type' => 'string',
+ 'required' => true,
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Strategy' => [
+ 'type' => 'string',
+ ],
+ 'RequestId' => [
+ 'type' => 'string',
+ ],
+ 'ErrorMessage' => [
+ 'type' => 'string',
+ ],
+ 'Success' => [
+ 'type' => 'boolean',
+ ],
+ 'CreateTime' => [
+ 'type' => 'string',
+ ],
+ 'UpgradeType' => [
+ 'type' => 'string',
+ ],
+ 'StrategyType' => [
+ 'type' => 'string',
+ ],
+ 'FirmwareInfo' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Status' => [
+ 'type' => 'integer',
+ 'format' => 'int32',
+ ],
+ 'ProductName' => [
+ 'type' => 'string',
+ ],
+ 'FirmwareUrl' => [
+ 'type' => 'string',
+ ],
+ 'FirmwareName' => [
+ 'type' => 'string',
+ ],
+ 'FileName' => [
+ 'type' => 'string',
+ ],
+ 'FirmwareSign' => [
+ 'type' => 'string',
+ ],
+ 'GmtModified' => [
+ 'type' => 'string',
+ ],
+ 'ProductKey' => [
+ 'type' => 'string',
+ ],
+ 'FirmwareModifier' => [
+ 'type' => 'string',
+ ],
+ 'Region' => [
+ 'type' => 'string',
+ ],
+ 'FirmwareCreator' => [
+ 'type' => 'string',
+ ],
+ 'IsDeleted' => [
+ 'type' => 'string',
+ ],
+ 'FrmwareSize' => [
+ 'type' => 'integer',
+ 'format' => 'int32',
+ ],
+ 'GmtCreate' => [
+ 'type' => 'string',
+ ],
+ 'FirmwareDesc' => [
+ 'type' => 'string',
+ ],
+ 'ScrVersion' => [
+ 'type' => 'string',
+ ],
+ 'SignMethod' => [
+ 'type' => 'string',
+ ],
+ 'DestVersion' => [
+ 'type' => 'string',
+ ],
+ 'FirmwareId' => [
+ 'type' => 'integer',
+ 'format' => 'int64',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'errorCodes' => [],
+ 'responseDemo' => '',
+ ],
+ 'QueryFirmwareVerifyInfo' => [
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'systemTags' => [],
+ 'parameters' => [
+ [
+ 'name' => 'FirmwareName',
+ 'in' => 'query',
+ 'schema' => [
+ 'type' => 'string',
+ 'required' => true,
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'SucceedUpgradeDevice' => [
+ 'type' => 'integer',
+ 'format' => 'int32',
+ ],
+ 'ErrorMessage' => [
+ 'type' => 'string',
+ ],
+ 'RequestId' => [
+ 'type' => 'string',
+ ],
+ 'TotalUpgradeDevice' => [
+ 'type' => 'integer',
+ 'format' => 'int32',
+ ],
+ 'Success' => [
+ 'type' => 'boolean',
+ ],
+ 'Data' => [
+ 'type' => 'object',
+ 'itemNode' => true,
+ 'properties' => [
+ 'DeviceInfo' => [
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'ProductKey' => [
+ 'type' => 'string',
+ ],
+ 'DeviceName' => [
+ 'type' => 'string',
+ ],
+ 'FirmwareVersion' => [
+ 'type' => 'string',
+ ],
+ 'IotId' => [
+ 'type' => 'string',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'errorCodes' => [],
+ 'responseDemo' => '',
+ ],
+ 'QueryFirmwareByUid' => [
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'systemTags' => [],
+ 'parameters' => [
+ [
+ 'name' => 'PageSize',
+ 'in' => 'query',
+ 'schema' => [
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ ],
+ ],
+ [
+ 'name' => 'DeleteStatus',
+ 'in' => 'query',
+ 'schema' => [
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => true,
+ ],
+ ],
+ [
+ 'name' => 'CurrentPage',
+ 'in' => 'query',
+ 'schema' => [
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'type' => 'string',
+ ],
+ 'ErrorMessage' => [
+ 'type' => 'string',
+ ],
+ 'Success' => [
+ 'type' => 'boolean',
+ ],
+ 'PageSize' => [
+ 'type' => 'integer',
+ 'format' => 'int32',
+ ],
+ 'Total' => [
+ 'type' => 'integer',
+ 'format' => 'int32',
+ ],
+ 'PageCount' => [
+ 'type' => 'integer',
+ 'format' => 'int32',
+ ],
+ 'Page' => [
+ 'type' => 'integer',
+ 'format' => 'int32',
+ ],
+ 'Data' => [
+ 'type' => 'object',
+ 'itemNode' => true,
+ 'properties' => [
+ 'FirmwareInfo' => [
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Status' => [
+ 'type' => 'integer',
+ 'format' => 'int32',
+ ],
+ 'FirmwareUrl' => [
+ 'type' => 'string',
+ ],
+ 'FirmwareName' => [
+ 'type' => 'string',
+ ],
+ 'FirmwareSign' => [
+ 'type' => 'string',
+ ],
+ 'GmtModified' => [
+ 'type' => 'string',
+ ],
+ 'ProductKey' => [
+ 'type' => 'string',
+ ],
+ 'FirmwareModifier' => [
+ 'type' => 'string',
+ ],
+ 'FirmwareCreator' => [
+ 'type' => 'string',
+ ],
+ 'IsDeleted' => [
+ 'type' => 'string',
+ ],
+ 'GmtCreate' => [
+ 'type' => 'string',
+ ],
+ 'FrmwareSize' => [
+ 'type' => 'integer',
+ 'format' => 'int32',
+ ],
+ 'ScrVersion' => [
+ 'type' => 'string',
+ ],
+ 'FirmwareDesc' => [
+ 'type' => 'string',
+ ],
+ 'SignMethod' => [
+ 'type' => 'string',
+ ],
+ 'DestVersion' => [
+ 'type' => 'string',
+ ],
+ 'FirmwareId' => [
+ 'type' => 'integer',
+ 'format' => 'int64',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'errorCodes' => [],
+ 'responseDemo' => '',
+ ],
+ 'QueryFirmwareVersionById' => [
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'systemTags' => [],
+ 'parameters' => [
+ [
+ 'name' => 'FirmwareId',
+ 'in' => 'query',
+ 'schema' => [
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'type' => 'string',
+ ],
+ 'ErrorMessage' => [
+ 'type' => 'string',
+ ],
+ 'Success' => [
+ 'type' => 'boolean',
+ ],
+ 'Data' => [
+ 'type' => 'object',
+ 'itemNode' => true,
+ 'properties' => [
+ 'FirmwareVersion' => [
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'FirmwareVersion' => [
+ 'type' => 'string',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'errorCodes' => [],
+ 'responseDemo' => '',
+ ],
+ 'QueryVersionsByPk' => [
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'systemTags' => [],
+ 'parameters' => [
+ [
+ 'name' => 'ProductKey',
+ 'in' => 'query',
+ 'schema' => [
+ 'type' => 'string',
+ 'required' => true,
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'type' => 'string',
+ ],
+ 'ErrorMessage' => [
+ 'type' => 'string',
+ ],
+ 'Success' => [
+ 'type' => 'boolean',
+ ],
+ 'Data' => [
+ 'type' => 'object',
+ 'itemNode' => true,
+ 'properties' => [
+ 'DeviceInfo' => [
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'ProductKey' => [
+ 'type' => 'string',
+ ],
+ 'DeviceName' => [
+ 'type' => 'string',
+ ],
+ 'FirmwareVersion' => [
+ 'type' => 'string',
+ ],
+ 'IotId' => [
+ 'type' => 'string',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'errorCodes' => [],
+ 'responseDemo' => '',
+ ],
+ ],
+ 'endpoints' => [
+ [
+ 'regionId' => 'cn-beijing',
+ 'endpoint' => 'iot.cn-beijing.aliyuncs.com',
+ ],
+ [
+ 'regionId' => 'cn-shanghai',
+ 'endpoint' => 'iot.cn-shanghai.aliyuncs.com',
+ ],
+ [
+ 'regionId' => 'cn-shenzhen',
+ 'endpoint' => 'iot.cn-shenzhen.aliyuncs.com',
+ ],
+ [
+ 'regionId' => 'ap-northeast-1',
+ 'endpoint' => 'iot.ap-northeast-1.aliyuncs.com',
+ ],
+ [
+ 'regionId' => 'ap-southeast-1',
+ 'endpoint' => 'iot.ap-southeast-1.aliyuncs.com',
+ ],
+ [
+ 'regionId' => 'us-east-1',
+ 'endpoint' => 'iot.us-east-1.aliyuncs.com',
+ ],
+ [
+ 'regionId' => 'us-west-1',
+ 'endpoint' => 'iot.us-west-1.aliyuncs.com',
+ ],
+ [
+ 'regionId' => 'eu-central-1',
+ 'endpoint' => 'iot.eu-central-1.aliyuncs.com',
+ ],
+ ],
+];
generated by cgit v1.2.3 (git 2.46.0) at 2026-03-07 15:45:19 +0000