הפונקציה מתחילה ביטול אסינכרוני של פעולה ממושכת. השרת עושה כמיטב יכולתו כדי לבטל את הפעולה, אבל אי אפשר להבטיח שהיא תבוטל. אם השרת לא תומך בשיטה הזו, הוא מחזיר את הערך google.rpc.Code.UNIMPLEMENTED. לקוחות יכולים להשתמש ב-Operations.GetOperation או בשיטות אחרות כדי לבדוק אם הביטול הצליח או אם הפעולה הושלמה למרות הביטול. אם הביטול בוצע בהצלחה, הפעולה לא נמחקת. במקום זאת, היא הופכת לפעולה עם ערך Operation.error עם google.rpc.Status.code של 1, שתואם ל-Code.CANCELLED.
בקשת HTTP
POST https://cloudaicompanion.googleapis.com/v1/{name=projects/*/locations/*/operations/*}:cancel
כתובת ה-URL משתמשת בתחביר של Transcoding של gRPC.
פרמטרים של נתיב
| פרמטרים | |
|---|---|
name |
השם של משאב הפעולה שרוצים לבטל. |
גוף הבקשה
גוף הבקשה חייב להיות ריק.
גוף התשובה
אם הפעולה בוצעה ללא שגיאות, גוף התגובה הוא אובייקט JSON ריק.
היקפי הרשאה
נדרשת הרשאת OAuth ברמה הבאה:
https://www.googleapis.com/auth/cloud-platform
מידע נוסף זמין בAuthentication Overview.
הרשאות IAM
נדרשת ההרשאה הבאה ב-IAM במשאב name:
cloudaicompanion.operations.cancel
למידע נוסף, עיינו במסמכי העזרה של IAM.