メソッド: services.disable

プロジェクトで使用できなくなるようにサービスを無効にします。これにより、予期しない課金やセキュリティ リークの原因となる意図しない使用が防止されます。

現在有効になっていないサービスで disable メソッドを呼び出すことはできません。ターゲット サービスが現在有効になっていない場合は、FAILED_PRECONDITION のステータスが返されます。

Operation<response: DisableServiceResponse>

HTTP リクエスト

POST https://serviceusage.googleapis.com/v1/{name=*/*/services/*}:disable

この URL は Google API HTTP アノテーション構文を使用します。

パスパラメータ

パラメータ
name

string

サービスを無効にするコンシューマとサービスの名前。

現時点で、enable メソッドと disable メソッドはプロジェクトのみをサポートしています。

名前の例: projects/123/services/serviceusage.googleapis.com。ここで、123 はプロジェクト番号です(プロジェクト ID ではありません)。

承認には、指定されたリソースの name に対する次の Google IAM 権限が必要です。

  • serviceusage.services.disable

リクエストの本文

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

JSON 表現

{
  "disableDependentServices": boolean
}
フィールド
disableDependentServices

boolean

有効でありこのサービスに依存するサービスも無効にする必要があるかどうかを示します。設定しない場合、有効なサービスが無効にするサービスに依存する場合、エラーが発生します。設定すると、サービスと、そのサービスに依存する有効なサービスは一緒に無効になります。

レスポンスの本文

成功した場合、レスポンスの本文には Operation のインスタンスが含まれます。

承認スコープ

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

  • https://www.googleapis.com/auth/service.management
  • https://www.googleapis.com/auth/cloud-platform

詳細については、認証の概要をご覧ください。