Method: billingAccounts.billingAccountLicenseConfigs.retractLicenseConfig

このメソッドは、請求先アカウント側から呼び出され、指定されたプロジェクトから LicenseConfig を請求先アカウントに戻します。

HTTP リクエスト

POST https://discoveryengine.googleapis.com/v1alpha/{billingAccountLicenseConfig=billingAccounts/*/billingAccountLicenseConfigs/*}:retractLicenseConfig

この URL では gRPC Transcoding 構文を使用します。

パスパラメータ

パラメータ
billingAccountLicenseConfig

string

必須。BillingAccountLicenseConfig の完全なリソース名。

形式: billingAccounts/{billingAccount}/billingAccountLicenseConfigs/{billingAccountLicenseConfigId}。

リクエストの本文

リクエストの本文には、次の構造のデータが含まれます。

JSON 表現 
{
  "licenseConfig": string,
  "fullRetract": boolean,
  "licenseCount": string
}
フィールド
licenseConfig

string

必須。LicenseConfig の完全なリソース名。

形式: projects/{project}/locations/{location}/licenseConfigs/{licenseConfigId}。
fullRetract

boolean

省略可。true に設定すると、ライセンス構成全体が取り消されます。それ以外の場合は、指定したライセンス数が取り消されます。
licenseCount

string (int64 format)

省略可。取り消すライセンスの数。fullRetract が false の場合にのみ使用されます。

レスポンスの本文

LicenseConfigService.RetractLicenseConfig メソッドに対するレスポンス メッセージ。

成功すると、レスポンスの本文に次の構造のデータが含まれます。

JSON 表現 
{
  "licenseConfig": {
    object (LicenseConfig)
  }
}
フィールド
licenseConfig

object (LicenseConfig)

更新された LicenseConfig。

認可スコープ

次の OAuth スコープのいずれかが必要です。

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/discoveryengine.readwrite

詳細については、Authentication Overview をご覧ください。

IAM 権限

billingAccountLicenseConfig リソースに対する次の IAM 権限が必要です。

  • discoveryengine.billingAccountLicenseConfigs.retract

詳細については、IAM のドキュメントをご覧ください。