你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

Generate Cost Details Report - Get Operation Results

获取指定操作的结果。 此链接在 CostDetails 创建请求响应位置标头中提供。

GET https://management.azure.com/{scope}/providers/Microsoft.CostManagement/costDetailsOperationResults/{operationId}?api-version=2024-08-01

URI 参数

名称 必需 类型 说明
operationId
path True

string

目标操作 ID。

scope
path True

string

订阅、计费帐户或其他计费范围的 ARM 资源 ID。目前不支持资源组和管理组。 有关详细信息,请参阅 https://aka.ms/costmgmt/scopes

api-version
query True

string

minLength: 1

用于此操作的 API 版本。

响应

名称 类型 说明
200 OK

CostDetailsOperationResults

还行。 请求已成功。

202 Accepted

接受。 该操作正在进行中。

Other Status Codes

ErrorResponse

描述操作失败的原因的错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 Flow。

类型: oauth2
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize

作用域

名称 说明
user_impersonation 模拟用户帐户

示例

Get details of the operation result

示例请求

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/costDetailsOperationResults/00000000-0000-0000-0000-000000000000?api-version=2024-08-01

示例响应

{
  "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/costDetailsOperationResults/00000000-0000-0000-0000-000000000000",
  "name": "00000000-0000-0000-0000-000000000000",
  "status": "Completed",
  "manifest": {
    "manifestVersion": "2024-08-01",
    "dataFormat": "Csv",
    "blobCount": 1,
    "byteCount": 32741,
    "compressData": false,
    "requestContext": {
      "requestScope": "subscriptions/00000000-0000-0000-0000-000000000000",
      "requestBody": {
        "metric": "ActualCost",
        "timePeriod": {
          "start": "2020-03-01",
          "end": "2020-03-15"
        }
      }
    },
    "blobs": [
      {
        "blobLink": "https://ccmreportstorageeastus.blob.core.windows.net/armreports/00000/00000000-0000-0000-0000-000000000000?sv=2020-05-31&sr=b&sig=abcd",
        "byteCount": 32741
      }
    ]
  },
  "validTill": "2022-05-10T08:08:46.1973252Z"
}
Location: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/costDetailsOperationResults/00000000-0000-0000-0000-000000000000?api-version=2024-08-01
Retry-After: 60

定义

名称 说明
BlobInfo

此操作生成的 Blob 信息。

CostDetailsDataFormat

报表的数据格式

CostDetailsMetricType

详细报表的类型。 默认情况下提供 ActualCost

CostDetailsOperationResults

成本详细信息 Api 长时间运行的操作的结果。

CostDetailsStatusType

成本详细信息操作的状态

CostDetailsTimePeriod

拉取成本详细报表数据的开始日期和结束日期。 API 仅允许提取 1 个月或更少的数据,且不超过 13 个月。

ErrorDetails

错误的详细信息。

ErrorResponse

错误响应指示服务无法处理传入请求。 错误消息中提供了原因。

一些错误响应:

  • 429 TooManyRequests - 请求受到限制。 等待“x-ms-ratelimit-microsoft.consumption-retry-after”标头中指定的时间后重试。

  • 503 ServiceUnavailable - 服务暂时不可用。 在等待“Retry-After”标头中指定的时间后重试。

GenerateCostDetailsReportRequestDefinition

成本详细报表的定义。

BlobInfo

此操作生成的 Blob 信息。

名称 类型 说明
blobLink

string

链接到要下载文件的 Blob。

byteCount

integer (int64)

Blob 中的字节数。

CostDetailsDataFormat

报表的数据格式

说明
Csv

Csv 数据格式。

CostDetailsMetricType

详细报表的类型。 默认情况下提供 ActualCost

说明
ActualCost

实际成本数据。

AmortizedCost

摊销成本数据。

CostDetailsOperationResults

成本详细信息 Api 长时间运行的操作的结果。

名称 类型 说明
error

ErrorDetails

错误的详细信息。

id

string

长时间运行的操作的 ID。

manifest.blobCount

integer (int32)

Blob 总数。

manifest.blobs

BlobInfo[]

此操作生成的 Blob 信息列表。

manifest.byteCount

integer (int64)

所有 Blob 中的字节总数。

manifest.compressData

boolean

数据是否采用压缩格式。

manifest.dataFormat

CostDetailsDataFormat

报表的数据格式

manifest.manifestVersion

string

清单版本。

manifest.requestContext.requestBody

GenerateCostDetailsReportRequestDefinition

成本详细信息调用中提供的请求有效负载正文

manifest.requestContext.requestScope

string

请求的请求范围。

name

string

长时间运行的操作的名称。

status

CostDetailsStatusType

成本详细信息操作的状态

type

string

长时间运行的操作的类型。

validTill

string (date-time)

报告 URL 失效/过期的时间(例如 2020-12-08T05:55:59.4394737Z)。

CostDetailsStatusType

成本详细信息操作的状态

说明
Completed

操作已完成。

Failed

操作失败。

NoDataFound

操作已完成且未找到任何成本数据。

CostDetailsTimePeriod

拉取成本详细报表数据的开始日期和结束日期。 API 仅允许提取 1 个月或更少的数据,且不超过 13 个月。

名称 类型 说明
end

string

要将数据拉取到的结束日期。示例格式 2020-03-15

start

string

要从中提取数据的开始日期。 示例格式 2020-03-15

ErrorDetails

错误的详细信息。

名称 类型 说明
code

string

错误代码。

message

string

指示操作失败的原因的错误消息。

ErrorResponse

错误响应指示服务无法处理传入请求。 错误消息中提供了原因。

一些错误响应:

  • 429 TooManyRequests - 请求受到限制。 等待“x-ms-ratelimit-microsoft.consumption-retry-after”标头中指定的时间后重试。

  • 503 ServiceUnavailable - 服务暂时不可用。 在等待“Retry-After”标头中指定的时间后重试。

名称 类型 说明
error

ErrorDetails

错误的详细信息。

GenerateCostDetailsReportRequestDefinition

成本详细报表的定义。

名称 类型 说明
billingPeriod

string

此参数只能由企业协议客户使用。 使用 YearMonth(例如202008)格式。 此参数不能与 invoiceId 或 timePeriod 参数一起使用。 如果未在请求正文中提供 timePeriod、invoiceId 或 billingPeriod 参数,API 将返回本月的成本。

invoiceId

string

此参数只能由Microsoft客户协议客户使用。 此外,它只能用于计费配置文件或客户范围。 此参数不能与 billingPeriod 或 timePeriod 参数一起使用。 如果未在请求正文中提供 timePeriod、invoiceId 或 billingPeriod 参数,API 将返回本月的成本。

metric

CostDetailsMetricType

详细报表的类型。 默认情况下提供 ActualCost

timePeriod

CostDetailsTimePeriod

为报表请求的成本详细信息的特定日期范围。 此参数不能与 invoiceId 或 billingPeriod 参数一起使用。 如果未在请求正文中提供 timePeriod、invoiceId 或 billingPeriod 参数,API 将返回本月的成本。 API 仅允许提取 1 个月或更少的数据,且不超过 13 个月。 如果未提供 timePeriod 或 billingPeriod 或 invoiceId,则 API 默认为开放月份时间段