summaryrefslogtreecommitdiff
path: root/data/en_us/iot/2017-06-20
diff options
context:
space:
mode:
Diffstat (limited to 'data/en_us/iot/2017-06-20')
-rw-r--r--data/en_us/iot/2017-06-20/api-docs.php545
1 files changed, 123 insertions, 422 deletions
diff --git a/data/en_us/iot/2017-06-20/api-docs.php b/data/en_us/iot/2017-06-20/api-docs.php
index 3f31051..0a1d5bb 100644
--- a/data/en_us/iot/2017-06-20/api-docs.php
+++ b/data/en_us/iot/2017-06-20/api-docs.php
@@ -1,27 +1,12 @@
<?php return [
'version' => '1.0',
- 'info' => [
- 'style' => 'ROA',
- 'product' => 'Iot',
- 'version' => '2017-06-20',
- ],
+ 'info' => ['style' => 'ROA', 'product' => 'Iot', 'version' => '2017-06-20'],
'directories' => [
[
'id' => 0,
'title' => '其它',
'type' => 'directory',
- 'children' => [
- 'BatchGetDeviceState',
- 'GetDeviceShadow',
- 'GetCats',
- 'Pub',
- 'PubBroadcast',
- 'QueryApplyStatus',
- 'QueryDevice',
- 'QueryDeviceByName',
- 'RegistDevice',
- 'UpdateDeviceShadow',
- ],
+ 'children' => ['BatchGetDeviceState', 'GetDeviceShadow', 'GetCats', 'Pub', 'PubBroadcast', 'QueryApplyStatus', 'QueryDevice', 'QueryDeviceByName', 'RegistDevice', 'UpdateDeviceShadow'],
],
],
'components' => [
@@ -30,12 +15,8 @@
'apis' => [
'BatchGetDeviceState' => [
'path' => '/batchGetDeviceState/{ProductKey}',
- 'methods' => [
- 'get',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'methods' => ['get'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -46,10 +27,7 @@
[
'name' => 'ProductKey',
'in' => 'path',
- 'schema' => [
- 'type' => 'string',
- 'required' => true,
- ],
+ 'schema' => ['type' => 'string', 'required' => true],
],
[
'name' => 'DeviceName',
@@ -57,9 +35,7 @@
'style' => 'repeatList',
'schema' => [
'type' => 'array',
- 'items' => [
- 'type' => 'string',
- ],
+ 'items' => ['type' => 'string'],
'required' => true,
'maxItems' => 51,
],
@@ -70,15 +46,9 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'type' => 'string',
- ],
- 'ErrorMessage' => [
- 'type' => 'string',
- ],
- 'Success' => [
- 'type' => 'boolean',
- ],
+ 'RequestId' => ['type' => 'string'],
+ 'ErrorMessage' => ['type' => 'string'],
+ 'Success' => ['type' => 'boolean'],
'DeviceStatusList' => [
'type' => 'object',
'itemNode' => true,
@@ -88,21 +58,11 @@
'items' => [
'type' => 'object',
'properties' => [
- 'Status' => [
- 'type' => 'string',
- ],
- 'LastOnlineTime' => [
- 'type' => 'string',
- ],
- 'DeviceName' => [
- 'type' => 'string',
- ],
- 'AsAddress' => [
- 'type' => 'string',
- ],
- 'DeviceId' => [
- 'type' => 'string',
- ],
+ 'Status' => ['type' => 'string'],
+ 'LastOnlineTime' => ['type' => 'string'],
+ 'DeviceName' => ['type' => 'string'],
+ 'AsAddress' => ['type' => 'string'],
+ 'DeviceId' => ['type' => 'string'],
],
],
],
@@ -117,12 +77,8 @@
],
'GetDeviceShadow' => [
'path' => '/getDeviceShadow/{ProductKey}/{DeviceName}',
- 'methods' => [
- 'get',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'methods' => ['get'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -133,26 +89,17 @@
[
'name' => 'ProductKey',
'in' => 'path',
- 'schema' => [
- 'type' => 'string',
- 'required' => true,
- ],
+ 'schema' => ['type' => 'string', 'required' => true],
],
[
'name' => 'DeviceName',
'in' => 'path',
- 'schema' => [
- 'type' => 'string',
- 'required' => true,
- ],
+ 'schema' => ['type' => 'string', 'required' => true],
],
[
'name' => 'ShadowMessage',
'in' => 'query',
- 'schema' => [
- 'type' => 'string',
- 'required' => false,
- ],
+ 'schema' => ['type' => 'string', 'required' => false],
],
],
'responses' => [
@@ -160,18 +107,10 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'type' => 'string',
- ],
- 'ErrorMessage' => [
- 'type' => 'string',
- ],
- 'ShadowMessage' => [
- 'type' => 'string',
- ],
- 'Success' => [
- 'type' => 'boolean',
- ],
+ 'RequestId' => ['type' => 'string'],
+ 'ErrorMessage' => ['type' => 'string'],
+ 'ShadowMessage' => ['type' => 'string'],
+ 'Success' => ['type' => 'boolean'],
],
],
],
@@ -181,12 +120,8 @@
],
'GetCats' => [
'path' => '/getCats/{RootId}',
- 'methods' => [
- 'get',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'methods' => ['get'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -197,11 +132,7 @@
[
'name' => 'RootId',
'in' => 'path',
- 'schema' => [
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- ],
+ 'schema' => ['type' => 'integer', 'format' => 'int64', 'required' => true],
],
],
'responses' => [
@@ -209,28 +140,15 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'type' => 'string',
- ],
- 'ErrorMessage' => [
- 'type' => 'string',
- ],
- 'Success' => [
- 'type' => 'boolean',
- ],
+ 'RequestId' => ['type' => 'string'],
+ 'ErrorMessage' => ['type' => 'string'],
+ 'Success' => ['type' => 'boolean'],
'CatInfo' => [
'type' => 'object',
'properties' => [
- 'HasChild' => [
- 'type' => 'boolean',
- ],
- 'Name' => [
- 'type' => 'string',
- ],
- 'Id' => [
- 'type' => 'integer',
- 'format' => 'int64',
- ],
+ 'HasChild' => ['type' => 'boolean'],
+ 'Name' => ['type' => 'string'],
+ 'Id' => ['type' => 'integer', 'format' => 'int64'],
'Childs' => [
'type' => 'object',
'itemNode' => true,
@@ -240,16 +158,9 @@
'items' => [
'type' => 'object',
'properties' => [
- 'HasChild' => [
- 'type' => 'boolean',
- ],
- 'Name' => [
- 'type' => 'string',
- ],
- 'Id' => [
- 'type' => 'integer',
- 'format' => 'int64',
- ],
+ 'HasChild' => ['type' => 'boolean'],
+ 'Name' => ['type' => 'string'],
+ 'Id' => ['type' => 'integer', 'format' => 'int64'],
],
],
],
@@ -266,12 +177,8 @@
],
'Pub' => [
'path' => '/pub/{ProductKey}',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -282,10 +189,7 @@
[
'name' => 'ProductKey',
'in' => 'path',
- 'schema' => [
- 'type' => 'string',
- 'required' => true,
- ],
+ 'schema' => ['type' => 'string', 'required' => true],
],
[
'name' => 'Qos',
@@ -295,27 +199,18 @@
'format' => 'int32',
'required' => false,
'default' => '0',
- 'enum' => [
- '0',
- '1',
- ],
+ 'enum' => ['0', '1'],
],
],
[
'name' => 'TopicFullName',
'in' => 'query',
- 'schema' => [
- 'type' => 'string',
- 'required' => true,
- ],
+ 'schema' => ['type' => 'string', 'required' => true],
],
[
'name' => 'MessageContent',
'in' => 'formData',
- 'schema' => [
- 'type' => 'string',
- 'required' => true,
- ],
+ 'schema' => ['type' => 'string', 'required' => true],
],
],
'responses' => [
@@ -323,18 +218,10 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'MessageId' => [
- 'type' => 'string',
- ],
- 'RequestId' => [
- 'type' => 'string',
- ],
- 'ErrorMessage' => [
- 'type' => 'string',
- ],
- 'Success' => [
- 'type' => 'boolean',
- ],
+ 'MessageId' => ['type' => 'string'],
+ 'RequestId' => ['type' => 'string'],
+ 'ErrorMessage' => ['type' => 'string'],
+ 'Success' => ['type' => 'boolean'],
],
],
],
@@ -344,12 +231,8 @@
],
'PubBroadcast' => [
'path' => '/pubBroadcast/{ProductKey}',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -360,26 +243,17 @@
[
'name' => 'ProductKey',
'in' => 'path',
- 'schema' => [
- 'type' => 'string',
- 'required' => true,
- ],
+ 'schema' => ['type' => 'string', 'required' => true],
],
[
'name' => 'TopicFullName',
'in' => 'query',
- 'schema' => [
- 'type' => 'string',
- 'required' => false,
- ],
+ 'schema' => ['type' => 'string', 'required' => false],
],
[
'name' => 'MessageContent',
'in' => 'query',
- 'schema' => [
- 'type' => 'string',
- 'required' => true,
- ],
+ 'schema' => ['type' => 'string', 'required' => true],
],
],
'responses' => [
@@ -387,19 +261,10 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'MessageId' => [
- 'type' => 'integer',
- 'format' => 'int64',
- ],
- 'RequestId' => [
- 'type' => 'string',
- ],
- 'ErrorMessage' => [
- 'type' => 'string',
- ],
- 'Success' => [
- 'type' => 'boolean',
- ],
+ 'MessageId' => ['type' => 'integer', 'format' => 'int64'],
+ 'RequestId' => ['type' => 'string'],
+ 'ErrorMessage' => ['type' => 'string'],
+ 'Success' => ['type' => 'boolean'],
],
],
],
@@ -409,12 +274,8 @@
],
'QueryApplyStatus' => [
'path' => '/queryApplyStatus/{ApplyId}',
- 'methods' => [
- 'get',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'methods' => ['get'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -425,11 +286,7 @@
[
'name' => 'ApplyId',
'in' => 'path',
- 'schema' => [
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- ],
+ 'schema' => ['type' => 'integer', 'format' => 'int64', 'required' => true],
],
],
'responses' => [
@@ -437,18 +294,10 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'Finish' => [
- 'type' => 'boolean',
- ],
- 'RequestId' => [
- 'type' => 'string',
- ],
- 'ErrorMessage' => [
- 'type' => 'string',
- ],
- 'Success' => [
- 'type' => 'boolean',
- ],
+ 'Finish' => ['type' => 'boolean'],
+ 'RequestId' => ['type' => 'string'],
+ 'ErrorMessage' => ['type' => 'string'],
+ 'Success' => ['type' => 'boolean'],
],
],
],
@@ -458,12 +307,8 @@
],
'QueryDevice' => [
'path' => '/queryDevice/{ProductKey}',
- 'methods' => [
- 'get',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'methods' => ['get'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -474,28 +319,17 @@
[
'name' => 'PageSize',
'in' => 'query',
- 'schema' => [
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- ],
+ 'schema' => ['type' => 'integer', 'format' => 'int32', 'required' => false],
],
[
'name' => 'ProductKey',
'in' => 'path',
- 'schema' => [
- 'type' => 'string',
- 'required' => true,
- ],
+ 'schema' => ['type' => 'string', 'required' => true],
],
[
'name' => 'CurrentPage',
'in' => 'query',
- 'schema' => [
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- ],
+ 'schema' => ['type' => 'integer', 'format' => 'int32', 'required' => false],
],
],
'responses' => [
@@ -503,31 +337,13 @@
'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',
- ],
+ '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,
@@ -537,30 +353,14 @@
'items' => [
'type' => 'object',
'properties' => [
- 'ProductKey' => [
- 'type' => 'string',
- ],
- 'DeviceName' => [
- 'type' => 'string',
- ],
- 'DeviceId' => [
- 'type' => 'string',
- ],
- 'DeviceType' => [
- 'type' => 'string',
- ],
- 'DeviceSecret' => [
- 'type' => 'string',
- ],
- 'GmtCreate' => [
- 'type' => 'string',
- ],
- 'DeviceStatus' => [
- 'type' => 'string',
- ],
- 'GmtModified' => [
- 'type' => 'string',
- ],
+ 'ProductKey' => ['type' => 'string'],
+ 'DeviceName' => ['type' => 'string'],
+ 'DeviceId' => ['type' => 'string'],
+ 'DeviceType' => ['type' => 'string'],
+ 'DeviceSecret' => ['type' => 'string'],
+ 'GmtCreate' => ['type' => 'string'],
+ 'DeviceStatus' => ['type' => 'string'],
+ 'GmtModified' => ['type' => 'string'],
],
],
],
@@ -575,12 +375,8 @@
],
'QueryDeviceByName' => [
'path' => '/queryDeviceByName/{DeviceName}/{ProductKey}',
- 'methods' => [
- 'get',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'methods' => ['get'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -591,18 +387,12 @@
[
'name' => 'ProductKey',
'in' => 'path',
- 'schema' => [
- 'type' => 'string',
- 'required' => true,
- ],
+ 'schema' => ['type' => 'string', 'required' => true],
],
[
'name' => 'DeviceName',
'in' => 'path',
- 'schema' => [
- 'type' => 'string',
- 'required' => true,
- ],
+ 'schema' => ['type' => 'string', 'required' => true],
],
],
'responses' => [
@@ -610,42 +400,20 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'type' => 'string',
- ],
- 'ErrorMessage' => [
- 'type' => 'string',
- ],
- 'Success' => [
- 'type' => 'boolean',
- ],
+ 'RequestId' => ['type' => 'string'],
+ 'ErrorMessage' => ['type' => 'string'],
+ 'Success' => ['type' => 'boolean'],
'DeviceInfo' => [
'type' => 'object',
'properties' => [
- 'ProductKey' => [
- 'type' => 'string',
- ],
- 'DeviceName' => [
- 'type' => 'string',
- ],
- 'DeviceId' => [
- 'type' => 'string',
- ],
- 'DeviceType' => [
- 'type' => 'string',
- ],
- 'DeviceSecret' => [
- 'type' => 'string',
- ],
- 'GmtCreate' => [
- 'type' => 'string',
- ],
- 'DeviceStatus' => [
- 'type' => 'string',
- ],
- 'GmtModified' => [
- 'type' => 'string',
- ],
+ 'ProductKey' => ['type' => 'string'],
+ 'DeviceName' => ['type' => 'string'],
+ 'DeviceId' => ['type' => 'string'],
+ 'DeviceType' => ['type' => 'string'],
+ 'DeviceSecret' => ['type' => 'string'],
+ 'GmtCreate' => ['type' => 'string'],
+ 'DeviceStatus' => ['type' => 'string'],
+ 'GmtModified' => ['type' => 'string'],
],
],
],
@@ -657,12 +425,8 @@
],
'RegistDevice' => [
'path' => '/registDevice/{ProductKey}',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -673,18 +437,12 @@
[
'name' => 'ProductKey',
'in' => 'path',
- 'schema' => [
- 'type' => 'string',
- 'required' => true,
- ],
+ 'schema' => ['type' => 'string', 'required' => true],
],
[
'name' => 'DeviceName',
'in' => 'query',
- 'schema' => [
- 'type' => 'string',
- 'required' => false,
- ],
+ 'schema' => ['type' => 'string', 'required' => false],
],
],
'responses' => [
@@ -692,27 +450,13 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'type' => 'string',
- ],
- 'ErrorMessage' => [
- 'type' => 'string',
- ],
- 'DeviceName' => [
- 'type' => 'string',
- ],
- 'Success' => [
- 'type' => 'boolean',
- ],
- 'DeviceId' => [
- 'type' => 'string',
- ],
- 'DeviceSecret' => [
- 'type' => 'string',
- ],
- 'DeviceStatus' => [
- 'type' => 'string',
- ],
+ 'RequestId' => ['type' => 'string'],
+ 'ErrorMessage' => ['type' => 'string'],
+ 'DeviceName' => ['type' => 'string'],
+ 'Success' => ['type' => 'boolean'],
+ 'DeviceId' => ['type' => 'string'],
+ 'DeviceSecret' => ['type' => 'string'],
+ 'DeviceStatus' => ['type' => 'string'],
],
],
],
@@ -722,12 +466,8 @@
],
'UpdateDeviceShadow' => [
'path' => '/updateDeviceShadow/{ProductKey}/{DeviceName}',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -738,26 +478,17 @@
[
'name' => 'ProductKey',
'in' => 'path',
- 'schema' => [
- 'type' => 'string',
- 'required' => true,
- ],
+ 'schema' => ['type' => 'string', 'required' => true],
],
[
'name' => 'DeviceName',
'in' => 'path',
- 'schema' => [
- 'type' => 'string',
- 'required' => true,
- ],
+ 'schema' => ['type' => 'string', 'required' => true],
],
[
'name' => 'ShadowMessage',
'in' => 'query',
- 'schema' => [
- 'type' => 'string',
- 'required' => true,
- ],
+ 'schema' => ['type' => 'string', 'required' => true],
],
],
'responses' => [
@@ -765,15 +496,9 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'type' => 'string',
- ],
- 'ErrorMessage' => [
- 'type' => 'string',
- ],
- 'Success' => [
- 'type' => 'boolean',
- ],
+ 'RequestId' => ['type' => 'string'],
+ 'ErrorMessage' => ['type' => 'string'],
+ 'Success' => ['type' => 'boolean'],
],
],
],
@@ -783,37 +508,13 @@
],
],
'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',
- ],
+ ['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-07-12 23:42:04 +0000