Xuất dữ liệu từ Analytics

Bạn đang xem tài liệu về Apigee Edge.
Truy cập vào tài liệu Apigee X.
thông tin

Thiết lập quyền cho nhân viên dịch vụ được chỉ định

Để thiết lập quyền cho nhân viên dịch vụ được chỉ định, nhằm chuẩn bị cho những thay đổi được mô tả ở trên, hãy làm theo các bước sau.

  1. Tìm tên của tác nhân dịch vụ Google Cloud bằng cách nhập lệnh sau:
    curl -X GET \
      "https://api.enterprise.apigee.com/v1/organizations/ORG" \
      -u email:password \
      | jq -r '.properties.property[] | select(.name=="serviceAgent.analytics") | .value'

    ORG tổ chức của bạn. Thao tác này sẽ trả về tên và giá trị của tác nhân dịch vụ như minh hoạ bên dưới:

    "property" : [
      {
       "name" : "serviceAgent.analytics",
       "value" : "service-9q1ibk@gcp-sa-apigee-uap.iam.gserviceaccount.com"
       },
  2. Mở trang tổng quan IAM trong Google Cloud Console.
  3. Chọn dự án trên đám mây của bạn.
  4. Nhấp vào Add (Thêm) ở đầu ngăn IAM.
  5. Trong trường Bên giao đại lý mới, hãy nhập tác nhân dịch vụ value được trả về ở bước 1. Ví dụ: value xuất hiện trong bước 1 là service-9q1ibk@gcp-sa-apigee-uap.iam.gserviceaccount.com.
  6. Nhấp vào nút +Thêm vai trò khác rồi thêm các vai trò sau:
    • Người dùng BigQuery
    • Quản trị viên lưu trữ
  7. Nhấp vào Lưu.

Dữ liệu Apigee Analytics

Apigee Analytics thu thập và phân tích nhiều loại dữ liệu lưu chuyển qua các API của bạn, đồng thời cung cấp các công cụ trực quan hoá, bao gồm cả trang tổng quan tương tác, báo cáo tuỳ chỉnh và các công cụ khác giúp xác định xu hướng về hiệu suất của proxy API. Giờ đây, bạn có thể khai thác nội dung đa dạng thức này bằng cách xuất số liệu phân tích từ Apigee Analytics sang kho lưu trữ dữ liệu của riêng bạn, chẳng hạn như Google Cloud Storage hoặc Google BigQuery. Sau đó, bạn có thể tận dụng khả năng truy vấn và học máy mạnh mẽ do Google BigQuery và TensorFlow cung cấp để tự phân tích dữ liệu. Bạn cũng có thể kết hợp dữ liệu phân tích đã xuất với các dữ liệu khác, chẳng hạn như nhật ký web, để thu thập thông tin chi tiết mới về người dùng, API và ứng dụng của bạn.

Định dạng xuất dữ liệu

Xuất dữ liệu phân tích sang một trong các định dạng sau:

  • Giá trị được phân tách bằng dấu phẩy (CSV)

    Dấu phân cách mặc định là dấu phẩy (,). Các ký tự phân cách được hỗ trợ bao gồm dấu phẩy (,), dấu sổ đứng (|) và dấu tab (\t). Định cấu hình giá trị bằng thuộc tính csvDelimiter, như mô tả trong phần Tài liệu tham khảo về thuộc tính yêu cầu xuất .

  • JSON (phân cách bằng dấu xuống dòng)

    Cho phép sử dụng ký tự dòng mới làm dấu phân cách.

Dữ liệu được xuất bao gồm tất cả các chỉ số và phương diện phân tích được tích hợp trong Edge, cũng như mọi dữ liệu phân tích tuỳ chỉnh mà bạn thêm. Để biết nội dung mô tả về dữ liệu được xuất, hãy xem bài viết Tài liệu tham khảo về chỉ số, phương diện và bộ lọc của Analytics.

Bạn có thể xuất dữ liệu phân tích sang các kho lưu trữ dữ liệu sau:

Tổng quan về quy trình xuất

Các bước sau đây tóm tắt quy trình xuất dữ liệu phân tích:

  1. Định cấu hình kho lưu trữ dữ liệu (Cloud Storage hoặc BigQuery) để xuất dữ liệu. Bạn phải đảm bảo rằng kho lưu trữ dữ liệu của mình đã được định cấu hình đúng cách và tài khoản dịch vụ dùng để ghi dữ liệu vào kho lưu trữ dữ liệu có các quyền phù hợp.

  2. Tạo một kho dữ liệu xác định các thuộc tính của kho lưu trữ dữ liệu (Cloud Storage hoặc BigQuery) nơi bạn xuất dữ liệu, bao gồm cả thông tin xác thực được dùng để truy cập vào kho lưu trữ dữ liệu.

    Khi tạo một kho dữ liệu, bạn sẽ tải thông tin đăng nhập kho dữ liệu lên Edge Credentials Vault để lưu trữ một cách an toàn. Sau đó, cơ chế xuất dữ liệu sẽ sử dụng những thông tin xác thực đó để ghi dữ liệu vào kho lưu trữ dữ liệu của bạn.

  3. Sử dụng API xuất dữ liệu để bắt đầu xuất dữ liệu. Quá trình xuất dữ liệu chạy không đồng bộ ở chế độ nền.

  4. Sử dụng API xuất dữ liệu để xác định thời điểm hoàn tất quá trình xuất.

  5. Khi quá trình xuất hoàn tất, hãy truy cập vào dữ liệu đã xuất trong kho lưu trữ dữ liệu của bạn.

Các phần sau đây sẽ mô tả chi tiết hơn về những bước này.

Định cấu hình kho lưu trữ dữ liệu

Cơ chế xuất dữ liệu phân tích sẽ ghi dữ liệu vào Cloud Storage hoặc BigQuery. Để thực hiện thao tác ghi đó, bạn phải:

  • Tạo tài khoản dịch vụ Google Cloud Platform.
  • Đặt vai trò của tài khoản dịch vụ để tài khoản đó có thể truy cập vào Cloud Storage hoặc BigQuery.

Tạo tài khoản dịch vụ cho Cloud Storage hoặc BigQuery

Tài khoản dịch vụ là một loại tài khoản Google thuộc về ứng dụng của bạn chứ không phải thuộc về người dùng cá nhân. Sau đó, ứng dụng của bạn sẽ sử dụng tài khoản dịch vụ để truy cập vào một dịch vụ.

Tài khoản dịch vụ có một khoá tài khoản dịch vụ được biểu thị bằng một chuỗi JSON. Khi tạo kho dữ liệu Edge xác định mối kết nối với kho lưu trữ dữ liệu, bạn sẽ truyền khoá này. Sau đó, cơ chế xuất dữ liệu sẽ dùng khoá này để truy cập vào kho lưu trữ dữ liệu của bạn.

Tài khoản dịch vụ được liên kết với khoá phải là chủ sở hữu dự án trên Google Cloud Platform và có quyền ghi vào bộ chứa Google Cloud Storage. Để tạo khoá dịch vụ và tải trọng cần thiết, hãy xem phần Tạo và quản lý khoá tài khoản dịch vụ trong tài liệu của Google Cloud Platform.

Ví dụ: khi bạn tải khoá xuống lần đầu tiên, khoá đó sẽ được định dạng dưới dạng một đối tượng JSON:

{ 
  "type": "service_account", 
  "project_id": "myProject", 
  "private_key_id": "12312312", 
  "private_key": "-----BEGIN PRIVATE KEY-----\n...", 
  "client_email": "client_email@developer.gserviceaccount.com", 
  "client_id": "879876769876", 
  "auth_uri": "https://accounts.google.com/organizations/oauth2/auth", 
  "token_uri": "https://oauth2.googleapis.com/token", 
  "auth_provider_x509_cert_url": "https://www.googleapis.com/oauth2", 
  "client_x509_cert_url": "https://www.googleapis.com" 
}

Định cấu hình Google Cloud Storage

Trước khi có thể xuất dữ liệu sang Google Cloud Storage, bạn cần:

  • Đảm bảo rằng bạn đã bật API BigQueryCloud Resource Manager trong dự án Google Cloud Platform của mình. Hãy xem phần Bật API để biết hướng dẫn. Apigee sử dụng BigQuery API để tận dụng các tính năng xuất dữ liệu của BigQuery khi xuất dữ liệu sang Cloud Storage và Cloud Resource Manager API để kiểm tra quyền trước mỗi lần xuất.
  • Đảm bảo rằng tài khoản dịch vụ được chỉ định cho các vai trò sau:

    • Người dùng BigQuery Job
    • Storage Object Creator
    • Quản trị viên bộ nhớ (chỉ bắt buộc đối với việc kiểm thử kho dữ liệu như mô tả trong phần Kiểm thử cấu hình kho dữ liệu. Nếu vai trò này quá rộng, bạn có thể thêm quyền storage.buckets.get vào một vai trò hiện có.)

    Ngoài ra, nếu bạn muốn sửa đổi một vai trò hiện có hoặc tạo một vai trò tuỳ chỉnh, hãy thêm các quyền sau vào vai trò đó:

Định cấu hình Google BigQuery

Trước khi có thể xuất dữ liệu sang Google BigQuery, bạn cần:

  • Đảm bảo rằng bạn đã bật API BigQueryCloud Resource Manager trong dự án Google Cloud Platform của mình. Hãy xem phần Bật API để biết hướng dẫn. Apigee sử dụng Cloud Resource Manager API để kiểm tra quyền trước mỗi lần xuất.
  • Đảm bảo rằng bạn đã bật API BigQuery trong dự án trên Google Cloud Platform. Hãy xem phần Bật và tắt API để biết hướng dẫn.
  • Đảm bảo rằng tài khoản dịch vụ được chỉ định cho các vai trò sau:

    • Người dùng BigQuery Job
    • Người chỉnh sửa dữ liệu BigQuery

    Nếu bạn muốn sửa đổi một vai trò hiện có hoặc tạo một vai trò tuỳ chỉnh, hãy thêm các quyền sau vào vai trò đó:

    • bigquery.datasets.create
    • bigquery.datasets.get
    • bigquery.jobs.create
    • bigquery.tables.create
    • bigquery.tables.get
    • bigquery.tables.updateData

Tạo kho dữ liệu

Kho dữ liệu xác định mối kết nối với kho lưu trữ dữ liệu xuất (Cloud Storage, BigQuery), bao gồm cả thông tin đăng nhập được dùng để truy cập vào kho lưu trữ dữ liệu.

Giới thiệu về Edge Credentials Vault

Edge sử dụng Credentials Vault để lưu trữ an toàn thông tin đăng nhập dùng để truy cập vào kho lưu trữ dữ liệu xuất. Để một dịch vụ có thể truy cập vào thông tin đăng nhập trong Edge Credentials Vault, bạn phải xác định một người dùng thông tin đăng nhập.

Khi bạn tạo một kho dữ liệu bằng cách sử dụng Giao diện người dùng Edge (như mô tả bên dưới), Edge sẽ tự động tạo người dùng để truy cập vào thông tin đăng nhập.

Kiểm thử cấu hình kho dữ liệu

Khi bạn tạo kho dữ liệu, Edge không kiểm thử hoặc xác thực rằng thông tin đăng nhập và cấu hình kho lưu trữ dữ liệu của bạn là hợp lệ. Điều đó có nghĩa là bạn có thể tạo kho dữ liệu và không phát hiện thấy lỗi nào cho đến khi chạy lần xuất dữ liệu đầu tiên.

Ngoài ra, hãy kiểm thử cấu hình kho dữ liệu trước khi tạo. Việc kiểm thử rất hữu ích vì quá trình xuất dữ liệu lớn có thể mất nhiều thời gian để thực thi. Bằng cách kiểm tra thông tin đăng nhập và cấu hình kho dữ liệu trước khi bắt đầu tải một lượng lớn dữ liệu xuống, bạn có thể nhanh chóng khắc phục mọi vấn đề về chế độ cài đặt.

Nếu kiểm thử thành công, hãy tạo kho dữ liệu. Nếu kiểm thử không thành công, hãy khắc phục lỗi rồi kiểm thử lại cấu hình. Bạn chỉ tạo kho dữ liệu sau khi các kiểm thử thành công.

Để bật tính năng kiểm thử, bạn phải:

  • Đảm bảo rằng bạn đã bật Cloud Resource Manager API trong dự án Google Cloud Platform. Hãy xem phần Bật và tắt API để biết hướng dẫn.

Tạo kho dữ liệu

Cách tạo một kho lưu trữ dữ liệu trong giao diện người dùng:

  1. Đăng nhập vào https://apigee.com/edge với tư cách là quản trị viên tổ chức rồi chọn tổ chức của bạn.

    NOTE: Bạn phải là quản trị viên tổ chức Edge thì mới có thể tạo kho dữ liệu.

  2. Chọn Quản trị > Kho dữ liệu phân tích trên thanh điều hướng bên trái. Trang Analytics Datastores (Kho dữ liệu Analytics) sẽ xuất hiện.

  3. Chọn nút + Thêm Datastore. Bạn sẽ được nhắc chọn loại kho dữ liệu:

  4. Chọn một loại đích xuất dữ liệu:

    • Google Cloud Storage
    • Google BigQuery

    Trang cấu hình sẽ xuất hiện:

  5. Nhập Tên kho dữ liệu.

  6. Chọn thông tin đăng nhập dùng để truy cập vào kho lưu trữ dữ liệu. Một danh sách thả xuống gồm các thông tin xác thực hiện có sẽ xuất hiện.

    Thông tin đăng nhập dành riêng cho một loại kho lưu trữ dữ liệu. Hãy xem bài viết Tạo tài khoản dịch vụ cho Cloud Storage hoặc BigQuery để biết thêm thông tin.

    • Nếu bạn đã tải thông tin đăng nhập lên, hãy chọn thông tin đăng nhập đó trong danh sách thả xuống. Đảm bảo rằng bạn chọn thông tin đăng nhập phù hợp với loại kho lưu trữ dữ liệu.

    • Nếu bạn đang thêm thông tin xác thực mới vào kho dữ liệu, hãy chọn Thêm mới. Trong hộp thoại, hãy nhập:

      1. Tên thông tin đăng nhập.
      2. Nội dung thông tin đăng nhập là khoá tài khoản dịch vụ JSON dành riêng cho kho lưu trữ dữ liệu của bạn, theo định nghĩa của Tạo tài khoản dịch vụ cho Cloud Storage hoặc BigQuery.
      3. Chọn Tạo.
  7. Nhập các thuộc tính dành riêng cho loại kho lưu trữ dữ liệu:

    • Đối với Google Cloud Storage:
      Thuộc tính Mô tả Bắt buộc?
      Mã dự án Mã dự án trên Google Cloud Platform.

      Để tạo một dự án trên Google Cloud Platform, hãy xem phần Tạo và quản lý dự án trong tài liệu của Google Cloud Platform.

      Tên bộ chứa Tên của bộ chứa trong Cloud Storage mà bạn muốn xuất dữ liệu phân tích sang. Thùng phải tồn tại trước khi bạn thực hiện thao tác xuất dữ liệu.

      Để tạo bộ chứa Cloud Storage, hãy xem phần Tạo bộ chứa lưu trữ trong tài liệu của Google Cloud Platform.

      Đường dẫn Thư mục để lưu trữ dữ liệu phân tích trong bộ chứa Cloud Storage.
    • Đối với BigQuery:
      Thuộc tính Mô tả Bắt buộc?
      Mã dự án Mã dự án trên Google Cloud Platform.

      Để tạo một dự án trên Google Cloud Platform, hãy xem phần Tạo và quản lý dự án trong tài liệu của Google Cloud Platform.

      Tên tập dữ liệu Tên của tập dữ liệu BigQuery mà bạn muốn xuất dữ liệu phân tích sang. Đảm bảo rằng bạn đã tạo tập dữ liệu trước khi yêu cầu xuất dữ liệu.

      Để tạo một tập dữ liệu BigQuery, hãy xem phần Tạo và sử dụng tập dữ liệu trong tài liệu của Google Cloud Platform.

      Tiền tố bảng Tiền tố cho tên của các bảng được tạo cho dữ liệu phân tích trong tập dữ liệu BigQuery.
  8. Chọn Kiểm tra kết nối để đảm bảo rằng bạn có thể dùng thông tin đăng nhập để truy cập vào kho lưu trữ dữ liệu.

    Nếu kiểm thử thành công, hãy lưu kho dữ liệu của bạn.

    Nếu kiểm tra không thành công, hãy khắc phục mọi vấn đề rồi thử lại. Di chuột lên thông báo lỗi trong giao diện người dùng để xem thêm thông tin trong chú thích.

  9. Sau khi kiểm tra kết nối thành công, hãy Lưu kho dữ liệu.

Sửa đổi kho dữ liệu

Cách sửa đổi kho dữ liệu:

  1. Đăng nhập vào https://apigee.com/edge với tư cách là quản trị viên tổ chức rồi chọn tổ chức của bạn.

  2. Chọn Quản trị > Kho dữ liệu phân tích trên thanh điều hướng bên trái. Trang Analytics Datastores (Kho dữ liệu Analytics) sẽ xuất hiện.

  3. Di chuyển con trỏ chuột lên cột Đã sửa đổi của báo cáo cần sửa đổi. Biểu tượng chỉnh sửaxoá sẽ xuất hiện.

  4. Chỉnh sửa hoặc xoá kho dữ liệu.

  5. Nếu bạn đã chỉnh sửa kho dữ liệu, hãy chọn Kiểm tra kết nối để đảm bảo rằng bạn có thể dùng thông tin đăng nhập để truy cập vào kho dữ liệu.

    Nếu thử nghiệm thành công, bạn có thể xem dữ liệu mẫu trong kho lưu trữ dữ liệu.

    Nếu kiểm tra không thành công, hãy khắc phục mọi vấn đề rồi thử lại.

  6. Sau khi kiểm tra kết nối thành công, hãy Cập nhật kho dữ liệu.

Xuất dữ liệu phân tích

Để xuất dữ liệu phân tích, hãy gửi một yêu cầu POST đến API /analytics/exports. Truyền thông tin sau trong phần nội dung yêu cầu:

  • Tên và nội dung mô tả của yêu cầu xuất
  • Phạm vi ngày của dữ liệu được xuất (giá trị chỉ có thể trải dài trong một ngày)
  • Định dạng của dữ liệu được xuất
  • Tên kho dữ liệu
  • Cho biết tổ chức có bật tính năng kiếm tiền hay không

Dưới đây là ví dụ về các yêu cầu xuất. Để xem nội dung mô tả đầy đủ về các thuộc tính của phần nội dung yêu cầu, hãy xem Tài liệu tham khảo về thuộc tính yêu cầu xuất.

Phản hồi từ yêu cầu POST có dạng:

{
    "self": "/organizations/myorg/environments/test/analytics/exports/a7c2f0dd-1b53-4917-9c42-a211b60ce35b",
    "created": "2017-09-28T12:39:35Z",
    "state": "enqueued"
}

Xin lưu ý rằng thuộc tính state trong phản hồi được đặt thành enqueued. Yêu cầu POST hoạt động không đồng bộ. Tức là yêu cầu này vẫn tiếp tục chạy ở chế độ nền sau khi trả về một phản hồi. Các giá trị có thể có cho state bao gồm: enqueued, running, completed, failed.

Sử dụng URL được trả về trong thuộc tính self để xem trạng thái của yêu cầu xuất dữ liệu, như mô tả trong phần Xem trạng thái của yêu cầu xuất dữ liệu phân tích. Khi yêu cầu hoàn tất, giá trị của thuộc tính state trong phản hồi sẽ được đặt thành completed. Sau đó, bạn có thể truy cập vào dữ liệu phân tích trong kho lưu trữ dữ liệu của mình.

Ví dụ 1: Xuất dữ liệu sang Cloud Storage

Yêu cầu sau đây sẽ xuất một bộ dữ liệu thô hoàn chỉnh trong 24 giờ qua từ môi trường kiểm thử trong tổ chức myorg. Nội dung được xuất sang Cloud Storage ở định dạng JSON:

curl -X POST -H "Content-Type:application/json" \
"https://api.enterprise.apigee.com/v1/organizations/myorg/environments/test/analytics/exports" \
  -d \
  '{
    "name": "Export raw results to Cloud Storage",
    "description": "Export raw results to Cloud Storage for last 24 hours",
    "dateRange": {
      "start": "2018-06-08", 
      "end": "2018-06-09"
    },
    "outputFormat": "json",
    "datastoreName": "My Cloud Storage data repository"
  }' \
  -u orgAdminEmail:password

Sử dụng URI do thuộc tính self chỉ định để theo dõi trạng thái của công việc như mô tả trong phần Xem trạng thái của yêu cầu xuất dữ liệu phân tích.

Ví dụ 2: Xuất dữ liệu sang BigQuery

Yêu cầu sau đây sẽ xuất một tệp CSV được phân tách bằng dấu phẩy sang BigQuery:

curl -X POST -H "Content-Type:application/json"  \
  "https://api.enterprise.apigee.com/v1/organizations/myorg/environments/test/analytics/exports" \
  -d \
  '{
    "name": "Export query results to BigQuery",
    "description": "One-time export to BigQuery",
    "dateRange": {
      "start": "2018-06-08", 
      "end": "2018-06-09"
    },
    "outputFormat": "csv",
    "csvDelimiter": ",", 
    "datastoreName": "My BigQuery data repository"
  }' \
  -u orgAdminEmail:password

Lưu ý: Tệp CSV được xuất sẽ tạo một bảng BigQuery có tiền tố sau:

<PREFIX>_<EXPORT_DATE>_api_<UUID>_from_<FROM_DATE>_to_<TO_DATE>

Sử dụng URI do thuộc tính self chỉ định để theo dõi trạng thái của công việc như mô tả trong phần Xem trạng thái của yêu cầu xuất dữ liệu phân tích.

Ví dụ 3: Xuất dữ liệu về hoạt động kiếm tiền

Nếu bật tính năng kiếm tiền trên một môi trường trong tổ chức, bạn có thể thực hiện hai loại xuất dữ liệu:

  • Xuất dữ liệu tiêu chuẩn như trong hai ví dụ trước.
  • Xuất dữ liệu về hoạt động kiếm tiền để xuất dữ liệu dành riêng cho hoạt động kiếm tiền.

Để thực hiện thao tác xuất dữ liệu kiếm tiền, hãy chỉ định "dataset":"mint" trong tải trọng yêu cầu. Tổ chức và môi trường phải hỗ trợ tính năng kiếm tiền để đặt lựa chọn này, nếu không, hãy bỏ qua thuộc tính dataset trong tải trọng:

  '{
    "name": "Export raw results to Cloud Storage",
    "description": "Export raw results to Cloud Storage for last 24 hours",
    "dateRange": {
      "start": "2018-06-08", 
      "end": "2018-06-09"
    },
    "outputFormat": "json",
    "datastoreName": "My Cloud Storage data repository",
    "dataset":"mint"
  }'

Giới thiệu về hạn mức API xuất

Để ngăn việc sử dụng quá mức các lệnh gọi API xuất dữ liệu tốn kém, Edge sẽ thực thi một hạn mức đối với các lệnh gọi đến API /analytics/exports:

  • Đối với những tổ chức và môi trường chưa bật tính năng kiếm tiền, hạn mức là:

    • 70 cuộc gọi mỗi tháng cho mỗi tổ chức/môi trường.

    Ví dụ: nếu có 2 môi trường trong tổ chức của mình, prodtest, bạn có thể thực hiện 70 lệnh gọi API mỗi tháng cho từng môi trường.

  • Đối với các tổ chức và môi trường đã bật tính năng kiếm tiền, hạn mức là:

    • 70 lệnh gọi mỗi tháng cho mỗi tổ chức và môi trường đối với dữ liệu tiêu chuẩn.
    • 70 lệnh gọi mỗi tháng cho mỗi tổ chức và môi trường đối với dữ liệu kiếm tiền.

    Ví dụ: nếu bật tính năng kiếm tiền trên tổ chức prod, bạn có thể thực hiện 70 lệnh gọi API cho dữ liệu tiêu chuẩn 70 lệnh gọi API bổ sung cho dữ liệu kiếm tiền.

Nếu bạn vượt quá hạn mức gọi, API sẽ trả về phản hồi HTTP 429.

Xem trạng thái của tất cả yêu cầu xuất dữ liệu phân tích

Để xem trạng thái của tất cả các yêu cầu xuất dữ liệu phân tích, hãy gửi yêu cầu GET đến /analytics/exports.

Ví dụ: yêu cầu sau đây trả về trạng thái của tất cả các yêu cầu xuất dữ liệu phân tích cho môi trường test trong tổ chức myorg:

curl -X GET \
  "https://api.enterprise.apigee.com/v1/organizations/myorg/environments/test/analytics/exports" \
  -u email:password

Sau đây là ví dụ về phản hồi liệt kê 2 yêu cầu xuất, một yêu cầu được xếp hàng đợi (đã tạo và đang ở trong hàng đợi) và một yêu cầu đã hoàn tất:

[
  {
    "self":
"/v1/organizations/myorg/environments/test/analytics/exports/e8b8db22-fe03-4364-aaf2-6d4f110444ba",
    "name": "Export results To Cloud Storage",
    "description": "One-time export to Google Cloud Storage",
    "userId": "my@email.com",
    "datastoreName": "My Cloud Storage data store",
    "executionTime": "36 seconds",
    "created": "2018-09-28T12:39:35Z",
    "updated": "2018-09-28T12:39:42Z",
    "state": "enqueued"
  },
  {
    "self":
"/v1/organizations/myorg/environments/test/analytics/exports/9870987089fe03-4364-aaf2-6d4f110444ba"
    "name": "Export raw results to BigQuery",
    "description": "One-time export to BigQuery",
    ... 
  }
]

Xem trạng thái của yêu cầu xuất dữ liệu phân tích

Để xem trạng thái của một yêu cầu xuất dữ liệu phân tích cụ thể, hãy gửi yêu cầu GET đến /analytics/exports/{exportId}, trong đó {exportId} là mã nhận dạng được liên kết với yêu cầu xuất dữ liệu phân tích.

Ví dụ: yêu cầu sau đây trả về trạng thái của yêu cầu xuất dữ liệu phân tích có mã nhận dạng là 4d6d94ad-a33b-4572-8dba-8677c9c4bd98.

curl -X GET \
"https://api.enterprise.apigee.com/v1/organizations/myorg/environments/test/analytics/exports/4d6d94ad-a33b-4572-8dba-8677c9c4bd98" \
-u email:password

Sau đây là ví dụ về phản hồi:

{
  "self":
"/v1/organizations/myorg/environments/test/analytics/exports/4d6d94ad-a33b-4572-8dba-8677c9c4bd98",
  "name": "Export results To Cloud Storage",
  "description": "One-time export to Google Cloud Storage",
  "userId": "my@email.com",
  "datastoreName": "My Cloud Storage data store",
  "executionTime": "36 seconds",
  "created": "2018-09-28T12:39:35Z",
  "updated": "2018-09-28T12:39:42Z",
  "state": "enqueued"
}

Nếu hoạt động xuất dữ liệu phân tích không trả về dữ liệu phân tích nào, thì executionTime sẽ được đặt thành "0 giây".

Xuất thuộc tính tham chiếu yêu cầu

Bảng sau đây mô tả các thuộc tính mà bạn có thể truyền trong nội dung yêu cầu ở định dạng JSON khi xuất dữ liệu phân tích.

Thuộc tính Mô tả Bắt buộc?
description Nội dung mô tả về yêu cầu xuất. Không
name Tên của yêu cầu xuất.
dateRange

Chỉ định ngày startend của dữ liệu cần xuất, theo định dạng yyyy-mm-dd. Ví dụ:

"dateRange": {
    "start": "2018-07-29",
    "end": "2018-07-30"
}

Giá trị dateRange chỉ có thể kéo dài trong một ngày. Phạm vi ngày bắt đầu từ 00:00:00 UTC vào ngày start và kết thúc lúc 00:00:00 UTC vào ngày end.

LƯU Ý: Để đảm bảo tất cả dữ liệu được thu thập từ ngày hôm trước, bạn có thể cần trì hoãn thời gian bắt đầu của yêu cầu xuất (ví dụ: 00:05:00 UTC).

outputFormat Chỉ định là json hoặc csv.
csvDelimiter

Dấu phân cách được dùng trong tệp đầu ra CSV, nếu outputFormat được đặt thành csv. Mặc định là ký tự , (dấu phẩy). Các ký tự phân cách được hỗ trợ bao gồm dấu phẩy (,), dấu sổ đứng (|) và dấu tab (\t).

Không
datastoreName Tên của kho dữ liệu chứa định nghĩa về kho dữ liệu của bạn.

Ví dụ:

{
    "name": "Export raw results to Cloud Storage",
    "description": "Export raw results to Cloud Storage for last 24 hours",
    "dateRange": {
      "start": "2018-06-08", 
      "end": "2018-06-09"
    },
    "outputFormat": "json",
    "datastoreName": "My Cloud Storage data repository"
  }