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
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
|
<?php return [
'version' => '1.0',
'info' => ['style' => 'RPC', 'product' => 'CarbonFootprint', 'version' => '2023-07-11'],
'directories' => ['Allow', 'GetSummaryData', 'QueryCarbonTrack', 'QueryMultiAccountCarbonTrack', 'Verify'],
'components' => [
'schemas' => [],
],
'apis' => [
'Allow' => [
'summary' => '开通授权。',
'methods' => ['get', 'post'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREenergyexpertY0LRFK'],
'tenantRelevance' => 'publicInformation',
],
'parameters' => [],
'responses' => [
200 => [
'schema' => [
'title' => 'scheme',
'description' => 'scheme',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID，阿里云为该请求生成的标识符。', 'type' => 'string', 'example' => 'A009DA1A-46BD-5C72-A713-EEB82249120D'],
'Data' => ['description' => '请求成功返回true', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A009DA1A-46BD-5C72-A713-EEB82249120D\\",\\n \\"Data\\": true\\n}","type":"json"}]',
'title' => '云产品碳足迹授权',
'description' => '1. 申请子账号'."\n"
.'2. 为子账号添加系统策略AliyunCarbonFootprintFullAccess',
],
'GetSummaryData' => [
'summary' => '获取汇总数据。',
'methods' => ['get', 'post'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
'name' => 'StartTime',
'in' => 'query',
'schema' => ['description' => '查数据开始时间，格式：2023-01-01 00:00:00', 'type' => 'string', 'required' => false, 'example' => '2023-01-01 00:00:00'."\n"
."\n"],
],
[
'name' => 'EndTime',
'in' => 'query',
'schema' => ['description' => '查数据结束时间，格式：2023-02-01 23:59:59', 'type' => 'string', 'required' => false, 'example' => '2023-02-01 23:59:59'."\n"
."\n"],
],
[
'name' => 'Group',
'in' => 'query',
'schema' => ['description' => '统计维度，productCode：按云产品统计；region：按区域维度统计；subUid按RAM子用户统计，不传按主账号维度统计', 'type' => 'string', 'required' => false, 'example' => 'productCode'],
],
[
'name' => 'Uids',
'in' => 'query',
'style' => 'json',
'schema' => [
'description' => '需要查询数据的主账号id的list，开通多账号管理后传入',
'type' => 'array',
'items' => ['description' => '阿里云账号id', 'type' => 'string', 'required' => false, 'example' => '1626925837172237'],
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '88FC75E3-BFFD-50B3-988D-C08E6B795CFD'],
'Data' => [
'description' => '数据信息。',
'type' => 'object',
'properties' => [
'ThisMonthConsumptionConversion' => ['description' => '最新月份的碳排放量，单位kgCO₂e', 'type' => 'string', 'example' => '193.47'],
'LastMonthConsumptionConversion' => ['description' => '最新月份的上一个月的碳排放量，单位kgCO₂e', 'type' => 'string', 'example' => '301.83'],
'ThisYearConsumptionConversion' => ['description' => '最新月份所在年份的碳排放量，单位kgCO₂e', 'type' => 'string', 'example' => '1621.06'],
'LastYearConsumptionConversion' => ['description' => '上一年度同期的累计碳排放量，单位kgCO₂e', 'type' => 'string', 'example' => '1074.53'],
'LastYearConsumptionConversionSum' => ['description' => '上一年度全年的碳排放总量，单位kgCO₂e', 'type' => 'string', 'example' => '2844.58'],
'LatestDataTime' => ['description' => '最后数据更新时间', 'type' => 'string', 'example' => '2023-06-01 00:00:00'],
'TotalCarbonConsumptionConversion' => ['description' => '根据请求时间段统计的碳排放总量，单位kgCO₂e', 'type' => 'string', 'example' => '1621.06'],
'CarConsumptionConversion' => ['description' => '换算汽车碳排放量', 'type' => 'string', 'example' => '10'],
'AircraftConsumptionConversion' => ['description' => '换算飞机碳排放量', 'type' => 'string', 'example' => '5.2'],
'TreeConsumptionConversion' => ['description' => '换算树木的碳吸收量', 'type' => 'string', 'example' => '90.8'],
],
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"88FC75E3-BFFD-50B3-988D-C08E6B795CFD\\",\\n \\"Data\\": {\\n \\"ThisMonthConsumptionConversion\\": \\"193.47\\",\\n \\"LastMonthConsumptionConversion\\": \\"301.83\\",\\n \\"ThisYearConsumptionConversion\\": \\"1621.06\\",\\n \\"LastYearConsumptionConversion\\": \\"1074.53\\",\\n \\"LastYearConsumptionConversionSum\\": \\"2844.58\\",\\n \\"LatestDataTime\\": \\"2023-06-01 00:00:00\\",\\n \\"TotalCarbonConsumptionConversion\\": \\"1621.06\\",\\n \\"CarConsumptionConversion\\": \\"10\\",\\n \\"AircraftConsumptionConversion\\": \\"5.2\\",\\n \\"TreeConsumptionConversion\\": \\"90.8\\"\\n }\\n}","type":"json"}]',
'title' => '云产品碳足迹数据汇总',
],
'QueryCarbonTrack' => [
'summary' => '查询碳足迹。',
'methods' => ['get', 'post'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
'name' => 'StartTime',
'in' => 'query',
'schema' => ['title' => 'startTime', 'description' => '查数据开始时间，格式：2023-01-01 00:00:00', 'type' => 'string', 'required' => false, 'example' => '2023-01-01 00:00:00'."\n"
."\n"],
],
[
'name' => 'EndTime',
'in' => 'query',
'schema' => ['title' => 'endTime', 'description' => '查数据结束时间，格式：2023-02-01 23:59:59', 'type' => 'string', 'required' => false, 'example' => '2023-02-01 23:59:59'],
],
[
'name' => 'Group',
'in' => 'query',
'schema' => ['description' => '统计维度，productCode：按云产品统计；region：按区域维度统计；subUid按RAM子用户统计，不传按主账号维度统计', 'type' => 'string', 'required' => false, 'example' => 'productCode'],
],
[
'name' => 'Uids',
'in' => 'query',
'style' => 'json',
'schema' => [
'description' => '需要查询数据的主账号id的list，开通多账号管理后传入',
'type' => 'array',
'items' => ['description' => '阿里云账号id', 'type' => 'string', 'required' => false, 'example' => '1712396608700110'],
'required' => false,
],
],
[
'name' => 'FilterRDAccount',
'in' => 'query',
'schema' => ['description' => '是否统计多账号的碳排放明细，开通多账号管理可后传入，不传默认否，0：否，1：是', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0'],
],
[
'name' => 'TopNum',
'in' => 'query',
'schema' => ['description' => '按照返回值的数据值倒序排序后，只返回前TopNum条数据，不传默认返回全部数据', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'],
],
[
'name' => 'UseCode',
'in' => 'query',
'schema' => ['description' => '返回值是否使用code作为标识，不传默认使用code，0：不使用，1：使用。'."\n"
.'例如返回值为按照云产品维度汇总碳排放时，云服务器的标识在传0时为“ecs”，传1时为“弹性计算ECS”。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'result',
'description' => 'result',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '阿里云为该请求生成的唯一标识符。', 'type' => 'string', 'example' => 'B9AA726D-92A2-5F37-8D42-6C0AA3C67C0F'],
'Data' => [
'description' => '数据列表',
'type' => 'array',
'items' => [
'description' => '数据详情',
'type' => 'object',
'properties' => [
'Uid' => ['description' => '主账号ID', 'type' => 'string', 'example' => '1665635164411336'],
'SubUid' => ['description' => 'RAM子账号ID', 'type' => 'string', 'example' => '251538859557084260'],
'ProductCode' => ['description' => '产品code', 'type' => 'string', 'example' => 'ecs'],
'Region' => ['description' => '云产品区域', 'type' => 'string', 'example' => 'cn-beijing'],
'QuotaValue' => ['description' => '根据请求时间统计的碳排放量，单位kgCO₂e', 'type' => 'number', 'format' => 'double', 'example' => '1.23'],
'StatisticsDate' => ['description' => '统计日期，毫秒时间戳', 'type' => 'integer', 'format' => 'int64', 'example' => '1672502400000'],
],
],
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B9AA726D-92A2-5F37-8D42-6C0AA3C67C0F\\",\\n \\"Data\\": [\\n {\\n \\"Uid\\": \\"1665635164411336\\",\\n \\"SubUid\\": \\"251538859557084260\\",\\n \\"ProductCode\\": \\"ecs\\",\\n \\"Region\\": \\"cn-beijing\\",\\n \\"QuotaValue\\": 1.23,\\n \\"StatisticsDate\\": 1672502400000\\n }\\n ]\\n}","type":"json"}]',
'title' => '云产品碳足迹列表查询',
],
'QueryMultiAccountCarbonTrack' => [
'summary' => '获取账号碳足迹明细数据。',
'methods' => ['get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'none'],
'parameters' => [
[
'name' => 'StartTime',
'in' => 'query',
'schema' => ['description' => '查数据开始时间，格式：2023-01', 'type' => 'string', 'required' => false, 'example' => '2023-01'],
],
[
'name' => 'EndTime',
'in' => 'query',
'schema' => ['description' => '查数据开始时间，格式：2023-10', 'type' => 'string', 'required' => false, 'example' => '2023-10'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '49857457-0425-545D-A7A2-9632B43BE2CE'],
'Data' => [
'description' => '数据列表',
'type' => 'array',
'items' => [
'description' => '数据详情',
'type' => 'object',
'properties' => [
'Month' => ['description' => '在查询时间范围内某月', 'type' => 'string', 'example' => '2023-01'],
'Uid' => ['description' => '主账号ID', 'type' => 'string', 'example' => '1665635164411336'],
'ProductCode' => ['description' => '产品code', 'type' => 'string', 'example' => 'ecs'],
'Region' => ['description' => '云产品区域', 'type' => 'string', 'example' => 'cn-beijing'],
'CarbonActualEmission' => ['description' => '碳排放量，单位kgCO₂e', 'type' => 'string', 'example' => '0.0650967'],
],
],
],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"49857457-0425-545D-A7A2-9632B43BE2CE\\",\\n \\"Data\\": [\\n {\\n \\"Month\\": \\"2023-01\\",\\n \\"Uid\\": \\"1665635164411336\\",\\n \\"ProductCode\\": \\"ecs\\",\\n \\"Region\\": \\"cn-beijing\\",\\n \\"CarbonActualEmission\\": \\"0.0650967\\"\\n }\\n ]\\n}","type":"json"}]',
'title' => '云产品碳足迹明细数据查询',
'description' => '碳足迹明细数据的每条数据维度为：uid-月份-云产品-region。'."\n"
."\n"
.'若云账号开通了阿里云资源目录（Resource Directory），且是主管理员或委派管理员角色，则可以查询该资源目录下所有账号的碳足迹明细数据。'."\n"
."\n"
.'否则只能查询本账号的碳足迹明细数据。',
],
'Verify' => [
'summary' => '账号校验。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREenergyexpertY0LRFK'],
'tenantRelevance' => 'publicInformation',
],
'parameters' => [],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'The response parameters.'."\n",
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '49857457-0425-545D-A7A2-9632B43BE2CE'],
'Data' => [
'description' => 'The data records.'."\n",
'type' => 'object',
'properties' => [
'code' => ['description' => 'The error code.'."\n", 'type' => 'string', 'example' => '200'],
'message' => ['description' => 'The error message.'."\n", 'type' => 'string', 'example' => 'success'],
'AllowedUids' => [
'description' => 'The IDs of the returned Alibaba Cloud accounts that have the required permissions.'."\n",
'type' => 'array',
'items' => ['description' => 'The ID of the Alibaba Cloud account that has the required permissions.'."\n", 'type' => 'string', 'example' => '1665635164411336'],
],
'accountType' => ['description' => 'Resource directory account type. 0: not connected, 1: RD member account, 2: RD delegated administrator, 3: RD master administrator', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
'multiAccountsAllow' => ['description' => 'Whether multi-account management is enabled for the current Alibaba Cloud account. 0:no, 1:yes', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
'allMultiAccountUids' => [
'description' => 'A list of all Alibaba Cloud accounts in the resource directory that you have permission to view (returned only when multi-account management is enabled).',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'accountId' => ['description' => 'The ID of Alibaba Cloud account.', 'type' => 'string', 'example' => '1673123142778211'],
'displayName' => ['description' => 'The username of Alibaba Cloud account.', 'type' => 'string', 'example' => 'test_account'],
],
],
],
],
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"49857457-0425-545D-A7A2-9632B43BE2CE\\",\\n \\"Data\\": {\\n \\"code\\": \\"200\\",\\n \\"message\\": \\"success\\",\\n \\"AllowedUids\\": [\\n \\"1665635164411336\\"\\n ],\\n \\"accountType\\": 0,\\n \\"multiAccountsAllow\\": 0,\\n \\"allMultiAccountUids\\": [\\n {\\n \\"accountId\\": \\"1673123142778211\\",\\n \\"displayName\\": \\"test_account\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
'title' => '当前账号权限校验',
],
],
'endpoints' => [
['regionId' => 'cn-hangzhou', 'regionName' => '华东1（杭州）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'carbonfootprint.aliyuncs.com', 'endpoint' => 'carbonfootprint.aliyuncs.com', 'vpc' => ''],
],
'errorCodes' => [],
'changeSet' => [],
];
|
