Method: operations.cancel

ज़्यादा समय तक चलने वाले ऑपरेशन को असिंक्रोनस तरीके से रद्द करने की प्रोसेस शुरू करता है. सर्वर, ऑपरेशन को रद्द करने की पूरी कोशिश करता है. हालांकि, इस बात की कोई गारंटी नहीं है कि ऑपरेशन रद्द हो जाएगा. अगर सर्वर पर यह तरीका काम नहीं करता है, तो यह google.rpc.Code.UNIMPLEMENTED दिखाता है. क्लाइंट, Operations.GetOperation या अन्य तरीकों का इस्तेमाल करके यह देख सकते हैं कि रद्द करने की प्रोसेस पूरी हुई या नहीं या रद्द करने के बावजूद ऑपरेशन पूरा हुआ या नहीं. रद्द करने की कार्रवाई पूरी होने पर, वह कार्रवाई मिटाई नहीं जाती. इसके बजाय, वह Code.CANCELLED से जुड़ी 1 की google.rpc.Status.code वैल्यू वाली Operation.error वैल्यू वाली कार्रवाई बन जाती है.

एचटीटीपी अनुरोध

POST https://vault.googleapis.com/v1/{name=operations/**}:cancel

यूआरएल में gRPC ट्रांसकोडिंग सिंटैक्स का इस्तेमाल किया गया है.

पाथ पैरामीटर

पैरामीटर
name

string

उस ऑपरेशन रिसॉर्स का नाम जिसे रद्द करना है.

अनुरोध का मुख्य भाग

अनुरोध का मुख्य हिस्सा खाली होना चाहिए.

जवाब का मुख्य भाग

अगर एपीआई सही से जुड़ जाता है, तो रिस्पॉन्स बॉडी में खाली JSON ऑब्जेक्ट होता है.

अनुमति के दायरे

नीचे दिए गए OAuth के लिंक की ज़रूरत हाेती है:

  • https://www.googleapis.com/auth/ediscovery

ज़्यादा जानकारी के लिए, अनुमति से जुड़ी गाइड देखें.