ต่อไปนี้คือข้อมูลข้อผิดพลาดสำหรับ v2 และ v1 วิธีการทรัพยากร
รุ่นข้อผิดพลาดทรัพยากร v2
ตามปกติ, วิธีการทรัพยากรตอบกลับด้วยสถานะ 200 โอเค เมื่อคำขอไม่สำเร็จ, Open Cloud จะส่งรหัสข้อผิดพลาดมาตรฐาน รวมทั้ง:
- code - ตอบแทนรหัสสถานะ HTTP
- message - ข้อความที่อธิบายข้อผิดพลาด
- details - วัตถุที่มีรายละเอียดเพิ่มเติมเกี่ยวกับข้อผิดพลาด
ตัวอย่างข้อผิดพลาด
{
"code": "INVALID_ARGUMENT",
"message": "The provided filter is invalid.",
"details": [
{
...
}
]
}
รหัส
ตารางต่อไปนี้ระบุค่าที่อาจเป็นไปได้สำหรับ code
รหัส | สถานะ HTTP | คำอธิบาย |
---|---|---|
INVALID_ARGUMENT | 400 | คุณผ่านตัวอ้างที่ไม่ถูกต้อง, เช่น universeId คุณอาจมีหัวข้อที่ขาดหายหรือไม่ถูกต้อง, เช่น Content-Length และ Content-Type . |
PERMISSION_DENIED | 403 | คำขอของคุณไม่มีสิทธิ์หรือขอบเขตที่เพียงพอสำหรับการดำเนินการ |
NOT_FOUND | 404 | ระบบไม่สามารถหาทรัพยากรที่กำหนดของคุณ เช่นเนื้อหาสโตร์ข้อมูล |
ABORTED | 409 | การดำเนินการถูกยกเลิก |
RESOURCE_EXHAUSTED | 429 | คุณไม่มีเครื่องมือเพียงพอที่จะประมูลการดำเนินการนี้ โดยปกติเนื่องจากการส่งคำขอมากเกินไป |
CANCELLED | 499 | ระบบจะยุติคำขอโดยปกติเนื่องจากเวลาที่หมดอายุของลูกค้า |
INTERNAL | 500 | ข้อผิดพลาดของเซิร์ฟเวอร์ภายใน โดยปกติเกิดจากข้อผิดพลาดของเซิร์ฟเวอร์ |
NOT_IMPLEMENTED | 501 | เซิร์ฟเวอร์ไม่มีวิธีการใช้งาน API |
UNAVAILABLE | 503 | ไม่สามารถให้บริการได้ โดยปกติจะได้รับการกลับมาเมื่อเซิร์ฟเวอร์ล้มเหลว |
รุ่นข้อผิดพลาดทรัพยากร v1
คำตอบข้อผิดพลาดทั้งหมดมีรูปแบบที่เหมือนกันซึ่งรวมถึง:
- ฟิลด์ error ซึ่งเป็นสาเหตุระดับสูงที่ใช้ได้กับทุก Open Cloud เอนด์พอร์ต
- ข้อผิดพลาดที่อธิบายได้ message ซึ่งอธิบายข้อผิดพลาดเพิ่มเติม
- เป็นวัตถุ errorDetails ซึ่งรวมถึงข้อมูลเพิ่มเติมของข้อผิดพลาดที่เป็นเฉพาะสำหรับแต่ละ API
เพื่อวิเคราะห์สาเหตุหลักของข้อผิดพลาด โปรดดูค่าของฟิลด์ error และฟิลด์ errorDetails ส่วนข้อมูลเพิ่มเติมสำหรับการจัดการข้อผิดพลาด โดยใช้ฟิลด์ <
ตัวอย่างคำตอบข้อผิดพลาดของมาตรฐาน DataStores
{
"error": "INVALID_ARGUMENT",
"message": "Invalid cursor.",
"errorDetails": [
{
"errorDetailType": "DatastoreErrorInfo",
"datastoreErrorCode": "InvalidCursor"
}
]
}
ตัวอย่างการตอบสนองข้อผิดพลาดแสดงให้เห็น
การตอบกลับข้อผิดพลาดที่สั่งซื้อข้อมูลจะมีรูปแบบเดียวกันซึ่งรวมถึง:
ตัวอย่างการสั่งซื้อ DataStores ข้อผิดพลาด
{
"code": "INVALID_ARGUMENT",
"message": "Invalid cursor."
}
รหัส จะประกอบด้วยสตริงของข้อผิดพลาดระดับสูงสุดขณะที่ message จะประกอบด้วยรายละเอียดเฉพาะเกี่ยวกับข้อผิดพลาด
รหัส
ดูตารางต่อไปนี้เพื่อสรุปข้อผิดพลาดทั้งหมดของคลาวด์เปิดระดับสูง
รหัสสถานะ HTTP | ผิดพลาด | คำอธิบาย |
---|---|---|
400 | ใช้ตัวอักษรที่ไม่ได้รับการสนับสนุน | คุณผ่านตัวอ้างที่ไม่ถูกต้อง, เช่น universeId คุณอาจมีหัวข้อที่ขาดหายหรือไม่ถูกต้อง, เช่น Content-Length และ Content-Type . |
403 | ความวิงเวียน_เขต | คำขอต้องการสิทธิพิเศษสูงกว่าที่มีโดยตั๋วเข้าถึง |
403 | PERMISSION_DENIED | คำขอของคุณไม่มีขอบเขตที่เพียงพอสำหรับการดำเนินการ |
404 | ไม่พบ | ระบบไม่สามารถหาทรัพยากรที่กำหนดของคุณ ร้านค้า |
409 | ยกเลิก | การดำเนินการถูกยกเลิกลงเนื่องจากความขัดแย้ง เช่น การเผยแพร่สถานที่ที่ไม่ใช่ส่วนหนึ่งของจักรวาล |
429 | ทรัพยากร_หมด | คุณไม่มีเครื่องมือเพียงพอที่จะประมูลการดำเนินการนี้ โดยปกติเนื่องจากการส่งคำขอมากเกินไป |
499 | ยกเลิก | ระบบจะยุติคำขอโดยปกติเนื่องจากเวลาที่หมดอายุของลูกค้า |
500 | ภายใน | ข้อผิดพลาดของเซิร์ฟเวอร์ภายใน โดยปกติจะเป็นข้อผิดพลาดของเซิร์ฟเวอร์ |
501 | ไม่ได้รองรับ | เซิร์ฟเวอร์ไม่มีวิธีการใช้งาน API |
503 | ไม่สามารถใช้ได้ | ไม่สามารถให้บริการได้ โดยปกติเซิร์ฟเวอร์จะปิด |