הפעולה הזו מתחילה ביטול אסינכרוני של פעולה ממושכת. השרת עושה כל מאמץ לבטל את הפעולה, אבל אין ערובה לכך שהביטול יצליח. אם השרת לא תומך בשיטה הזו, הוא מחזיר google.rpc.Code.UNIMPLEMENTED
. לקוחות יכולים להשתמש ב-Operations.GetOperation
או בשיטות אחרות כדי לבדוק אם הביטול הצליח או אם הפעולה הושלמה למרות הביטול. אם הביטול מצליח, הפעולה לא נמחקת. במקום זאת, היא הופכת לפעולה עם ערך Operation.error
עם google.rpc.Status.code
של 1
, שמתאים ל-Code.CANCELLED
.
בקשת HTTP
POST https://checks.googleapis.com/v1alpha/{name=accounts/*/apps/*/operations/*}:cancel
כתובת ה-URL משתמשת בתחביר של gRPC Transcoding.
פרמטרים של נתיב
פרמטרים | |
---|---|
name |
השם של משאב הפעולה שרוצים לבטל. |
גוף הבקשה
גוף הבקשה צריך להיות ריק.
גוף התשובה
אם הפעולה בוצעה ללא שגיאות, גוף התגובה יהיה ריק.
היקפי הרשאה
נדרש היקף ההרשאות הבא של OAuth:
https://www.googleapis.com/auth/checks
מידע נוסף זמין במאמר סקירה כללית על OAuth 2.0.