summaryrefslogtreecommitdiff
path: root/data/en_us/iacservice/2021-07-22/api-docs.php
blob: 3c48e503778d9d7449d03c45acefe6c8062ba0d9 (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
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
<?php return [
    'version' => '1.0',
    'info' => ['style' => 'ROA', 'product' => 'IaCService', 'version' => '2021-07-22'],
    'directories' => [
        [
            'id' => 0,
            'title' => '其它',
            'type' => 'directory',
            'children' => ['ListResources', 'GetResource', 'ListDataSources'],
        ],
    ],
    'components' => [
        'schemas' => [],
    ],
    'apis' => [
        'ListResources' => [
            'summary' => '列举资源',
            'path' => '/api/v1/providers/{provider}/products/{productCode}/resourceTypes/{resourceTypeCode}/resources',
            'methods' => ['get'],
            'schemes' => ['http', 'https'],
            'security' => [
                [
                    'AK' => [],
                ],
            ],
            'consumes' => ['application/json'],
            'produces' => ['application/json'],
            'operationType' => 'read',
            'deprecated' => false,
            'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'],
            'parameters' => [
                [
                    'name' => 'provider',
                    'in' => 'path',
                    'schema' => ['type' => 'string', 'required' => true],
                ],
                [
                    'name' => 'productCode',
                    'in' => 'path',
                    'schema' => ['type' => 'string', 'required' => true],
                ],
                [
                    'name' => 'resourceTypeCode',
                    'in' => 'path',
                    'schema' => ['type' => 'string', 'required' => true],
                ],
                [
                    'name' => 'regionIds',
                    'in' => 'query',
                    'style' => 'simple',
                    'schema' => [
                        'type' => 'array',
                        'items' => ['type' => 'string'],
                    ],
                ],
                [
                    'name' => 'filter',
                    'in' => 'query',
                    'style' => 'json',
                    'schema' => ['type' => 'object'],
                ],
                [
                    'name' => 'x-roag-cache',
                    'in' => 'header',
                    'schema' => ['type' => 'boolean'],
                ],
                [
                    'name' => 'pageNum',
                    'in' => 'query',
                    'schema' => ['type' => 'integer', 'format' => 'int32'],
                ],
                [
                    'name' => 'pageSize',
                    'in' => 'query',
                    'schema' => ['type' => 'integer', 'format' => 'int32'],
                ],
                [
                    'name' => 'nextToken',
                    'in' => 'query',
                    'schema' => ['type' => 'string'],
                ],
                [
                    'name' => 'maxResults',
                    'in' => 'query',
                    'schema' => ['type' => 'integer', 'format' => 'int32'],
                ],
                [
                    'name' => 'dataType',
                    'in' => 'query',
                    'schema' => ['type' => 'string'],
                ],
            ],
            'responses' => [
                200 => [
                    'schema' => [
                        'title' => 'Schema of Response',
                        'type' => 'object',
                        'properties' => [
                            'requestId' => ['title' => 'Id of the request', 'type' => 'string'],
                            'totalCount' => ['type' => 'integer', 'format' => 'int32'],
                            'pageNum' => ['type' => 'integer', 'format' => 'int32'],
                            'pageSize' => ['type' => 'integer', 'format' => 'int32'],
                            'nextToken' => ['type' => 'string'],
                            'maxResults' => ['type' => 'integer', 'format' => 'int32'],
                            'resources' => [
                                'type' => 'array',
                                'items' => [
                                    'type' => 'object',
                                    'properties' => [
                                        'productCode' => ['type' => 'string'],
                                        'resourceTypeCode' => ['type' => 'string'],
                                        'regionId' => ['type' => 'string'],
                                        'resourceId' => ['type' => 'string'],
                                        'resourceAttributes' => ['type' => 'string'],
                                    ],
                                ],
                            ],
                        ],
                    ],
                ],
            ],
            'responseDemo' => null,
        ],
        'GetResource' => [
            'summary' => '获取具体资源',
            'path' => '/api/v1/providers/{provider}/products/{productCode}/resourceTypes/{resourceTypeCode}/resources/{resourceId}',
            'methods' => ['get'],
            'schemes' => ['http', 'https'],
            'security' => [
                [
                    'AK' => [],
                ],
            ],
            'consumes' => ['application/json'],
            'produces' => ['application/json'],
            'operationType' => 'read',
            'deprecated' => false,
            'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free'],
            'parameters' => [
                [
                    'name' => 'provider',
                    'in' => 'path',
                    'schema' => ['type' => 'string', 'required' => true],
                ],
                [
                    'name' => 'productCode',
                    'in' => 'path',
                    'schema' => ['type' => 'string', 'required' => true],
                ],
                [
                    'name' => 'resourceTypeCode',
                    'in' => 'path',
                    'schema' => ['type' => 'string', 'required' => true],
                ],
                [
                    'name' => 'resourceId',
                    'in' => 'path',
                    'schema' => ['type' => 'string', 'required' => true],
                ],
                [
                    'name' => 'regionId',
                    'in' => 'query',
                    'schema' => ['type' => 'string', 'required' => false],
                ],
                [
                    'name' => 'dataType',
                    'in' => 'query',
                    'schema' => ['type' => 'string'],
                ],
            ],
            'responses' => [
                200 => [
                    'schema' => [
                        'title' => 'Schema of Response',
                        'type' => 'object',
                        'properties' => [
                            'requestId' => ['title' => 'Id of the request', 'type' => 'string'],
                            'resource' => [
                                'type' => 'object',
                                'properties' => [
                                    'productCode' => ['type' => 'string'],
                                    'resourceTypeCode' => ['type' => 'string'],
                                    'regionId' => ['type' => 'string'],
                                    'resourceId' => ['type' => 'string'],
                                    'resourceAttributes' => ['type' => 'string'],
                                ],
                            ],
                        ],
                    ],
                ],
            ],
            'responseDemo' => null,
        ],
        'ListDataSources' => [
            'summary' => '列举资源属性可选值',
            'path' => '/api/v1/providers/{provider}/products/{productCode}/resourceTypes/{resourceTypeCode}/dataSources/{attributeName}',
            'methods' => ['get'],
            'schemes' => ['http', 'https'],
            'security' => [
                [
                    'AK' => [],
                ],
            ],
            'consumes' => ['application/json'],
            'produces' => ['application/json'],
            'operationType' => 'read',
            'deprecated' => false,
            'systemTags' => [
                'operationType' => 'list',
                'riskType' => 'none',
                'chargeType' => 'free',
                'abilityTreeNodes' => ['FEATUREopenapiexplorerY5UU1D'],
                'tenantRelevance' => 'publicInformation',
            ],
            'parameters' => [
                [
                    'name' => 'provider',
                    'in' => 'path',
                    'schema' => ['type' => 'string', 'required' => true],
                ],
                [
                    'name' => 'productCode',
                    'in' => 'path',
                    'schema' => ['type' => 'string', 'required' => true],
                ],
                [
                    'name' => 'resourceTypeCode',
                    'in' => 'path',
                    'schema' => ['type' => 'string', 'required' => true],
                ],
                [
                    'name' => 'attributeName',
                    'in' => 'path',
                    'schema' => ['type' => 'string', 'required' => true],
                ],
                [
                    'name' => 'filter',
                    'in' => 'query',
                    'style' => 'json',
                    'schema' => ['type' => 'object'],
                ],
            ],
            'responses' => [
                200 => [
                    'schema' => [
                        'title' => 'Schema of Response',
                        'type' => 'object',
                        'properties' => [
                            'requestId' => ['title' => 'Id of the request', 'type' => 'string'],
                            'dataSources' => [
                                'type' => 'array',
                                'items' => [
                                    'type' => 'object',
                                    'properties' => [
                                        'id' => ['type' => 'string'],
                                        'dataSourceAttributes' => ['type' => 'string'],
                                    ],
                                ],
                            ],
                        ],
                    ],
                ],
            ],
            'responseDemo' => null,
        ],
    ],
    'endpoints' => [
        ['regionId' => 'cn-zhangjiakou', 'endpoint' => 'iac.cn-zhangjiakou.aliyuncs.com'],
    ],
];