แหล่งข้อมูล: การดําเนินการ
ทรัพยากรนี้แสดงถึงการดําเนินการที่ยาวนานซึ่งเป็นผลมาจากการเรียกใช้ API เครือข่าย
การแสดง JSON |
---|
{ "name": string, "metadata": { "@type": string, field1: ..., ... }, "done": boolean, // Union field |
ช่อง | |
---|---|
name |
ชื่อที่เซิร์ฟเวอร์กําหนด ซึ่งจะไม่ซ้ํากันภายในบริการเดียวกันที่ส่งคืนในตอนแรก หากใช้การแมป HTTP เริ่มต้น |
metadata |
ช่องนี้จะมีออบเจ็กต์ ออบเจ็กต์ที่มีช่องของประเภทที่กําหนดเอง ช่องเพิ่มเติม |
done |
หากค่าเป็น |
ช่อง Union result ผลการดําเนินการ ซึ่งอาจเป็น error หรือ response ที่ถูกต้อง หาก done == false จะไม่มีการตั้งค่า error หรือ response หาก done == true ระบบอาจตั้งค่า error หรือ response รายการหนึ่ง บริการบางอย่างอาจไม่ได้ให้ผลการค้นหา result ต้องเป็นอย่างใดอย่างหนึ่งต่อไปนี้ |
|
error |
ระบบจะไม่ตั้งค่าช่องนี้เสมอหากสร้างโดย |
response |
ช่องนี้จะมีออบเจ็กต์ ออบเจ็กต์ที่มีช่องของประเภทที่กําหนดเอง ช่องเพิ่มเติม |
สถานะ
ประเภท Status
กําหนดรูปแบบข้อผิดพลาดทางตรรกะที่เหมาะสมสําหรับสภาพแวดล้อมการเขียนโปรแกรมแบบต่างๆ ซึ่งรวมถึง REST API และ RPC API ใช้โดย gRPC ข้อความ Status
แต่ละข้อความมีข้อมูล 3 ส่วน ได้แก่ รหัสข้อผิดพลาด ข้อความแสดงข้อผิดพลาด และรายละเอียดข้อผิดพลาด
คุณสามารถดูข้อมูลเพิ่มเติมเกี่ยวกับรูปแบบข้อผิดพลาดนี้และวิธีใช้งานได้ในคู่มือการออกแบบ API
การแสดง JSON |
---|
{ "code": integer, "message": string, "details": [ { "@type": string, field1: ..., ... } ] } |
ช่อง | |
---|---|
code |
รหัสสถานะ ซึ่งควรเป็นค่า Enum ของ |
message |
ข้อความแสดงข้อผิดพลาดที่นักพัฒนาแอปมองเห็นได้ ซึ่งควรเป็นภาษาอังกฤษ ข้อความแสดงข้อผิดพลาดที่ผู้ใช้มองเห็นควรได้รับการแปลและส่งในช่อง |
details[] |
รายการข้อความที่มีรายละเอียดข้อผิดพลาด มีประเภทข้อความที่ใช้กันทั่วไปสําหรับ API ออบเจ็กต์ที่มีช่องของประเภทที่กําหนดเอง ช่องเพิ่มเติม |
วิธีการ |
|
---|---|
|
รับสถานะล่าสุดของการดําเนินการที่ใช้เวลานาน |