summaryrefslogtreecommitdiff
path: root/data/en_us/elasticsearch/2019-04-22/api-docs.php
blob: f65b200fff8a5d20dc1e827a37eb79ebe1493dd6 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
<?php return [
    'version' => '1.0',
    'info' => ['style' => 'RPC', 'product' => 'elasticsearch', 'version' => '2019-04-22'],
    'directories' => [
        [
            'id' => 62994,
            'title' => null,
            'type' => 'directory',
            'children' => ['DescribeVSwitches'],
        ],
        [
            'id' => 62996,
            'title' => null,
            'type' => 'directory',
            'children' => ['DescribeVpcs'],
        ],
    ],
    'components' => [
        'schemas' => [],
    ],
    'apis' => [
        'DescribeVSwitches' => [
            'summary' => '获取用户交换机列表',
            'methods' => ['post', 'get'],
            'schemes' => ['http', 'https'],
            'security' => [
                [
                    'AK' => [],
                ],
            ],
            'operationType' => 'read',
            'systemTags' => [
                'operationType' => 'get',
                'riskType' => 'none',
                'chargeType' => 'free',
                'abilityTreeCode' => '64424',
                'abilityTreeNodes' => ['FEATUREelasticsearchFBYZT8'],
            ],
            'parameters' => [
                [
                    'name' => 'RegionId',
                    'in' => 'query',
                    'schema' => ['description' => '', 'docRequired' => true, 'example' => 'cn-hangzhou', 'required' => false, 'title' => '交换机所属区域id', 'type' => 'string'],
                ],
                [
                    'name' => 'VpcId',
                    'in' => 'query',
                    'schema' => ['description' => '', 'example' => 'vpc-25cdvfeq58pl****', 'required' => false, 'title' => '要查询的交换机所属VPC的ID。', 'type' => 'string'],
                ],
                [
                    'name' => 'PageNumber',
                    'in' => 'query',
                    'schema' => ['description' => '', 'example' => '1', 'format' => 'int32', 'maximum' => '100', 'minimum' => '1', 'required' => false, 'title' => '列表的页码', 'type' => 'integer', 'default' => '1'],
                ],
                [
                    'name' => 'PageSize',
                    'in' => 'query',
                    'schema' => ['description' => '', 'example' => '10', 'format' => 'int32', 'maximum' => '50', 'minimum' => '1', 'required' => false, 'title' => '分页查询时每页的行数', 'type' => 'integer', 'default' => '50'],
                ],
                [
                    'name' => 'ZoneId',
                    'in' => 'query',
                    'schema' => ['description' => '', 'example' => 'cn-hangzhou-d', 'required' => false, 'title' => '要查询的交换机的ID。', 'type' => 'string'],
                ],
            ],
            'responses' => [
                200 => [
                    'schema' => [
                        'properties' => [
                            'RequestId' => ['description' => '', 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83B', 'type' => 'string'],
                            'VSwitches' => [
                                'description' => '',
                                'properties' => [
                                    'VSwitch' => [
                                        'description' => '',
                                        'items' => [
                                            'properties' => [
                                                'Status' => [
                                                    'description' => '',
                                                    'example' => 'Available',
                                                    'title' => '交换机的状态,取值:'."\n"
                                                        .'Pending:配置中。'."\n"
                                                        .'Available:可用。',
                                                    'type' => 'string',
                                                    'enum' => [],
                                                ],
                                                'VSwitchId' => ['description' => '', 'example' => 'vsw-25bcdxs7pv1****', 'title' => '交换机的ID。', 'type' => 'string'],
                                                'IsDefault' => ['description' => '', 'example' => 'true', 'title' => '是否是默认交换机。取值:'."\n"
                                                    .'true:是默认交换机。'."\n"
                                                    .'false:非默认交换机。', 'type' => 'boolean'],
                                                'CidrBlock' => ['description' => '', 'example' => '172.16.0.0/24', 'title' => '交换机的IPv4网段。', 'type' => 'string'],
                                                'GmtCreate' => ['description' => '', 'example' => '2022-01-18T12:43:57Z', 'title' => '交换机的创建时间。', 'type' => 'string'],
                                                'VSwitchName' => ['description' => '', 'example' => 'vswitch', 'title' => '交换机的名称。', 'type' => 'string'],
                                            ],
                                            'type' => 'object',
                                        ],
                                        'title' => '交换机数据结构体。',
                                        'type' => 'array',
                                    ],
                                ],
                                'title' => '交换机数组结果',
                                'type' => 'object',
                            ],
                        ],
                        'type' => 'object',
                    ],
                ],
            ],
            'responseDemo' => '[{"type":"json","example":"{\\n  \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83B\\",\\n  \\"VSwitches\\": {\\n    \\"VSwitch\\": [\\n      {\\n        \\"Status\\": \\"Available\\",\\n        \\"VSwitchId\\": \\"vsw-25bcdxs7pv1****\\",\\n        \\"IsDefault\\": true,\\n        \\"CidrBlock\\": \\"172.16.0.0/24\\",\\n        \\"GmtCreate\\": \\"2022-01-18T12:43:57Z\\",\\n        \\"VSwitchName\\": \\"vswitch\\"\\n      }\\n    ]\\n  }\\n}","errorExample":""},{"type":"xml","example":"<DescribeVSwitchesResponse>\\n    <RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83B</RequestId>\\n    <VSwitches>\\n        <VSwitch>\\n            <Status>Available</Status>\\n            <VSwitchId>vsw-25bcdxs7pv1****</VSwitchId>\\n            <IsDefault>true</IsDefault>\\n            <CidrBlock>172.16.0.0/24</CidrBlock>\\n            <GmtCreate>2022-01-18T12:43:57Z</GmtCreate>\\n            <VSwitchName>vswitch</VSwitchName>\\n        </VSwitch>\\n    </VSwitches>\\n</DescribeVSwitchesResponse>","errorExample":""}]',
            'title' => 'DescribeVSwitches',
        ],
        'DescribeVpcs' => [
            'summary' => 'VPC列表',
            'methods' => ['post', 'get'],
            'schemes' => ['http', 'https'],
            'security' => [
                [
                    'AK' => [],
                ],
            ],
            'operationType' => 'read',
            'deprecated' => false,
            'systemTags' => [
                'operationType' => 'get',
                'riskType' => 'none',
                'chargeType' => 'free',
                'abilityTreeCode' => '64423',
                'abilityTreeNodes' => ['FEATUREelasticsearchGHNE3U'],
            ],
            'parameters' => [
                [
                    'name' => 'RegionId',
                    'in' => 'query',
                    'schema' => ['description' => '', 'docRequired' => true, 'example' => 'cn-hangzhou', 'required' => false, 'title' => '区域ID', 'type' => 'string'],
                ],
                [
                    'name' => 'ZoneId',
                    'in' => 'query',
                    'schema' => ['description' => '', 'example' => 'cn-hangzhou-d', 'required' => false, 'title' => '可用区Id', 'type' => 'string'],
                ],
                [
                    'name' => 'PageNumber',
                    'in' => 'query',
                    'schema' => ['description' => '', 'example' => '1', 'format' => 'int32', 'minimum' => '1', 'required' => false, 'title' => '分页查询页码', 'type' => 'integer', 'default' => '1'],
                ],
                [
                    'name' => 'PageSize',
                    'in' => 'query',
                    'schema' => ['description' => '', 'example' => '50', 'format' => 'int32', 'required' => false, 'title' => '分页查询每页大小', 'type' => 'integer', 'default' => '50'],
                ],
            ],
            'responses' => [
                200 => [
                    'schema' => [
                        'properties' => [
                            'RequestId' => ['description' => '', 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0FE2C83B', 'title' => '唯一请求ID', 'type' => 'string'],
                            'Vpcs' => [
                                'description' => '',
                                'properties' => [
                                    'Vpc' => [
                                        'description' => '',
                                        'items' => [
                                            'description' => '',
                                            'properties' => [
                                                'VpcId' => ['description' => '', 'example' => 'vpc-bp1qpo0kug3a20qqe****', 'title' => 'vpc唯一标识', 'type' => 'string'],
                                                'VpcName' => ['description' => '', 'example' => 'vpc1', 'title' => 'vpc名称', 'type' => 'string'],
                                                'Status' => [
                                                    'description' => '',
                                                    'example' => 'Available',
                                                    'title' => 'VPC的状态,取值:'."\n"
                                                        .'Pending:配置中。'."\n"
                                                        .'Available:可用。',
                                                    'type' => 'string',
                                                    'enum' => [],
                                                ],
                                                'IsDefault' => ['description' => '', 'example' => 'true', 'title' => '是否是该地域的默认VPC', 'type' => 'boolean'],
                                                'CidrBlock' => ['description' => '', 'example' => '192.168.0.0/16', 'title' => 'VPC的IPv4网段。', 'type' => 'string'],
                                                'RegionNo' => ['description' => '', 'example' => 'cn-hangzhou', 'title' => 'VPC所在的地域ID。', 'type' => 'string'],
                                                'GmtCreate' => ['description' => '', 'example' => '2021-04-18T15:02:37Z', 'title' => 'VPC的创建时间。', 'type' => 'string'],
                                                'GmtModified' => ['description' => '', 'example' => '2021-04-18T15:02:37Z', 'title' => 'VPC的修改时间。', 'type' => 'string'],
                                                'VSwitchs' => [
                                                    'description' => '',
                                                    'items' => ['description' => '', 'example' => 'vsw-bp1nhbnpv2blyz8dl****', 'title' => 'vpc交换机标识', 'type' => 'string'],
                                                    'title' => '查询到的VPC中交换机的列表信息。最多可以查询到VPC中最近创建的300个交换机的信息',
                                                    'type' => 'array',
                                                ],
                                            ],
                                            'title' => '',
                                            'type' => 'object',
                                        ],
                                        'title' => '单个vpc信息',
                                        'type' => 'array',
                                    ],
                                ],
                                'title' => '返回结果,vpc集合',
                                'type' => 'object',
                            ],
                        ],
                        'type' => 'object',
                    ],
                ],
            ],
            'responseDemo' => '[{"type":"json","example":"{\\n  \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0FE2C83B\\",\\n  \\"Vpcs\\": {\\n    \\"Vpc\\": [\\n      {\\n        \\"VpcId\\": \\"vpc-bp1qpo0kug3a20qqe****\\",\\n        \\"VpcName\\": \\"vpc1\\",\\n        \\"Status\\": \\"Available\\",\\n        \\"IsDefault\\": true,\\n        \\"CidrBlock\\": \\"192.168.0.0/16\\",\\n        \\"RegionNo\\": \\"cn-hangzhou\\",\\n        \\"GmtCreate\\": \\"2021-04-18T15:02:37Z\\",\\n        \\"GmtModified\\": \\"2021-04-18T15:02:37Z\\",\\n        \\"VSwitchs\\": [\\n          \\"vsw-bp1nhbnpv2blyz8dl****\\"\\n        ]\\n      }\\n    ]\\n  }\\n}","errorExample":""},{"type":"xml","example":"<DescribeVpcsResponse>\\n    <RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0FE2C83B</RequestId>\\n    <Vpcs>\\n        <Vpc>\\n            <VpcId>vpc-bp1qpo0kug3a20qqe****</VpcId>\\n            <VpcName>vpc1</VpcName>\\n            <Status>Available</Status>\\n            <IsDefault>true</IsDefault>\\n            <CidrBlock>192.168.0.0/16</CidrBlock>\\n            <RegionNo>cn-hangzhou</RegionNo>\\n            <GmtCreate>2021-04-18T15:02:37Z</GmtCreate>\\n            <GmtModified>2021-04-18T15:02:37Z</GmtModified>\\n            <VSwitchs>vsw-bp1nhbnpv2blyz8dl****</VSwitchs>\\n        </Vpc>\\n    </Vpcs>\\n</DescribeVpcsResponse>","errorExample":""}]',
            'title' => 'DescribeVpcs',
        ],
    ],
    'endpoints' => [
        ['regionId' => 'cn-qingdao', 'endpoint' => 'elasticsearch.cn-qingdao.aliyuncs.com'],
        ['regionId' => 'cn-beijing', 'endpoint' => 'elasticsearch.cn-beijing.aliyuncs.com'],
        ['regionId' => 'cn-zhangjiakou', 'endpoint' => 'elasticsearch.cn-zhangjiakou.aliyuncs.com'],
        ['regionId' => 'cn-hangzhou', 'endpoint' => 'elasticsearch.cn-hangzhou.aliyuncs.com'],
        ['regionId' => 'cn-shanghai', 'endpoint' => 'elasticsearch.cn-shanghai.aliyuncs.com'],
        ['regionId' => 'cn-shenzhen', 'endpoint' => 'elasticsearch.cn-shenzhen.aliyuncs.com'],
        ['regionId' => 'cn-hongkong', 'endpoint' => 'elasticsearch.cn-hongkong.aliyuncs.com'],
        ['regionId' => 'ap-southeast-1', 'endpoint' => 'elasticsearch.ap-southeast-1.aliyuncs.com'],
        ['regionId' => 'ap-southeast-2', 'endpoint' => 'elasticsearch.ap-southeast-2.aliyuncs.com'],
        ['regionId' => 'ap-southeast-3', 'endpoint' => 'elasticsearch.ap-southeast-3.aliyuncs.com'],
        ['regionId' => 'ap-southeast-5', 'endpoint' => 'elasticsearch.ap-southeast-5.aliyuncs.com'],
        ['regionId' => 'ap-northeast-1', 'endpoint' => 'elasticsearch.ap-northeast-1.aliyuncs.com'],
        ['regionId' => 'eu-west-1', 'endpoint' => 'elasticsearch.eu-west-1.aliyuncs.com'],
        ['regionId' => 'us-west-1', 'endpoint' => 'elasticsearch.us-west-1.aliyuncs.com'],
        ['regionId' => 'us-east-1', 'endpoint' => 'elasticsearch.us-east-1.aliyuncs.com'],
        ['regionId' => 'eu-central-1', 'endpoint' => 'elasticsearch.eu-central-1.aliyuncs.com'],
        ['regionId' => 'ap-south-1', 'endpoint' => 'elasticsearch.ap-south-1.aliyuncs.com'],
        ['regionId' => 'cn-hangzhou-finance', 'endpoint' => 'elasticsearch.cn-hangzhou-finance.aliyuncs.com'],
        ['regionId' => 'cn-shanghai-finance-1', 'endpoint' => 'elasticsearch.cn-shanghai-finance-1.aliyuncs.com'],
        ['regionId' => 'cn-north-2-gov-1', 'endpoint' => 'elasticsearch.cn-north-2-gov-1.aliyuncs.com'],
        ['regionId' => 'cn-guangzhou', 'endpoint' => 'elasticsearch.cn-guangzhou.aliyuncs.com'],
        ['regionId' => 'cn-chengdu', 'endpoint' => 'elasticsearch.cn-chengdu.aliyuncs.com'],
        ['regionId' => 'cn-wulanchabu', 'endpoint' => 'elasticsearch.cn-wulanchabu.aliyuncs.com'],
    ],
];