Gunakan Alibaba Cloud CLI untuk mengelola MaxCompute - MaxCompute

Contoh ini memanggil API MaxCompute ListProjects untuk menampilkan daftar proyek MaxCompute, yang menunjukkan cara memanggil OpenAPI MaxCompute.

Ikhtisar

Alibaba Cloud Command Line Interface (CLI) adalah alat command-line berbasis OpenAPI untuk mengotomatiskan operasi MaxCompute. Apa itu Alibaba Cloud CLI?

Langkah 1: Instal Alibaba Cloud CLI

Instal Alibaba Cloud CLI sesuai sistem operasi Anda:

Di Cloud Shell, Alibaba Cloud CLI telah dipra-instal dengan konfigurasi kredensial otomatis. Anda dapat langsung melakukan debug perintah di Cloud Shell. Apa itu Cloud Shell?

Langkah 2: Konfigurasikan Alibaba Cloud CLI

Penting

Akun Alibaba Cloud (akun root) memiliki izin penuh untuk semua operasi OpenAPI, sehingga menimbulkan risiko keamanan tinggi. Kami menyarankan Anda membuat RAM user, memberikan izin berdasarkan prinsip hak istimewa minimal, dan menggunakan RAM user tersebut untuk operasi OpenAPI. Untuk MaxCompute, lihat Kebijakan berbasis identitas.

Konfigurasikan kredensial dan ID wilayah sebelum menggunakan Alibaba Cloud CLI. Beberapa jenis kredensial didukung. Konfigurasikan dan kelola kredensial. Anda dapat menggunakan AccessKey dari RAM user untuk mengonfigurasi kredensial tipe AK:

Buat RAM user dan Buat AccessKey.
Berikan izin AliyunMaxComputeReadOnlyAccess kepada RAM user untuk akses read-only ke MaxCompute. Kelola izin RAM user.
Dapatkan ID wilayah. Alibaba Cloud CLI memanggil OpenAPI dari wilayah yang ditentukan. Untuk daftar wilayah MaxCompute, lihat Endpoint.

Catatan
Opsi --region menggantikan wilayah dalam konfigurasi kredensial dan variabel lingkungan Anda. Opsi command-line.
Konfigurasikan kredensial tipe AK menggunakan AccessKey dan nama RAM user, lalu beri nama profil tersebut AkProfile. Konfigurasikan dan kelola kredensial.

Langkah 3: Hasilkan contoh perintah CLI

Di portal OpenAPI, buka halaman debugging ListProjects.

Pada panel kiri, pilih wilayah dari daftar drop-down Service Address (misalnya, China (Hangzhou)) dan masukkan parameter permintaan seperti tenantId, region, quotaNickName, dan quotaName. Klik tab CLI Example di sebelah kanan untuk melihat perintah yang dihasilkan.
Pada bagian Parameter Configuration, masukkan parameter permintaan dan klik tab CLI Example untuk melihat perintah CLI yang dihasilkan.
Salin perintah CLI atau jalankan di Cloud Shell:
- Klik tombol Run Command untuk membuka Cloud Shell dan langsung melakukan debug perintah.
- Klik tombol Copy untuk menyalin perintah CLI ke clipboard. Anda kemudian dapat menempelkannya ke tool shell lokal untuk menjalankannya atau mengeditnya untuk skrip otomatisasi.
Catatan
Saat menempelkan perintah ke shell lokal, pastikan format parameternya sesuai dengan persyaratan dalam Memahami parameter perintah.

Perintah yang dihasilkan secara default menyertakan opsi --region, yang menggantikan wilayah dalam konfigurasi kredensial dan variabel lingkungan Anda. Hapus atau pertahankan opsi ini sesuai kebutuhan.

Langkah 4: PanggilMaxCompute OpenAPI

Contoh 1: Tampilkan daftar operasi OpenAPI yang tersedia

Gunakan opsi --help untuk menampilkan daftar operasi OpenAPI MaxCompute yang didukung oleh Alibaba Cloud CLI. Ikhtisar API.

Jalankan perintah berikut.
```
aliyun maxcompute --help
```

Output:

shell@Alicloud:~$ aliyun maxcompute --help
Alibaba Cloud CLI, Version 3.0.234
Usage 1:
    aliyun maxcompute [GET|PUT|POST|DELETE] <PathPattern> --body "..."
Usage 2 (For API with NO PARAMS in PathPattern only.):
    aliyun maxcompute <ApiName> --parameter1 value1 --parameter2 value2 ... --body "..."
Product: MaxCompute ()
Version: 2022-01-04
Available Api List:
  CreatePackage          : POST /api/v1/projects/[projectName]/packages
  CreateProject          : POST /api/v1/projects
  CreateQuotaPlan        : POST /api/v1/quotas/[nickname]/plans
  CreateRole             : POST /api/v1/projects/[projectName]/roles
  DeleteQuotaPlan        : DELETE /api/v1/quotas/[nickname]/plans/[planName]
  GetJobResourceUsage    : GET /api/v1/jobs/resourceUsage
  GetPackage             : GET /api/v1/projects/[projectName]/packages/[packageName]

Contoh 2: Tampilkan daftar proyek

Panggil operasi API MaxCompute ListProjects untuk memfilter dan mengambil daftar proyek MaxCompute. Tampilkan daftar proyek.

Jalankan perintah.

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

Output:

{
  "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 pemanggilan API MaxCompute mengembalikan error, verifikasi parameter permintaan Anda terhadap kode kesalahan yang dikembalikan.

Catat RequestID atau pesan error SDK dan gunakan Alibaba Cloud OpenAPI Diagnostics Platform untuk diagnostik self-service.