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
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
|
<?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' => 'Grants authorization.',
'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' => '',
'description' => 'scheme',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID. An identifier generated by Alibaba Cloud for the request.', 'type' => 'string', 'example' => 'A009DA1A-46BD-5C72-A713-EEB82249120D', 'title' => ''],
'Data' => ['description' => 'Returns true if the request is successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
],
'example' => '',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A009DA1A-46BD-5C72-A713-EEB82249120D\\",\\n \\"Data\\": true\\n}","type":"json"}]',
'title' => 'Grant carbon footprint authorization for an Alibaba Cloud service',
'description' => '1. Create a RAM user.'."\n"
.'2. Attach the system policy AliyunCarbonFootprintFullAccess to the RAM user.',
'changeSet' => [],
],
'GetSummaryData' => [
'summary' => 'Retrieves aggregated data.',
'methods' => ['get', 'post'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
'name' => 'StartTime',
'in' => 'query',
'schema' => ['description' => 'The start time for the data query. Format: 2023-01-01 00:00:00.', 'type' => 'string', 'required' => false, 'example' => '2023-01-01 00:00:00'."\n"
."\n", 'title' => ''],
],
[
'name' => 'EndTime',
'in' => 'query',
'schema' => ['description' => 'The end time for the data query. Format: 2023-02-01 23:59:59.', 'type' => 'string', 'required' => false, 'example' => '2023-02-01 23:59:59'."\n"
."\n", 'title' => ''],
],
[
'name' => 'Group',
'in' => 'query',
'schema' => ['description' => 'The statistical dimension. Valid values:'."\n"
.'- productCode: aggregates by cloud service.'."\n"
.'- region: aggregates by region.'."\n"
.'- subUid: aggregates by RAM user.'."\n"
."\n"
.'If this parameter is not specified, data is aggregated by Alibaba Cloud account.', 'type' => 'string', 'required' => false, 'example' => 'productCode', 'title' => ''],
],
[
'name' => 'Uids',
'in' => 'query',
'style' => 'json',
'schema' => [
'description' => 'The list of Alibaba Cloud account IDs for which you want to query data. Specify this parameter after you enable the multi-account management feature.',
'type' => 'array',
'items' => ['description' => 'The Alibaba Cloud account ID.', 'type' => 'string', 'required' => false, 'example' => '1626925837172237', 'title' => ''],
'required' => false,
'title' => '',
'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => '',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '88FC75E3-BFFD-50B3-988D-C08E6B795CFD'],
'Data' => [
'description' => 'The data information.',
'type' => 'object',
'properties' => [
'ThisMonthConsumptionConversion' => ['description' => 'The carbon emissions for the most recent month. Unit: kgCO₂e.', 'type' => 'string', 'example' => '193.47', 'title' => ''],
'LastMonthConsumptionConversion' => ['description' => 'The carbon emissions for the month before the most recent month. Unit: kgCO₂e.', 'type' => 'string', 'example' => '301.83', 'title' => ''],
'ThisYearConsumptionConversion' => ['description' => 'The carbon emissions for the year of the most recent month. Unit: kgCO₂e.', 'type' => 'string', 'example' => '1621.06', 'title' => ''],
'LastYearConsumptionConversion' => ['description' => 'The cumulative carbon emissions for the same period of the previous year. Unit: kgCO₂e.', 'type' => 'string', 'example' => '1074.53', 'title' => ''],
'LastYearConsumptionConversionSum' => ['description' => 'The total carbon emissions for the entire previous year. Unit: kgCO₂e.', 'type' => 'string', 'example' => '2844.58', 'title' => ''],
'LatestDataTime' => ['description' => 'The time when the data was last updated.', 'type' => 'string', 'example' => '2023-06-01 00:00:00', 'title' => ''],
'TotalCarbonConsumptionConversion' => ['description' => 'The total carbon emissions calculated based on the requested time range. Unit: kgCO₂e.', 'type' => 'string', 'example' => '1621.06', 'title' => ''],
'CarConsumptionConversion' => ['description' => 'The equivalent carbon emissions of automobiles.', 'type' => 'string', 'example' => '10', 'title' => ''],
'AircraftConsumptionConversion' => ['description' => 'The equivalent carbon emissions of aircraft.', 'type' => 'string', 'example' => '5.2', 'title' => ''],
'TreeConsumptionConversion' => ['description' => 'The equivalent carbon absorption of trees.', 'type' => 'string', 'example' => '90.8', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
'example' => '',
],
],
],
'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' => 'Cloud service carbon footprint data aggregation',
'changeSet' => [],
],
'QueryCarbonTrack' => [
'summary' => 'Queries the carbon footprint.',
'methods' => ['get', 'post'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
'name' => 'StartTime',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The start time for the data query. Format: 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' => '', 'description' => 'The end time for the data query. Format: 2023-02-01 23:59:59.', 'type' => 'string', 'required' => false, 'example' => '2023-02-01 23:59:59'],
],
[
'name' => 'Group',
'in' => 'query',
'schema' => ['description' => 'The statistical dimension. Valid values:'."\n"
.'- productCode: aggregates data by cloud service.'."\n"
.'- region: aggregates data by region.'."\n"
.'- subUid: aggregates data by RAM user.'."\n"
."\n"
.'If this parameter is not specified, data is aggregated by Alibaba Cloud account.', 'type' => 'string', 'required' => false, 'example' => 'productCode', 'title' => ''],
],
[
'name' => 'Uids',
'in' => 'query',
'style' => 'json',
'schema' => [
'description' => 'The list of Alibaba Cloud account IDs for which you want to query data. Specify this parameter after you enable the multi-account management feature.',
'type' => 'array',
'items' => ['description' => 'The Alibaba Cloud account ID.', 'type' => 'string', 'required' => false, 'example' => '1712396608700110', 'title' => ''],
'required' => false,
'title' => '',
'example' => '',
],
],
[
'name' => 'FilterRDAccount',
'in' => 'query',
'schema' => ['description' => 'Specifies whether to return the carbon emission details of multiple accounts. Specify this parameter after you enable the multi-account management feature. If this parameter is not specified, the default value is 0. Valid values:'."\n"
.'- 0: No.'."\n"
.'- 1: Yes.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'title' => ''],
],
[
'name' => 'TopNum',
'in' => 'query',
'schema' => ['description' => 'The number of top entries to return after sorting the results by value in descending order. If this parameter is not specified, all data is returned.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''],
],
[
'name' => 'UseCode',
'in' => 'query',
'schema' => ['description' => 'Specifies whether to use the code as the identifier in the response. If this parameter is not specified, the code is used by default. Valid values:'."\n"
.'- 0: does not use the code.'."\n"
.'- 1: uses the code.'."\n"
."\n"
.'For example, when the response contains carbon emissions aggregated by cloud service, the identifier for Elastic Compute Service is "ecs" if this parameter is set to 0, and "弹性计算ECS" if this parameter is set to 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => '',
'description' => 'result',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The unique request ID generated by Alibaba Cloud for this request.', 'type' => 'string', 'example' => 'B9AA726D-92A2-5F37-8D42-6C0AA3C67C0F', 'title' => ''],
'Data' => [
'description' => 'The data list.',
'type' => 'array',
'items' => [
'description' => 'The data details.',
'type' => 'object',
'properties' => [
'Uid' => ['description' => 'The Alibaba Cloud account ID.', 'type' => 'string', 'example' => '1665635164411336', 'title' => ''],
'SubUid' => ['description' => 'The RAM user ID.', 'type' => 'string', 'example' => '251538859557084260', 'title' => ''],
'ProductCode' => ['description' => 'The product code.', 'type' => 'string', 'example' => 'ecs', 'title' => ''],
'Region' => ['description' => 'The region of the cloud service.', 'type' => 'string', 'example' => 'cn-beijing', 'title' => ''],
'QuotaValue' => ['description' => 'The carbon emissions calculated based on the requested time range. Unit: kgCO₂e.', 'type' => 'number', 'format' => 'double', 'example' => '1.23', 'title' => ''],
'StatisticsDate' => ['description' => 'The statistics date, in millisecond-level timestamp.', 'type' => 'integer', 'format' => 'int64', 'example' => '1672502400000', 'title' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'example' => '',
],
],
],
'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' => 'Query carbon footprint of cloud services',
'changeSet' => [],
],
'QueryMultiAccountCarbonTrack' => [
'summary' => 'Retrieves the carbon footprint details of an account.',
'methods' => ['get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'none'],
'parameters' => [
[
'name' => 'StartTime',
'in' => 'query',
'schema' => ['description' => 'The start time for the query. Format: 2023-01.', 'type' => 'string', 'required' => false, 'example' => '2023-01', 'title' => ''],
],
[
'name' => 'EndTime',
'in' => 'query',
'schema' => ['description' => 'The end time for the query. Format: 2023-10.', 'type' => 'string', 'required' => false, 'example' => '2023-10', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => '',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '49857457-0425-545D-A7A2-9632B43BE2CE'],
'Data' => [
'description' => 'The data list.',
'type' => 'array',
'items' => [
'description' => 'The data details.',
'type' => 'object',
'properties' => [
'Month' => ['description' => 'The month within the query time range.', 'type' => 'string', 'example' => '2023-01', 'title' => ''],
'Uid' => ['description' => 'The Alibaba Cloud account ID.', 'type' => 'string', 'example' => '1665635164411336', 'title' => ''],
'ProductCode' => ['description' => 'The product code.', 'type' => 'string', 'example' => 'ecs', 'title' => ''],
'Region' => ['description' => 'The region of the cloud service.', 'type' => 'string', 'example' => 'cn-beijing', 'title' => ''],
'CarbonActualEmission' => ['description' => 'The carbon emission. Unit: kgCO₂e.', 'type' => 'string', 'example' => '0.0650967', 'title' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'example' => '',
],
],
],
'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' => 'Query carbon footprint details of cloud services',
'description' => 'Each record in the carbon footprint details has the following dimensions: UID, month, cloud service, and region.'."\n"
."\n"
.'If the account has activated Alibaba Cloud Resource Directory and has the role of management account or delegated administrator, you can query the carbon footprint details of all accounts in the resource directory.'."\n"
."\n"
.'Otherwise, you can query only the carbon footprint details of the current account.',
'changeSet' => [],
],
'Verify' => [
'summary' => 'Validates account permissions.',
'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' => '',
'description' => 'The response parameters.'."\n",
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '49857457-0425-545D-A7A2-9632B43BE2CE', 'title' => ''],
'Data' => [
'description' => 'The data records.'."\n",
'type' => 'object',
'properties' => [
'code' => ['description' => 'The error code.'."\n", 'type' => 'string', 'example' => '200', 'title' => ''],
'message' => ['description' => 'The error message.'."\n", 'type' => 'string', 'example' => 'success', 'title' => ''],
'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', 'title' => ''],
'title' => '',
'example' => '',
],
'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', 'title' => ''],
'multiAccountsAllow' => ['description' => 'Whether multi-account management is enabled for the current Alibaba Cloud account. 0:no, 1:yes', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''],
'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', 'title' => ''],
'displayName' => ['description' => 'The username of Alibaba Cloud account.', 'type' => 'string', 'example' => 'test_account', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'title' => '',
'example' => '',
],
],
'example' => '',
],
],
],
'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' => 'Validate current account permissions',
'changeSet' => [],
],
],
'endpoints' => [
['regionId' => 'cn-hangzhou', 'regionName' => 'China (Hangzhou)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'carbonfootprint.aliyuncs.com', 'endpoint' => 'carbonfootprint.aliyuncs.com', 'vpc' => ''],
],
'errorCodes' => [],
'changeSet' => [],
];
|
