Автоматизация отчетов об использовании с помощью REST API

Вы можете автоматически извлекать данные из GitHub для заполнения бизнес-систем, используемых для мониторинга затрат и использования с помощью REST API. Если вы еще не использовали REST API GitHub до этого, см . раздел AUTOTITLE.

Общие сведения о конечных точках

Для сбора данных в зависимости от типа учетной записи и нужного уровня информации необходимо использовать разные конечные точки.

Получение потребления запросов уровня "Премиум"

1. Проверка подлинности с помощью GitHub с помощью одного из следующих методов:

   • GitHub CLI: используйте команду для проверки подлинности, см. раздел gh auth login Краткое руководство по GitHub CLI.
   • Создайте personal access token (classic)и передайте маркер в вызов API, см. статью "Создание personal access token (classic)".

2. Вызовите необходимую premium_request/usage конечную точку, указав предприятия, организации или пользователя, для которого нужны данные.

Чтобы скачать другие метрики для GitHub Copilot, см. раздел Анализ использования с течением времени с помощью API метрик GitHub Copilot.

Получение данных об использовании для всех платных продуктов

1. Проверка подлинности с помощью GitHub с помощью одного из следующих методов:

   • GitHub CLI: используйте команду для проверки подлинности, см. раздел gh auth login Краткое руководство по GitHub CLI.
   • Создайте personal access token (classic)и передайте маркер в вызов API, см. статью "Создание personal access token (classic)".

2. Вызовите необходимую usage конечную точку, указав предприятия, организации или пользователя, для которого нужны данные.

3. По умолчанию сообщается данные обо всех продуктах за текущий год. Для предприятий сообщается только данные, которые не связаны с центром затрат.

   Вы можете запросить более конкретные данные с помощью параметров запроса.

   • Укажите период времени, задав один или несколько следующих параметров: year, , month``dayи hour.
   • Укажите центр затрат для отчета по идентификатору cost_center_id с помощью параметра запроса (только корпоративная конечная точка).

Дополнительные сведения и примеры вызовов и ответов см. в следующих примерах:

• Получение отчета об использовании выставления счетов для предприятия
• Получение отчета об использовании выставления счетов для организации
• Получение отчета об использовании выставления счетов для пользователя

Миграция с конечных точек, используемых для предыдущей платформы выставления счетов

После перехода на тарифное выставление счетов конечные точки, используемые для получения данных из предыдущей платформы выставления счетов, больше не будут возвращать точные сведения об использовании.

• Обновите все вызовы формы: /ACCOUNT-TYPE/NAME/settings/billing/PRODUCT
• Для использования эквивалента: /ACCOUNT-TYPE/NAME/settings/billing/usage конечная точка

Изменения в проверке подлинности

Если вы использовали fine-grained personal access token для проверки подлинности с помощью предыдущих конечных точек, вам потребуется создать personal access token (classic) для проверки подлинности с помощью новой конечной точки.

Кроме того, может потребоваться использовать новые параметры запроса для указания периода времени или центра затрат.

Вычисление данных GitHub Actions из новых данных ответа

Пример предыдущего ответа

{"total_minutes_used": 305, "total_paid_minutes_used": 0, "included_minutes": 3000, "minutes_used_breakdown": { "UBUNTU": 205, "MACOS": 10, "WINDOWS": 90 }  }

Пример нового ответа

{ "usageItems": [ { "date": "2023-08-01", "product": "Actions", "sku": "Actions Linux", "quantity": 100, "unitType": "minutes", "pricePerUnit": 0.008, "grossAmount": 0.8, "discountAmount": 0, "netAmount": 0.8, "organizationName": "GitHub", "repositoryName": "github/example"} ] }

Чтобы получить те же значения из новых данных ответа:

Вычисление данных GitHub Packages из новых данных ответа

Пример предыдущего ответа

{ "total_gigabytes_bandwidth_used": 50, "total_paid_gigabytes_bandwidth_used": 40, "included_gigabytes_bandwidth": 10 }

Пример нового ответа

{ "usageItems": [ { "date": "2023-08-01", "product": "Packages", "sku": "Packages data transfer", "quantity": 100, "unitType": "gigabytes", "pricePerUnit": 0.008, "grossAmount": 0.8, "discountAmount": 0, "netAmount": 0.8, "organizationName": "GitHub", "repositoryName": "github/example" } ] }

Вычисление общих сведений о хранилище из новых данных ответа

Пример предыдущего ответа

{ "days_left_in_billing_cycle": 20, "estimated_paid_storage_for_month": 15, "estimated_storage_for_month": 40 }

Пример нового ответа

{ "usageItems": [ { "date": "2023-08-01", "product": "Packages", "sku": "Packages storage", "quantity": 100, "unitType": "GigabyteHours", "pricePerUnit": 0.008, "grossAmount": 0.8, "discountAmount": 0, "netAmount": 0.8, "organizationName": "GitHub", "repositoryName": "github/example" } ] }