first commitHEADv1.0.0+20260212main

1 files changed, 819 insertions, 0 deletions

diff --git a/data/zh_cn/iot/2017-06-20/api-docs.php b/data/zh_cn/iot/2017-06-20/api-docs.php
new file mode 100644
index 0000000..fae38c7
--- /dev/null
+++ b/data/zh_cn/iot/2017-06-20/api-docs.php
@@ -0,0 +1,819 @@
+<?php return [
+    'version' => '1.0',
+    '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',
+            ],
+        ],
+    ],
+    'components' => [
+        'schemas' => [],
+    ],
+    'apis' => [
+        'BatchGetDeviceState' => [
+            'path' => '/batchGetDeviceState/{ProductKey}',
+            'methods' => [
+                'get',
+            ],
+            'schemes' => [
+                'https',
+            ],
+            'security' => [
+                [
+                    'AK' => [],
+                ],
+            ],
+            'systemTags' => [],
+            'parameters' => [
+                [
+                    'name' => 'ProductKey',
+                    'in' => 'path',
+                    'schema' => [
+                        'type' => 'string',
+                        'required' => true,
+                    ],
+                ],
+                [
+                    'name' => 'DeviceName',
+                    'in' => 'query',
+                    'style' => 'repeatList',
+                    'schema' => [
+                        'type' => 'array',
+                        'items' => [
+                            'type' => 'string',
+                        ],
+                        'required' => true,
+                        'maxItems' => 51,
+                    ],
+                ],
+            ],
+            'responses' => [
+                200 => [
+                    'schema' => [
+                        'type' => 'object',
+                        'properties' => [
+                            'RequestId' => [
+                                'type' => 'string',
+                            ],
+                            'ErrorMessage' => [
+                                'type' => 'string',
+                            ],
+                            'Success' => [
+                                'type' => 'boolean',
+                            ],
+                            'DeviceStatusList' => [
+                                'type' => 'object',
+                                'itemNode' => true,
+                                'properties' => [
+                                    'DeviceStatus' => [
+                                        'type' => 'array',
+                                        'items' => [
+                                            'type' => 'object',
+                                            'properties' => [
+                                                'Status' => [
+                                                    'type' => 'string',
+                                                ],
+                                                'LastOnlineTime' => [
+                                                    'type' => 'string',
+                                                ],
+                                                'DeviceName' => [
+                                                    'type' => 'string',
+                                                ],
+                                                'AsAddress' => [
+                                                    'type' => 'string',
+                                                ],
+                                                'DeviceId' => [
+                                                    'type' => 'string',
+                                                ],
+                                            ],
+                                        ],
+                                    ],
+                                ],
+                            ],
+                        ],
+                    ],
+                ],
+            ],
+            'errorCodes' => [],
+            'responseDemo' => '',
+        ],
+        'GetDeviceShadow' => [
+            'path' => '/getDeviceShadow/{ProductKey}/{DeviceName}',
+            'methods' => [
+                'get',
+            ],
+            'schemes' => [
+                'https',
+            ],
+            'security' => [
+                [
+                    'AK' => [],
+                ],
+            ],
+            'systemTags' => [],
+            'parameters' => [
+                [
+                    'name' => 'ProductKey',
+                    'in' => 'path',
+                    'schema' => [
+                        'type' => 'string',
+                        'required' => true,
+                    ],
+                ],
+                [
+                    'name' => 'DeviceName',
+                    'in' => 'path',
+                    'schema' => [
+                        'type' => 'string',
+                        'required' => true,
+                    ],
+                ],
+                [
+                    'name' => 'ShadowMessage',
+                    'in' => 'query',
+                    'schema' => [
+                        'type' => 'string',
+                        'required' => false,
+                    ],
+                ],
+            ],
+            'responses' => [
+                200 => [
+                    'schema' => [
+                        'type' => 'object',
+                        'properties' => [
+                            'RequestId' => [
+                                'type' => 'string',
+                            ],
+                            'ErrorMessage' => [
+                                'type' => 'string',
+                            ],
+                            'ShadowMessage' => [
+                                'type' => 'string',
+                            ],
+                            'Success' => [
+                                'type' => 'boolean',
+                            ],
+                        ],
+                    ],
+                ],
+            ],
+            'errorCodes' => [],
+            'responseDemo' => '',
+        ],
+        'GetCats' => [
+            'path' => '/getCats/{RootId}',
+            'methods' => [
+                'get',
+            ],
+            'schemes' => [
+                'https',
+            ],
+            'security' => [
+                [
+                    'AK' => [],
+                ],
+            ],
+            'systemTags' => [],
+            'parameters' => [
+                [
+                    'name' => 'RootId',
+                    'in' => 'path',
+                    'schema' => [
+                        'type' => 'integer',
+                        'format' => 'int64',
+                        'required' => true,
+                    ],
+                ],
+            ],
+            'responses' => [
+                200 => [
+                    'schema' => [
+                        'type' => 'object',
+                        'properties' => [
+                            'RequestId' => [
+                                'type' => 'string',
+                            ],
+                            'ErrorMessage' => [
+                                'type' => 'string',
+                            ],
+                            'Success' => [
+                                'type' => 'boolean',
+                            ],
+                            'CatInfo' => [
+                                'type' => 'object',
+                                'properties' => [
+                                    'HasChild' => [
+                                        'type' => 'boolean',
+                                    ],
+                                    'Name' => [
+                                        'type' => 'string',
+                                    ],
+                                    'Id' => [
+                                        'type' => 'integer',
+                                        'format' => 'int64',
+                                    ],
+                                    'Childs' => [
+                                        'type' => 'object',
+                                        'itemNode' => true,
+                                        'properties' => [
+                                            'ChildCat' => [
+                                                'type' => 'array',
+                                                'items' => [
+                                                    'type' => 'object',
+                                                    'properties' => [
+                                                        'HasChild' => [
+                                                            'type' => 'boolean',
+                                                        ],
+                                                        'Name' => [
+                                                            'type' => 'string',
+                                                        ],
+                                                        'Id' => [
+                                                            'type' => 'integer',
+                                                            'format' => 'int64',
+                                                        ],
+                                                    ],
+                                                ],
+                                            ],
+                                        ],
+                                    ],
+                                ],
+                            ],
+                        ],
+                    ],
+                ],
+            ],
+            'errorCodes' => [],
+            'responseDemo' => '',
+        ],
+        'Pub' => [
+            'path' => '/pub/{ProductKey}',
+            'methods' => [
+                'post',
+            ],
+            'schemes' => [
+                'https',
+            ],
+            'security' => [
+                [
+                    'AK' => [],
+                ],
+            ],
+            'systemTags' => [],
+            'parameters' => [
+                [
+                    'name' => 'ProductKey',
+                    'in' => 'path',
+                    'schema' => [
+                        'type' => 'string',
+                        'required' => true,
+                    ],
+                ],
+                [
+                    'name' => 'Qos',
+                    'in' => 'query',
+                    'schema' => [
+                        'type' => 'integer',
+                        'format' => 'int32',
+                        'required' => false,
+                        'default' => '0',
+                        'enum' => [
+                            '0',
+                            '1',
+                        ],
+                    ],
+                ],
+                [
+                    'name' => 'TopicFullName',
+                    'in' => 'query',
+                    'schema' => [
+                        'type' => 'string',
+                        'required' => true,
+                    ],
+                ],
+                [
+                    'name' => 'MessageContent',
+                    'in' => 'formData',
+                    'schema' => [
+                        'type' => 'string',
+                        'required' => true,
+                    ],
+                ],
+            ],
+            'responses' => [
+                200 => [
+                    'schema' => [
+                        'type' => 'object',
+                        'properties' => [
+                            'MessageId' => [
+                                'type' => 'string',
+                            ],
+                            'RequestId' => [
+                                'type' => 'string',
+                            ],
+                            'ErrorMessage' => [
+                                'type' => 'string',
+                            ],
+                            'Success' => [
+                                'type' => 'boolean',
+                            ],
+                        ],
+                    ],
+                ],
+            ],
+            'errorCodes' => [],
+            'responseDemo' => '',
+        ],
+        'PubBroadcast' => [
+            'path' => '/pubBroadcast/{ProductKey}',
+            'methods' => [
+                'post',
+            ],
+            'schemes' => [
+                'https',
+            ],
+            'security' => [
+                [
+                    'AK' => [],
+                ],
+            ],
+            'systemTags' => [],
+            'parameters' => [
+                [
+                    'name' => 'ProductKey',
+                    'in' => 'path',
+                    'schema' => [
+                        'type' => 'string',
+                        'required' => true,
+                    ],
+                ],
+                [
+                    'name' => 'TopicFullName',
+                    'in' => 'query',
+                    'schema' => [
+                        'type' => 'string',
+                        'required' => false,
+                    ],
+                ],
+                [
+                    'name' => 'MessageContent',
+                    'in' => 'query',
+                    'schema' => [
+                        'type' => 'string',
+                        'required' => true,
+                    ],
+                ],
+            ],
+            'responses' => [
+                200 => [
+                    'schema' => [
+                        'type' => 'object',
+                        'properties' => [
+                            'MessageId' => [
+                                'type' => 'integer',
+                                'format' => 'int64',
+                            ],
+                            'RequestId' => [
+                                'type' => 'string',
+                            ],
+                            'ErrorMessage' => [
+                                'type' => 'string',
+                            ],
+                            'Success' => [
+                                'type' => 'boolean',
+                            ],
+                        ],
+                    ],
+                ],
+            ],
+            'errorCodes' => [],
+            'responseDemo' => '',
+        ],
+        'QueryApplyStatus' => [
+            'path' => '/queryApplyStatus/{ApplyId}',
+            'methods' => [
+                'get',
+            ],
+            'schemes' => [
+                'https',
+            ],
+            'security' => [
+                [
+                    'AK' => [],
+                ],
+            ],
+            'systemTags' => [],
+            'parameters' => [
+                [
+                    'name' => 'ApplyId',
+                    'in' => 'path',
+                    'schema' => [
+                        'type' => 'integer',
+                        'format' => 'int64',
+                        'required' => true,
+                    ],
+                ],
+            ],
+            'responses' => [
+                200 => [
+                    'schema' => [
+                        'type' => 'object',
+                        'properties' => [
+                            'Finish' => [
+                                'type' => 'boolean',
+                            ],
+                            'RequestId' => [
+                                'type' => 'string',
+                            ],
+                            'ErrorMessage' => [
+                                'type' => 'string',
+                            ],
+                            'Success' => [
+                                'type' => 'boolean',
+                            ],
+                        ],
+                    ],
+                ],
+            ],
+            'errorCodes' => [],
+            'responseDemo' => '',
+        ],
+        'QueryDevice' => [
+            'path' => '/queryDevice/{ProductKey}',
+            'methods' => [
+                'get',
+            ],
+            'schemes' => [
+                'https',
+            ],
+            'security' => [
+                [
+                    'AK' => [],
+                ],
+            ],
+            'systemTags' => [],
+            'parameters' => [
+                [
+                    'name' => 'PageSize',
+                    'in' => 'query',
+                    'schema' => [
+                        'type' => 'integer',
+                        'format' => 'int32',
+                        'required' => false,
+                    ],
+                ],
+                [
+                    'name' => 'ProductKey',
+                    'in' => 'path',
+                    'schema' => [
+                        'type' => 'string',
+                        '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' => [
+                                    'DeviceInfo' => [
+                                        'type' => 'array',
+                                        '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',
+                                                ],
+                                            ],
+                                        ],
+                                    ],
+                                ],
+                            ],
+                        ],
+                    ],
+                ],
+            ],
+            'errorCodes' => [],
+            'responseDemo' => '',
+        ],
+        'QueryDeviceByName' => [
+            'path' => '/queryDeviceByName/{DeviceName}/{ProductKey}',
+            'methods' => [
+                'get',
+            ],
+            'schemes' => [
+                'https',
+            ],
+            'security' => [
+                [
+                    'AK' => [],
+                ],
+            ],
+            'systemTags' => [],
+            'parameters' => [
+                [
+                    'name' => 'ProductKey',
+                    'in' => 'path',
+                    'schema' => [
+                        'type' => 'string',
+                        'required' => true,
+                    ],
+                ],
+                [
+                    'name' => 'DeviceName',
+                    'in' => 'path',
+                    'schema' => [
+                        'type' => 'string',
+                        'required' => true,
+                    ],
+                ],
+            ],
+            'responses' => [
+                200 => [
+                    'schema' => [
+                        'type' => 'object',
+                        'properties' => [
+                            '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',
+                                    ],
+                                ],
+                            ],
+                        ],
+                    ],
+                ],
+            ],
+            'errorCodes' => [],
+            'responseDemo' => '',
+        ],
+        'RegistDevice' => [
+            'path' => '/registDevice/{ProductKey}',
+            'methods' => [
+                'post',
+            ],
+            'schemes' => [
+                'https',
+            ],
+            'security' => [
+                [
+                    'AK' => [],
+                ],
+            ],
+            'systemTags' => [],
+            'parameters' => [
+                [
+                    'name' => 'ProductKey',
+                    'in' => 'path',
+                    'schema' => [
+                        'type' => 'string',
+                        'required' => true,
+                    ],
+                ],
+                [
+                    'name' => 'DeviceName',
+                    'in' => 'query',
+                    'schema' => [
+                        'type' => 'string',
+                        'required' => false,
+                    ],
+                ],
+            ],
+            'responses' => [
+                200 => [
+                    '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',
+                            ],
+                        ],
+                    ],
+                ],
+            ],
+            'errorCodes' => [],
+            'responseDemo' => '',
+        ],
+        'UpdateDeviceShadow' => [
+            'path' => '/updateDeviceShadow/{ProductKey}/{DeviceName}',
+            'methods' => [
+                'post',
+            ],
+            'schemes' => [
+                'https',
+            ],
+            'security' => [
+                [
+                    'AK' => [],
+                ],
+            ],
+            'systemTags' => [],
+            'parameters' => [
+                [
+                    'name' => 'ProductKey',
+                    'in' => 'path',
+                    'schema' => [
+                        'type' => 'string',
+                        'required' => true,
+                    ],
+                ],
+                [
+                    'name' => 'DeviceName',
+                    'in' => 'path',
+                    'schema' => [
+                        'type' => 'string',
+                        'required' => true,
+                    ],
+                ],
+                [
+                    'name' => 'ShadowMessage',
+                    'in' => 'query',
+                    'schema' => [
+                        'type' => 'string',
+                        'required' => true,
+                    ],
+                ],
+            ],
+            'responses' => [
+                200 => [
+                    'schema' => [
+                        'type' => 'object',
+                        'properties' => [
+                            'RequestId' => [
+                                'type' => 'string',
+                            ],
+                            'ErrorMessage' => [
+                                'type' => 'string',
+                            ],
+                            'Success' => [
+                                'type' => 'boolean',
+                            ],
+                        ],
+                    ],
+                ],
+            ],
+            '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',
+        ],
+    ],
+];