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/zh_cn/carbonfootprint | |
| parent | 7347bac4ab7e136157fc94777e6cf87ef9e08599 (diff) | |
| download | afterglow-metadata-full-1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634.tar.gz afterglow-metadata-full-1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634.zip | |
update APIs 20260712
Diffstat (limited to 'data/zh_cn/carbonfootprint')
| -rw-r--r-- | data/zh_cn/carbonfootprint/2023-07-11/api-docs.php | 493 |
1 files changed, 117 insertions, 376 deletions
diff --git a/data/zh_cn/carbonfootprint/2023-07-11/api-docs.php b/data/zh_cn/carbonfootprint/2023-07-11/api-docs.php index a6c2329..eadee56 100644 --- a/data/zh_cn/carbonfootprint/2023-07-11/api-docs.php +++ b/data/zh_cn/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' => '开通授权。', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -37,9 +21,7 @@ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREenergyexpertY0LRFK', - ], + 'abilityTreeNodes' => ['FEATUREenergyexpertY0LRFK'], 'tenantRelevance' => 'publicInformation', ], 'parameters' => [], @@ -50,16 +32,8 @@ 'description' => 'scheme', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID,阿里云为该请求生成的标识符。', - 'type' => 'string', - 'example' => 'A009DA1A-46BD-5C72-A713-EEB82249120D', - ], - 'Data' => [ - 'description' => '请求成功返回true', - 'type' => 'boolean', - 'example' => 'true', - ], + 'RequestId' => ['description' => '请求ID,阿里云为该请求生成的标识符。', 'type' => 'string', 'example' => 'A009DA1A-46BD-5C72-A713-EEB82249120D'], + 'Data' => ['description' => '请求成功返回true', 'type' => 'boolean', 'example' => 'true'], ], ], ], @@ -71,14 +45,8 @@ ], 'GetSummaryData' => [ 'summary' => '获取汇总数据。', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -91,34 +59,19 @@ [ '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", - ], + '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", - ], + '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', - ], + 'schema' => ['description' => '统计维度,productCode:按云产品统计;region:按区域维度统计;subUid按RAM子用户统计,不传按主账号维度统计', 'type' => 'string', 'required' => false, 'example' => 'productCode'], ], [ 'name' => 'Uids', @@ -127,12 +80,7 @@ 'schema' => [ 'description' => '需要查询数据的主账号id的list,开通多账号管理后传入', 'type' => 'array', - 'items' => [ - 'description' => '阿里云账号id', - 'type' => 'string', - 'required' => false, - 'example' => '1626925837172237', - ], + 'items' => ['description' => '阿里云账号id', 'type' => 'string', 'required' => false, 'example' => '1626925837172237'], 'required' => false, ], ], @@ -144,66 +92,21 @@ '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', - ], + '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', - ], + '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'], ], ], ], @@ -215,14 +118,8 @@ ], 'QueryCarbonTrack' => [ 'summary' => '查询碳足迹。', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -235,35 +132,18 @@ [ '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", - ], + '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', - ], + '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', - ], + 'schema' => ['description' => '统计维度,productCode:按云产品统计;region:按区域维度统计;subUid按RAM子用户统计,不传按主账号维度统计', 'type' => 'string', 'required' => false, 'example' => 'productCode'], ], [ 'name' => 'Uids', @@ -272,48 +152,25 @@ 'schema' => [ 'description' => '需要查询数据的主账号id的list,开通多账号管理后传入', 'type' => 'array', - 'items' => [ - 'description' => '阿里云账号id', - 'type' => 'string', - 'required' => false, - 'example' => '1712396608700110', - ], + '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', - ], + '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', - ], + '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', - ], + 'schema' => ['description' => '返回值是否使用code作为标识,不传默认使用code,0:不使用,1:使用。'."\n" + .'例如返回值为按照云产品维度汇总碳排放时,云服务器的标识在传0时为“ecs”,传1时为“弹性计算ECS”。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0'], ], ], 'responses' => [ @@ -323,11 +180,7 @@ 'description' => 'result', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '阿里云为该请求生成的唯一标识符。', - 'type' => 'string', - 'example' => 'B9AA726D-92A2-5F37-8D42-6C0AA3C67C0F', - ], + 'RequestId' => ['description' => '阿里云为该请求生成的唯一标识符。', 'type' => 'string', 'example' => 'B9AA726D-92A2-5F37-8D42-6C0AA3C67C0F'], 'Data' => [ 'description' => '数据列表', 'type' => 'array', @@ -335,38 +188,12 @@ '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', - ], + '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'], ], ], ], @@ -377,16 +204,10 @@ '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' => '云产品碳足迹列表查询', ], - 'Verify' => [ - 'summary' => '账号校验。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'QueryMultiAccountCarbonTrack' => [ + 'summary' => '获取账号碳足迹明细数据。', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -394,81 +215,39 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREenergyexpertY0LRFK', + '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'], ], - 'tenantRelevance' => 'publicInformation', ], - 'parameters' => [], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '49857457-0425-545D-A7A2-9632B43BE2CE', - ], + 'RequestId' => ['title' => 'Id of the request', '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' => '数据列表', + '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'], ], ], ], @@ -476,17 +255,19 @@ ], ], ], - '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' => '当前账号权限校验', + '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" + .'否则只能查询本账号的碳足迹明细数据。', ], - 'QueryMultiAccountCarbonTrack' => [ - 'summary' => '获取账号碳足迹明细数据。', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'Verify' => [ + 'summary' => '账号校验。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -496,73 +277,42 @@ 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREenergyexpertY0LRFK'], + 'tenantRelevance' => 'publicInformation', ], - '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', - ], - ], - ], + 'parameters' => [], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + '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'], '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', + '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'], + ], ], ], ], @@ -571,22 +321,13 @@ ], ], ], - '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" - .'否则只能查询本账号的碳足迹明细数据。', + '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', - 'endpoint' => 'carbonfootprint.aliyuncs.com', - ], + ['regionId' => 'cn-hangzhou', 'regionName' => '华东1(杭州)', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'carbonfootprint.aliyuncs.com', 'endpoint' => 'carbonfootprint.aliyuncs.com', 'vpc' => ''], ], + 'errorCodes' => [], + 'changeSet' => [], ]; |
