{"openapi":"3.1.0","info":{"title":"Apizie","version":"2.0.0","description":"One API key, one envelope, many public data sources."},"servers":[{"url":"https://zieapi.vercel.app"}],"security":[{"ApiKeyAuth":[]}],"paths":{"/v1/cloud:aliyun-carbonfootprint/allow":{"post":{"operationId":"cloud_aliyun_carbonfootprint_allow","summary":"Grants authorization","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://carbonfootprint.aliyuncs.com"],"default":"https://carbonfootprint.aliyuncs.com","description":"Regional endpoint, for example https://carbonfootprint.aliyuncs.com"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-carbonfootprint/get-summary-data":{"post":{"operationId":"cloud_aliyun_carbonfootprint_get_summary_data","summary":"Retrieves aggregated data","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://carbonfootprint.aliyuncs.com"],"default":"https://carbonfootprint.aliyuncs.com","description":"Regional endpoint, for example https://carbonfootprint.aliyuncs.com"},"StartTime":{"type":"string","description":"The start time for the data query. Format: 2023-01-01 00:00:00"},"EndTime":{"type":"string","description":"The end time for the data query. Format: 2023-02-01 23:59:59"},"Group":{"type":"string","description":"The statistical dimension. Valid values: productCode: aggregates by cloud service. region: aggregates by region. subUid: aggregates by RAM…"},"Uids":{"type":"string","description":"The list of Alibaba Cloud account IDs for which you want to query data. Specify this parameter after you enable the multi-account…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-carbonfootprint/query-carbon-track":{"post":{"operationId":"cloud_aliyun_carbonfootprint_query_carbon_track","summary":"Queries the carbon footprint","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://carbonfootprint.aliyuncs.com"],"default":"https://carbonfootprint.aliyuncs.com","description":"Regional endpoint, for example https://carbonfootprint.aliyuncs.com"},"StartTime":{"type":"string","description":"The start time for the data query. Format: 2023-01-01 00:00:00"},"EndTime":{"type":"string","description":"The end time for the data query. Format: 2023-02-01 23:59:59"},"Group":{"type":"string","description":"The statistical dimension. Valid values: productCode: aggregates data by cloud service. region: aggregates data by region. subUid:…"},"Uids":{"type":"string","description":"The list of Alibaba Cloud account IDs for which you want to query data. Specify this parameter after you enable the multi-account…"},"FilterRDAccount":{"type":"integer","description":"Specifies whether to return the carbon emission details of multiple accounts. Specify this parameter after you enable the multi-account…"},"TopNum":{"type":"integer","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…"},"UseCode":{"type":"integer","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.…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-carbonfootprint/query-multi-account-carbon-track":{"post":{"operationId":"cloud_aliyun_carbonfootprint_query_multi_account_carbon_track","summary":"Retrieves the carbon footprint details of an account","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://carbonfootprint.aliyuncs.com"],"default":"https://carbonfootprint.aliyuncs.com","description":"Regional endpoint, for example https://carbonfootprint.aliyuncs.com"},"StartTime":{"type":"string","description":"The start time for the query. Format: 2023-01"},"EndTime":{"type":"string","description":"The end time for the query. Format: 2023-10"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-carbonfootprint/verify":{"post":{"operationId":"cloud_aliyun_carbonfootprint_verify","summary":"Validates account permissions","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://carbonfootprint.aliyuncs.com"],"default":"https://carbonfootprint.aliyuncs.com","description":"Regional endpoint, for example https://carbonfootprint.aliyuncs.com"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-carbonfootprint/version":{"post":{"operationId":"cloud_aliyun_carbonfootprint_version","summary":"version","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://carbonfootprint.aliyuncs.com"],"default":"https://carbonfootprint.aliyuncs.com","description":"Regional endpoint, for example https://carbonfootprint.aliyuncs.com"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}}},"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"x-api-key"}},"schemas":{"RunEnvelope":{"type":"object","required":["project","data","timestamp"],"properties":{"project":{"type":"string","example":"dev-tools:hash"},"data":{},"timestamp":{"type":"string","format":"date-time"}}},"ErrorEnvelope":{"type":"object","properties":{"content":{},"message":{"type":"string"},"errors":{"type":"array","items":{}},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}}}}}},"responses":{"Error":{"description":"Invalid key, plan gate, rate limit or upstream failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}}}}