Поделиться через


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

Идентификатор целевой операции.

scope
path True

string

Идентификатор ресурса ARM для подписки, учетной записи выставления счетов или других областей выставления счетов. В настоящее время группа ресурсов и группа управления не поддерживаются. Дополнительные сведения см. в https://aka.ms/costmgmt/scopes.

api-version
query True

string

minLength: 1

Версия API, используемая для этой операции.

Ответы

Имя Тип Описание
200 OK

CostDetailsOperationResults

ХОРОШО. Запрос выполнен успешно.

202 Accepted

Принятый. Операция продолжается.

Other Status Codes

ErrorResponse

Ответ на ошибку, описывающий причину сбоя операции.

Безопасность

azure_auth

Поток OAuth2 Azure Active Directory.

Тип: oauth2
Flow: 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

Данные большого двоичного объекта, созданные этой операцией.

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

Данные большого двоичного объекта, созданные этой операцией.

Имя Тип Описание
blobLink

string

Ссылка на большой двоичный объект для скачивания файла.

byteCount

integer (int64)

Байты в большом двоичном объекте.

CostDetailsDataFormat

Формат данных отчета

Значение Описание
Csv

Формат данных CSV.

CostDetailsMetricType

Тип подробного отчета. По умолчанию предоставляется ActualCost

Значение Описание
ActualCost

Фактические данные о затратах.

AmortizedCost

Амортизированные данные о затратах.

CostDetailsOperationResults

Результат длительной операции для API сведений о затратах.

Имя Тип Описание
error

ErrorDetails

Сведения об ошибке.

id

string

Идентификатор длительной операции.

manifest.blobCount

integer (int32)

Общее количество больших двоичных объектов.

manifest.blobs

BlobInfo[]

Список сведений о BLOB-объектах, созданных этой операцией.

manifest.byteCount

integer (int64)

Общее количество байтов во всех больших двоичных объектах.

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-адрес отчета становится недействительным или истекает в формате UTC, например 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

Этот параметр можно использовать только клиентами Соглашения Enterprise. Используйте формат YearMonth (например, 202008). Этот параметр нельзя использовать вместе с параметрами invoiceId или timePeriod. Если параметр timePeriod, invoiceId или billingPeriod не указан в тексте запроса, API вернет стоимость текущего месяца.

invoiceId

string

Этот параметр можно использовать только клиентами клиентского соглашения Майкрософт. Кроме того, его можно использовать только в профиле выставления счетов или в области клиента. Этот параметр нельзя использовать вместе с параметрами billingPeriod или timePeriod. Если параметр timePeriod, invoiceId или billingPeriod не указан в тексте запроса, API вернет стоимость текущего месяца.

metric

CostDetailsMetricType

Тип подробного отчета. По умолчанию предоставляется ActualCost

timePeriod

CostDetailsTimePeriod

Конкретный диапазон дат сведений о затратах, запрошенных для отчета. Этот параметр нельзя использовать вместе с параметрами invoiceId или billingPeriod. Если параметр timePeriod, invoiceId или billingPeriod не указан в тексте запроса, API вернет стоимость текущего месяца. API позволяет извлекать данные только в течение 1 месяца или меньше и не старше 13 месяцев. Если параметр TIMEPeriod или billingPeriod или invoiceId не предоставляется API по умолчанию для периода открытого месяца