Xử lý các yêu cầu kho dữ liệu Open Cloud

*Nội dung này được dịch bằng AI (Beta) và có thể có lỗi. Để xem trang này bằng tiếng Anh, hãy nhấp vào đây.

Có một số yếu tố cần xem xét khi gửi yêu cầu đến và xử lý phản hồi từ các API kho dữ liệu Open Cloud.

Tiêu đề HTTP

Giống như tất cả các điểm cuối Open Cloud, các yêu cầu kho dữ liệu sử dụng xác thực khóa API phải bao gồm tiêu đề x-api-key. Để biết thêm thông tin, xem Quản lý khóa API.

Một khóa API không hợp lệ hoặc bị thiếu sẽ dẫn đến lỗi 401.
Một khóa API hợp lệ nhưng thiếu quyền truy cập thích hợp sẽ dẫn đến lỗi 403.

Nếu một yêu cầu bao gồm một thân, như yêu cầu tạo hoặc cập nhật, hãy bao gồm các tiêu đề Content-Type: application/json và Content-Length. Hầu hết các khách hàng tự động bao gồm các tiêu đề này.

Phân trang

Các kho dữ liệu thường chứa nhiều mục, điều này có nghĩa là mã của bạn, đặc biệt là khi gọi Danh sách mục dữ liệu kho, phải xử lý số lượng kết quả và trang tối đa. Để tìm hiểu thêm, xem Phân trang.

Bộ lọc

Nếu bạn sử dụng tiền tố trong tên của các mục kho dữ liệu của mình, bạn có thể muốn lọc các cuộc gọi GET của mình, như sau:


def list_entries(universe, data_store, filter):
    list_path = f'universes/{universe}/data-stores/{data_store}/entries'
    url = base_url + list_path
    return requests.get(url, params={'filter': f'id.startsWith("global/{filter}")'}, headers={apiHeaderKey: apiKey})

Cú pháp bộ lọc rất hạn chế. Xem tài liệu tham khảo để biết các bộ lọc có sẵn cho các kho dữ liệu chuẩn và có thứ tự.

Các phương thức PATCH (cập nhật) cho kho dữ liệu chuẩn và có thứ tự có tham số allow_missing. Nếu được đặt thành true, tham số này cho phép bạn tạo các mục không tồn tại thay vì ném ra lỗi. Để tham số này ở giá trị mặc định là false trừ khi bạn có lý do tốt để không làm vậy; việc cập nhật một mục chưa bao giờ được tạo thường đại diện cho một lỗi trong logic lập trình.

Phạm vi

Nhiều yêu cầu yêu cầu bạn chỉ định một phạm vi, ngay cả khi đó là giá trị mặc định global. Các phạm vi này khác với các phạm vi quyền và cho phép bạn phân chia và tổ chức các mục trong một kho dữ liệu.

Thay vì tạo các phạm vi không mặc định, tuy nhiên, chúng tôi khuyến nghị mạnh mẽ việc sử dụng các tiền tố. Để tìm hiểu thêm, xem Danh sách và tiền tố.

Nội dung-MD5

Phần này chỉ áp dụng cho API Open Cloud v1.

API Open Cloud v1 hỗ trợ mã băm MD5 được mã hóa base64 tùy chọn trong một số yêu cầu, có thể phát hiện các vấn đề về tính toàn vẹn dữ liệu. Nhiều ngôn ngữ có các hàm tích hợp để tính toán giá trị của tiêu đề content-md5. Ví dụ sau sử dụng Python:


$ echo "750" | python -c "import base64, hashlib; print(str(base64.b64encode(hashlib.md5(bytes(input(), encoding='utf8')).digest()), encoding='utf8'))"
sTf90fedVsft8zZf6nUg8g==

Nếu bạn gặp các vấn đề khi tạo giá trị content-md5 hợp lệ, bạn có thể cần mã hóa thân yêu cầu của bạn bằng UTF-8 trước khi tính toán mã băm.

Tiếng Việt