Gunakan Alibaba Cloud CLI untuk mengelola MaxCompute - MaxCompute

Topik ini menjelaskan cara menggunakan Alibaba Cloud Command Line Interface (CLI) untuk memanggil MaxCompute OpenAPI, dengan contoh pemanggilan API ListProjects untuk mendapatkan daftar proyek MaxCompute.

Informasi latar belakang

Alibaba Cloud CLI adalah alat baris perintah berbasis OpenAPI yang memungkinkan otomatisasi tugas manajemen dan pemeliharaan untuk MaxCompute. Untuk informasi lebih lanjut, lihat Apa itu Alibaba Cloud CLI?

Langkah 1: Instal Alibaba Cloud CLI

Pilih paket instalasi yang sesuai untuk sistem operasi Anda.

Windows: Instal Alibaba Cloud CLI di Windows
Linux: Instal Alibaba Cloud CLI di Linux
macOS: Instal Alibaba Cloud CLI di macOS

Cloud Shell sudah terinstal dengan Alibaba Cloud CLI dan secara otomatis mengonfigurasi kredensial identitas Anda, menyederhanakan proses pengaturan. Anda dapat menguji perintah Alibaba Cloud CLI di Cloud Shell. Untuk informasi lebih lanjut, lihat Apa itu Cloud Shell?

Langkah 2: Konfigurasikan Alibaba Cloud CLI

Penting

Untuk alasan keamanan, kami merekomendasikan agar Anda membuat Pengguna Resource Access Management (RAM) dan menetapkan izin berdasarkan prinsip hak istimewa minimal saat mengakses OpenAPI. Untuk informasi lebih lanjut tentang kebijakan yang didukung oleh MaxCompute, lihat Kebijakan berbasis identitas.

Alibaba Cloud CLI mendukung berbagai jenis kredensial. Untuk informasi lebih lanjut, lihat Jenis kredensial. Anda dapat menggunakan AccessKey dari pengguna RAM untuk mengonfigurasi kredensial identitasnya. Ikuti langkah-langkah berikut untuk menyiapkan kredensial tipe AK:

Buat pengguna RAM dan pasangan AccessKey untuk mengonfigurasi kredensial identitas. Untuk informasi lebih lanjut, lihat Buat pengguna RAM dan Buat pasangan AccessKey.
Berikan izin kepada pengguna RAM. Dalam contoh ini, tetapkan akses baca-saja untuk MaxCompute kepada pengguna RAM dengan menggunakan kebijakan AliyunMaxComputeReadOnlyAccess. Untuk informasi lebih lanjut, lihat Berikan izin kepada pengguna RAM.
Dapatkan ID wilayah untuk operasi Anda. Alibaba Cloud CLI menggunakan ID wilayah yang ditentukan untuk memulai panggilan API. Untuk wilayah yang tersedia untuk MaxCompute, lihat Endpoints.
Catatan
Saat menggunakan Alibaba Cloud CLI, Anda dapat menentukan wilayah dengan opsi --region dan parameternya region. Setelah menentukan wilayah yang valid, Alibaba Cloud CLI akan mengabaikan wilayah dalam konfigurasi kredensial identitas default dan variabel lingkungan, serta menggunakan wilayah yang ditentukan untuk menjalankan perintah. Untuk informasi lebih lanjut, lihat Opsi baris perintah.
Konfigurasikan kredensial tipe AK menggunakan AccessKey dari pengguna RAM dan namai file konfigurasi AkProfile. Untuk informasi lebih lanjut, lihat Contoh konfigurasi.

Langkah 3: Hasilkan perintah CLI sampel

Kunjungi atau Alamat debugging ListProjects.
Masukkan parameter permintaan di bagian Parameters dan klik tab CLI Example untuk melihat perintah CLI yang dihasilkan.
Salin perintah CLI atau jalankan dengan cepat di Cloud Shell:
- Klik tombol Run Command untuk membuka Cloud Shell dan selesaikan debugging perintah.
- Klik tombol Copy untuk menyalin perintah CLI ke clipboard Anda. Anda kemudian dapat menempelkannya ke shell lokal Anda untuk menjalankannya atau memodifikasinya untuk skrip baris perintah otomatis.
Catatan
Saat menempelkan perintah CLI ke shell lokal Anda untuk pengujian, pastikan format parameternya benar. Untuk detail tentang format parameter dalam perintah Alibaba Cloud CLI, lihat Format parameter.
Portal OpenAPI secara otomatis menyertakan opsi --region dalam perintah yang dihasilkan. Saat menjalankan perintah secara lokal, Alibaba Cloud CLI memprioritaskan wilayah yang ditentukan daripada konfigurasi kredensial identitas default dan pengaturan variabel lingkungan. Anda dapat memilih untuk menyimpan atau menghapus opsi ini sesuai kebutuhan.

Langkah 4: Panggil MaxCompute OpenAPI

Contoh 1: Dapatkan daftar OpenAPI

Contoh berikut menunjukkan cara menggunakan opsi --help untuk mengambil daftar operasi MaxCompute OpenAPI yang didukung oleh Alibaba Cloud CLI. Untuk informasi lebih lanjut, lihat Daftar operasi berdasarkan fungsi.

Jalankan perintah berikut:
```
aliyun maxcompute --help
```
Output yang diharapkan:

Contoh 2: Dapatkan daftar proyek

Contoh berikut menunjukkan cara menggunakan Alibaba Cloud CLI untuk memanggil MaxCompute API ListProjects untuk memfilter dan mengambil daftar proyek MaxCompute berdasarkan parameter input. Untuk detail API, lihat ListProjects.

Jalankan perintah berikut:

aliyun maxcompute GET /api/v1/projects --tenantId '5495****3697' --quotaName 'aliyun_5495***3697' --header "Content-Type=application/json;"

Output yang diharapkan:

{
  "requestId": "0b16399216671970335563173e2340",
  "data": {
    "projects": [
      {
        "name": "odps_project",
        "owner": "ALIYUN$odps****@aliyunid.com\n",
        "type": "managed",
        "comment": "BI_Analysis",
        "defaultQuota": "os_PayAsYouGoQuota\n",
        "status": "AVAILABLE",
        "costStorage": "16489027",
        "regionId": "cn-beijing",
        "createdTime": 1704380838000,
        "properties": {
          "timezone": "Asia/Shanghai\n",
          "retentionDays": 1,
          "allowFullScan": false,
          "typeSystem": "2",
          "enableDecimal2": true,
          "sqlMeteringMax": "1500",
          "tableLifecycle": {
            "type": "optional",
            "value": "37231\n"
          },
          "encryption": {
            "enable": true,
            "algorithm": "AES256",
            "key": "dafault"
          },
          "tunnelQuota": "Default",
          "enableTunnelQuotaRoute": true,
          "externalProjectProperties": {
            "isExternalCatalogBound": "true"
          }
        },
        "securityProperties": {
          "usingAcl": true,
          "usingPolicy": true,
          "objectCreatorHasAccessPermission": true,
          "objectCreatorHasGrantPermission": true,
          "labelSecurity": false,
          "enableDownloadPrivilege": false,
          "projectProtection": {
            "protected": true,
            "exceptionPolicy": "{\n      \"Version\": \"1\",\n      \"Statement\": [\n            {\n                  \"Effect\": \"Allow\",\n                  \"Principal\": \"\",\n                  \"Action\": [\n                        \"odps:[, , ...]\"\n                  ],\n                  \"Resource\": \"acs:odps:*:\",\n                  \"Condition\": {\n                        \"StringEquals\": {\n                              \"odps:TaskType\": [\n                                    \"\"\n                              ]\n                        }\n                  }\n            }\n      ]\n}"
          }
        },
        "ipWhiteList": {
          "ipList": "10.88.111.3",
          "vpcIpList": "10.88.111.3"
        },
        "saleTag": {
          "resourceId": "b7afb7d1-****-****-****-c393669c307b\n",
          "resourceType": "PayAsYouGo\n"
        },
        "threeTierModel": true
      }
    ],
    "marker": "cHlvZHBzX3VkZl8xMDExNV8xNDU3NDI4NDkzKg==",
    "maxItem": 10,
    "NextToken": "AAAAAV3MpHK1AP0pfERHZN5pu6kvikyUl3ChyRxN+qLPvtOb"
  }
}

Catatan

Jika terjadi kesalahan setelah memanggil MaxCompute OpenAPI, verifikasi parameter permintaan dan nilainya terhadap kode kesalahan yang dikembalikan.

Anda dapat mencatat RequestID dari panggilan atau pesan kesalahan dari SDK. Untuk diagnosis mandiri, gunakan atau Platform Diagnostik OpenAPI Alibaba Cloud.