diff options
| author | Zhineng Li <im@zhineng.li> | 2026-07-12 17:11:17 +0800 |
|---|---|---|
| committer | Zhineng Li <im@zhineng.li> | 2026-07-12 17:11:17 +0800 |
| commit | 1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634 (patch) | |
| tree | 5f0857666365b7e40cdaa3733ebe1f3ba9e13c67 /data/en_us/carbonfootprint/2023-07-11/api-docs.php | |
| parent | 7347bac4ab7e136157fc94777e6cf87ef9e08599 (diff) | |
| download | afterglow-metadata-full-1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634.tar.gz afterglow-metadata-full-1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634.zip | |
update APIs 20260712
Diffstat (limited to 'data/en_us/carbonfootprint/2023-07-11/api-docs.php')
| -rw-r--r-- | data/en_us/carbonfootprint/2023-07-11/api-docs.php | 572 |
1 files changed, 184 insertions, 388 deletions
diff --git a/data/en_us/carbonfootprint/2023-07-11/api-docs.php b/data/en_us/carbonfootprint/2023-07-11/api-docs.php index 2dcf7c0..24e77bb 100644 --- a/data/en_us/carbonfootprint/2023-07-11/api-docs.php +++ b/data/en_us/carbonfootprint/2023-07-11/api-docs.php @@ -1,31 +1,15 @@ <?php return [ 'version' => '1.0', - 'info' => [ - 'style' => 'RPC', - 'product' => 'CarbonFootprint', - 'version' => '2023-07-11', - ], - 'directories' => [ - 'Allow', - 'GetSummaryData', - 'QueryCarbonTrack', - 'Verify', - 'QueryMultiAccountCarbonTrack', - ], + 'info' => ['style' => 'RPC', 'product' => 'CarbonFootprint', 'version' => '2023-07-11'], + 'directories' => ['Allow', 'GetSummaryData', 'QueryCarbonTrack', 'QueryMultiAccountCarbonTrack', 'Verify'], 'components' => [ 'schemas' => [], ], 'apis' => [ 'Allow' => [ - 'summary' => 'Enables authorization.', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'summary' => 'Grants authorization.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -37,46 +21,34 @@ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREenergyexpertY0LRFK', - ], + 'abilityTreeNodes' => ['FEATUREenergyexpertY0LRFK'], 'tenantRelevance' => 'publicInformation', ], 'parameters' => [], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'scheme', + 'title' => '', 'description' => 'scheme', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'A009DA1A-46BD-5C72-A713-EEB82249120D', - ], - 'Data' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], + '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' => 'Allow', + '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' => 'Queries the summary data of carbon emissions.', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'summary' => 'Retrieves aggregated data.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -89,138 +61,78 @@ [ 'name' => 'StartTime', 'in' => 'query', - 'schema' => [ - 'description' => 'The beginning of the time range to query. Specify the time in the yyyy-MM-dd HH:mm:ss format. Example: 2023-01-01 00:00:00.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '2023-01-01 00:00:00'."\n" - ."\n", - ], + '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 of the time range to query. Specify the time in the yyyy-MM-dd HH:mm:ss format. Example: 2023-02-01 23:59:59.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '2023-02-01 23:59:59'."\n" - ."\n", - ], + '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. A value of productCode specifies that statistics are collected based on cloud service. A value of region specifies that statistics are collected based on region. A value of subUid specifies that statistics are collected based on Resource Access Management (RAM) user. If you do not specify this parameter, statistics are collected based on Alibaba Cloud account.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'productCode', - ], + '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 whose data needs to be queried.(used after enabling multi-account management).', + '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' => 'Alibaba Cloud account ID', - 'type' => 'string', - 'required' => false, - 'example' => '1818401759059836', - ], + 'items' => ['description' => 'The Alibaba Cloud account ID.', 'type' => 'string', 'required' => false, 'example' => '1626925837172237', 'title' => ''], 'required' => false, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '88FC75E3-BFFD-50B3-988D-C08E6B795CFD', - ], + 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '88FC75E3-BFFD-50B3-988D-C08E6B795CFD'], 'Data' => [ - 'description' => 'The returned data.'."\n", + 'description' => 'The data information.', 'type' => 'object', 'properties' => [ - 'ThisMonthConsumptionConversion' => [ - 'description' => 'The carbon emissions in this month, in kgCO₂e.'."\n", - 'type' => 'string', - 'example' => '193.47', - ], - 'LastMonthConsumptionConversion' => [ - 'description' => 'The carbon emissions in the previous month, in kgCO₂e.'."\n", - 'type' => 'string', - 'example' => '301.83', - ], - 'ThisYearConsumptionConversion' => [ - 'description' => 'The carbon emissions in the year of this month, in kgCO₂e.'."\n", - 'type' => 'string', - 'example' => '1621.06', - ], - 'LastYearConsumptionConversion' => [ - 'description' => 'The carbon emissions in the same month of the previous year, in kgCO₂e.'."\n", - 'type' => 'string', - 'example' => '1074.53', - ], - 'LastYearConsumptionConversionSum' => [ - 'description' => 'The carbon emissions of the previous year, in kgCO₂e.'."\n", - 'type' => 'string', - 'example' => '2844.58', - ], - 'LatestDataTime' => [ - 'description' => 'The point in time at which the data is last updated.'."\n", - 'type' => 'string', - 'example' => '2023-06-01 00:00:00', - ], - 'TotalCarbonConsumptionConversion' => [ - 'description' => 'The total carbon emissions within the specified time range, in kgCO₂e.'."\n", - 'type' => 'string', - 'example' => '1621.06', - ], - 'CarConsumptionConversion' => [ - 'description' => 'Converted car carbon emissions.', - 'type' => 'string', - 'example' => '0', - ], - 'AircraftConsumptionConversion' => [ - 'description' => 'Converted aircraft carbon emissions.', - 'type' => 'string', - 'example' => '2.5', - ], - 'TreeConsumptionConversion' => [ - 'description' => 'Converted tree carbon absorption.', - 'type' => 'string', - 'example' => '686.4', - ], + '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' => 'GetSummaryData', + 'title' => 'Cloud service carbon footprint data aggregation', + 'changeSet' => [], ], 'QueryCarbonTrack' => [ - 'summary' => 'Queries the carbon footprint of a cloud service.', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'summary' => 'Queries the carbon footprint.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -233,159 +145,100 @@ [ 'name' => 'StartTime', 'in' => 'query', - 'schema' => [ - 'title' => 'startTime', - 'description' => 'The beginning of the time range to query. Specify the time in the yyyy-MM-dd HH:mm:ss format. Example: 2023-01-01 00:00:00.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '2023-01-01 00:00:00'."\n" - ."\n", - ], + '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' => 'endTime', - 'description' => 'The end of the time range to query. Specify the time in the yyyy-MM-dd HH:mm:ss format. Example: 2023-02-01 23:59:59.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '2023-02-01 23:59:59', - ], + '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. A value of productCode specifies that statistics are collected based on cloud service. A value of region specifies that statistics are collected based on region. A value of subUid specifies that statistics are collected based on Resource Access Management (RAM) user. If you do not specify this parameter, statistics are collected based on Alibaba Cloud account.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'productCode', - ], + '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' => [ - 'type' => 'string', - 'required' => false, - 'description' => 'Alibaba Cloud account ID', - 'example' => '5993670749781117', - ], + 'items' => ['description' => 'The Alibaba Cloud account ID.', 'type' => 'string', 'required' => false, 'example' => '1712396608700110', 'title' => ''], 'required' => false, - 'description' => 'The list of Alibaba Cloud account IDs whose data needs to be queried.(used after enabling multi-account management).', + 'title' => '', + 'example' => '', ], ], [ 'name' => 'FilterRDAccount', 'in' => 'query', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'description' => 'Whether to count the carbon emission details of multiple accounts. You can pass it in after opening the multi-account management. The default value and 0 is No and 1 is Yes.', - 'example' => '0', - ], + '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' => [ - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'description' => 'After sorting in reverse order according to the data value of the return value, only the first TopNum data will be returned. If no data is passed, all data will be returned by default.', - 'example' => '10', - ], + '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' => [ - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - 'description' => 'Whether the return result uses code as the identifier(0 meas not used and 1 means used). If not passed, the default code is used.'."\n" - ."\n" - .'For example, when the return result is to summarize carbon emissions according to the cloud product dimension, the identifier of ECS is "ecs" when 0 is passed, and "Elastic Compute Service" when 1 is passed.', - ], + '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' => 'result', - 'description' => 'The return result.'."\n", + 'title' => '', + 'description' => 'result', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'B9AA726D-92A2-5F37-8D42-6C0AA3C67C0F', - ], + '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 records.'."\n", + 'description' => 'The data list.', 'type' => 'array', 'items' => [ - 'description' => '', + 'description' => 'The data details.', 'type' => 'object', 'properties' => [ - 'Uid' => [ - 'description' => 'The ID of the Alibaba Cloud account.'."\n", - 'type' => 'string', - 'example' => '1665635164411336', - ], - 'SubUid' => [ - 'description' => 'The ID of the RAM user.'."\n", - 'type' => 'string', - 'example' => '251538859557084260', - ], - 'ProductCode' => [ - 'description' => 'The service code.'."\n", - 'type' => 'string', - 'example' => 'ecs', - ], - 'Region' => [ - 'description' => 'The region in which the cloud service resides.'."\n", - 'type' => 'string', - 'example' => 'cn-beijing', - ], - 'QuotaValue' => [ - 'description' => 'The carbon emissions within the specified time range, in kgCO₂e.'."\n", - 'type' => 'number', - 'format' => 'double', - 'example' => '1.23', - ], - 'StatisticsDate' => [ - 'description' => 'The date when the statistics are collected, which is a timestamp in milliseconds.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1672502400000', - ], + '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' => 'QueryCarbonTrack', + 'title' => 'Query carbon footprint of cloud services', + 'changeSet' => [], ], - 'Verify' => [ - 'summary' => 'Verifies whether Alibaba Cloud accounts have the required permissions.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'QueryMultiAccountCarbonTrack' => [ + 'summary' => 'Retrieves the carbon footprint details of an account.', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -393,99 +246,65 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREenergyexpertY0LRFK', + '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' => ''], ], - 'tenantRelevance' => 'publicInformation', ], - 'parameters' => [], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '49857457-0425-545D-A7A2-9632B43BE2CE', - ], + 'RequestId' => ['title' => '', 'description' => 'Id of the request', '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', - ], - ], - ], + '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' => '', ], ], ], - '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' => 'Verify', + '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' => [], ], - 'QueryMultiAccountCarbonTrack' => [ - 'summary' => '获取多账号碳足迹明细数据', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'Verify' => [ + 'summary' => 'Validates account permissions.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -495,91 +314,68 @@ 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREenergyexpertY0LRFK'], + 'tenantRelevance' => 'publicInformation', ], - 'parameters' => [ - [ - 'name' => 'StartTime', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '2023-01', - ], - ], - [ - 'name' => 'EndTime', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '2023-10', - ], - ], - ], + 'parameters' => [], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'title' => '', + 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '49857457-0425-545D-A7A2-9632B43BE2CE', - ], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '49857457-0425-545D-A7A2-9632B43BE2CE', 'title' => ''], 'Data' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Month' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2023-01', - ], - 'Uid' => [ - 'description' => '', - 'type' => 'string', - 'example' => '1665635164411336', - ], - 'ProductCode' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'ecs', - ], - 'Region' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'cn-beijing', - ], - 'CarbonActualEmission' => [ + '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' => '', - 'type' => 'string', - 'example' => '0.0650967', + 'title' => '', + 'example' => '', ], + '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"}]', + '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', - 'endpoint' => 'carbonfootprint.aliyuncs.com', - ], + ['regionId' => 'cn-hangzhou', 'regionName' => 'China (Hangzhou)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'carbonfootprint.aliyuncs.com', 'endpoint' => 'carbonfootprint.aliyuncs.com', 'vpc' => ''], ], + 'errorCodes' => [], + 'changeSet' => [], ]; |
