Menggunakan API Data Amazon Redshift

Anda dapat mengakses database Amazon Redshift menggunakan API Data Amazon Redshift bawaan. Dengan menggunakan API ini, Anda dapat mengakses data Amazon Redshift dengan aplikasi berbasis layanan web, termasuk, notebook AWS Lambda Amazon, dan. SageMaker AWS Cloud9 Untuk informasi lebih lanjut tentang aplikasi ini, lihat AWS Lambda, Amazon SageMaker, dan AWS Cloud9.

Data API tidak memerlukan koneksi persisten ke database Anda. Sebagai gantinya, ia menyediakan titik akhir HTTP yang aman dan integrasi dengan AWS SDK. Anda dapat menggunakan titik akhir untuk menjalankan pernyataan SQL tanpa mengelola koneksi. Panggilan ke API Data bersifat asinkron.

Data API menggunakan kredensil yang disimpan dalam AWS Secrets Manager atau kredenal database sementara. Anda tidak perlu meneruskan kata sandi dalam panggilan API dengan salah satu metode otorisasi. Untuk informasi lebih lanjut tentang AWS Secrets Manager, lihat Apa itu AWS Secrets Manager? dalam AWS Secrets Manager User Guide.

Untuk informasi selengkapnya tentang operasi Data API, lihat Referensi API Data Amazon Redshift.

Bekerja dengan Amazon Redshift Data API

Sebelum Anda menggunakan Amazon Redshift Data API, tinjau langkah-langkah berikut:

1. Tentukan apakah Anda, sebagai pemanggil API Data, diotorisasi. Untuk informasi selengkapnya tentang otorisasi, lihatMengotorisasi akses ke API Data Amazon Redshift.

2. Tentukan apakah Anda berencana untuk memanggil Data API dengan kredensyal otentikasi dari Secrets Manager atau kredensyal sementara. Untuk informasi selengkapnya, lihat Memilih kredensi otentikasi database saat memanggil Amazon Redshift Data API.

3. Siapkan rahasia jika Anda menggunakan Secrets Manager untuk kredensi otentikasi. Untuk informasi selengkapnya, lihat Menyimpan kredensi basis data di AWS Secrets Manager.

4. Tinjau pertimbangan dan batasan saat memanggil Data API. Untuk informasi selengkapnya, lihat Pertimbangan saat memanggil Amazon Redshift Data API.

5. Panggil API Data dari AWS Command Line Interface (AWS CLI), dari kode Anda sendiri, atau menggunakan editor kueri di konsol Amazon Redshift. Untuk contoh panggilan dari AWS CLI, lihatMemanggil API Data.

Pertimbangan saat memanggil Amazon Redshift Data API

Pertimbangkan hal berikut saat memanggil Data API:

• Amazon Redshift Data API dapat mengakses database di klaster yang disediakan Amazon Redshift dan grup kerja Tanpa Server Redshift. Untuk daftar Wilayah AWS tempat API Data Redshift tersedia, lihat titik akhir yang tercantum untuk Redshift Data API di. Referensi Umum Amazon Web Services

• Durasi maksimum kueri adalah 24 jam.

• Jumlah maksimum kueri aktif (STARTEDdan SUBMITTED kueri) per cluster Amazon Redshift adalah 200.

• Ukuran hasil kueri maksimum adalah 100 MB (setelah kompresi gzip). Jika panggilan mengembalikan lebih dari 100 MB data respons, panggilan akan berakhir.

• Waktu retensi maksimum untuk hasil kueri adalah 24 jam.

• Ukuran pernyataan kueri maksimum adalah 100 KB.

• Data API tersedia untuk kueri cluster single-node dan multiple-node dari tipe node berikut:

  • dc2.large

  • dc2.8xlarge

  • ra3.xlplus

  • ra3.4xlarge

  • ra3.16xlarge

• Cluster harus berada di cloud pribadi virtual (VPC) berdasarkan layanan Amazon VPC.

• Secara default, pengguna dengan peran IAM atau izin IAM yang sama dengan pelari operasi ExecuteStatement atau BatchExecuteStatement API dapat bertindak berdasarkan pernyataan yang sama denganCancelStatement,, DescribeStatementGetStatementResult, dan operasi API. ListStatements Untuk bertindak pada pernyataan SQL yang sama dari pengguna lain, pengguna harus dapat mengambil peran IAM dari pengguna yang menjalankan pernyataan SQL. Untuk informasi selengkapnya tentang cara mengambil peran, lihatMengotorisasi akses ke API Data Amazon Redshift.

• Pernyataan SQL dalam Sqls parameter operasi BatchExecuteStatement API dijalankan sebagai satu transaksi. Mereka berjalan secara serial dalam urutan array. Pernyataan SQL berikutnya tidak dimulai sampai pernyataan sebelumnya dalam array selesai. Jika pernyataan SQL gagal, maka karena mereka dijalankan sebagai satu transaksi, semua pekerjaan digulirkan kembali.

• Waktu retensi maksimum untuk token klien yang digunakan dalam ExecuteStatement atau operasi BatchExecuteStatement API adalah 8 jam.

• Setiap API di Redshift Data API memiliki kuota transaksi per detik sebelum membatasi permintaan. Untuk kuota, lihatKuota untuk Amazon Redshift Data API. Jika tingkat permintaan melebihi kuota, a ThrottlingException dengan Kode Status HTTP: 400 dikembalikan. Untuk merespons pembatasan, gunakan strategi coba lagi seperti yang dijelaskan dalam Perilaku Coba lagi di AWS SDK and Tools Reference Guide. Strategi ini diterapkan secara otomatis untuk membatasi kesalahan di beberapa AWS SDK.

  catatan

  Secara default di AWS Step Functions, percobaan ulang tidak diaktifkan. Jika Anda perlu memanggil Redshift Data API di mesin status Step Functions, sertakan parameter ClientToken idempotency dalam panggilan Redshift Data API Anda. Nilai ClientToken kebutuhan untuk bertahan di antara percobaan ulang. Dalam contoh cuplikan permintaan ExecuteStatement API berikut, ekspresi States.ArrayGetItem(States.StringSplit($$.Execution.Id, ':'), 7) menggunakan fungsi intrinsik untuk mengekstrak bagian UUID$$.Execution.Id, yang unik untuk setiap eksekusi mesin status. Untuk informasi selengkapnya, lihat Fungsi intrinsik di Panduan AWS Step Functions Pengembang.

  {
    "Database": "dev",
    "Sql": "select 1;",
    "ClusterIdentifier": "MyCluster",
    "ClientToken.$": "States.ArrayGetItem(States.StringSplit($$.Execution.Id, ':'), 7)"
  }

Memilih kredensi otentikasi database saat memanggil Amazon Redshift Data API

Saat memanggil Data API, Anda menggunakan salah satu metode otentikasi berikut untuk beberapa operasi API. Setiap metode membutuhkan kombinasi parameter yang berbeda.

AWS Secrets Manager

Dengan metode ini, berikan rahasia secret-arn yang disimpan di AWS Secrets Manager mana memiliki username danpassword. Rahasia yang ditentukan berisi kredensil untuk terhubung ke yang database Anda tentukan. Ketika Anda menghubungkan ke cluster, Anda juga menyediakan nama database, Jika Anda memberikan identifier cluster (dbClusterIdentifier), itu harus cocok dengan identifier cluster yang disimpan dalam rahasia. Saat Anda menghubungkan ke workgroup tanpa server, Anda juga menyediakan nama database. Untuk informasi selengkapnya, lihat Menyimpan kredensi basis data di AWS Secrets Manager.

Kredensial sementara

Dengan metode ini, pilih salah satu opsi berikut:

• Saat menghubungkan ke workgroup tanpa server, tentukan nama workgroup dan nama database. Nama pengguna database berasal dari identitas IAM. Misalnya, arn:iam::123456789012:user:foo memiliki nama pengguna databaseIAM:foo. Juga, izin untuk memanggil redshift-serverless:GetCredentials operasi diperlukan.

• Saat menghubungkan ke cluster sebagai identitas IAM, tentukan pengidentifikasi cluster dan nama database. Nama pengguna database berasal dari identitas IAM. Misalnya, arn:iam::123456789012:user:foo memiliki nama pengguna databaseIAM:foo. Juga, izin untuk memanggil redshift:GetClusterCredentialsWithIAM operasi diperlukan.

• Saat menghubungkan ke cluster sebagai pengguna database, tentukan pengidentifikasi cluster, nama database, dan nama pengguna database. Juga, izin untuk memanggil redshift:GetClusterCredentials operasi diperlukan. Untuk informasi tentang cara bergabung dengan grup database saat menghubungkan dengan metode ini, lihatBergabung dengan grup basis data saat menghubungkan ke klaster.

Dengan metode ini, Anda juga dapat memberikan region nilai yang menentukan di Wilayah AWS mana data Anda berada.

Memetakan tipe data JDBC saat memanggil Amazon Redshift Data API

Tabel berikut memetakan tipe data Java Database Connectivity (JDBC) ke jenis data yang Anda tentukan dalam panggilan API Data.

Jenis data JDBC	Jenis data API Data
INTEGER, SMALLINT, BIGINT	LONG
FLOAT, REAL, DOUBLE	DOUBLE
DECIMAL	STRING
BOOLEAN, BIT	BOOLEAN
BLOB, BINARY, LONGVARBINARY	BLOB
VARBINARY	STRING
CLOB	STRING
Jenis lainnya (termasuk jenis yang terkait dengan tanggal dan waktu)	STRING

Nilai string diteruskan ke database Amazon Redshift dan secara implisit diubah menjadi tipe data database.

catatan

Saat ini, Data API tidak mendukung array pengidentifikasi unik universal (UUID).

Menjalankan pernyataan SQL dengan parameter saat memanggil Amazon Redshift Data API

Anda dapat mengontrol teks SQL yang dikirimkan ke mesin database dengan memanggil operasi Data API menggunakan parameter untuk bagian dari pernyataan SQL. Parameter bernama menyediakan cara yang fleksibel untuk meneruskan parameter tanpa hardcoding mereka dalam teks SQL. Mereka membantu Anda menggunakan kembali teks SQL dan menghindari masalah injeksi SQL.

Contoh berikut menunjukkan parameter bernama dari parameters bidang execute-statement AWS CLI perintah.

--parameters "[{\"name\": \"id\", \"value\": \"1\"},{\"name\": \"address\", \"value\": \"Seattle\"}]"

Pertimbangkan hal berikut saat menggunakan parameter bernama:

• Parameter bernama hanya dapat digunakan untuk mengganti nilai dalam pernyataan SQL.

  • Anda dapat mengganti nilai dalam pernyataan INSERT, sepertiINSERT INTO mytable VALUES(:val1).

    Parameter bernama dapat dalam urutan apa pun dan parameter dapat digunakan lebih dari satu kali dalam teks SQL. Opsi parameter yang ditunjukkan dalam contoh sebelumnya, nilai-nilai 1 dan Seattle dimasukkan ke dalam kolom tabel id danaddress. Dalam teks SQL, Anda menentukan parameter bernama sebagai berikut:

    --sql "insert into mytable values (:id, :address)"

  • Anda dapat mengganti nilai dalam klausa kondisi, sepertiWHERE attr >= :val1,WHERE attr BETWEEN :val1 AND :val2, danHAVING COUNT(attr) > :val.

  • Anda tidak dapat mengganti nama kolom dalam pernyataan SQL, sepertiSELECT column-name,ORDER BY column-name, atauGROUP BY column-name.

    Misalnya, pernyataan SELECT berikut gagal dengan sintaks yang tidak valid.

    --sql "SELECT :colname, FROM event" --parameters "[{\"name\": \"colname\", \"value\": \"eventname\"}]"

    Jika Anda menjelaskan (describe-statementoperasi) pernyataan dengan kesalahan sintaks, yang QueryString dikembalikan tidak menggantikan nama kolom untuk parameter ("QueryString": "SELECT :colname, FROM event"), dan kesalahan dilaporkan (ERROR: kesalahan sintaks di atau dekat\ "FROM\”\nPosisi: 12).

  • Anda tidak dapat mengganti nama kolom dalam fungsi agregat, sepertiCOUNT(column-name),AVG(column-name), atauSUM(column-name).

  • Anda tidak dapat mengganti nama kolom dalam klausa JOIN.

• Ketika SQL berjalan, data secara implisit dilemparkan ke tipe data. Untuk informasi selengkapnya tentang casting tipe data, lihat Tipe data di Panduan Pengembang Database Amazon Redshift.

• Anda tidak dapat menetapkan nilai ke NULL. Data API menafsirkannya sebagai string NULL literal. Contoh berikut menggantikan id dengan string null literal. Bukan nilai SQL NULL.

  --parameters "[{\"name\": \"id\", \"value\": \"null\"}]"

• Anda tidak dapat menetapkan nilai panjang nol. Pernyataan Data API SQL gagal. Contoh berikut mencoba untuk mengatur id dengan nilai panjang nol dan menghasilkan kegagalan pernyataan SQL.

  --parameters "[{\"name\": \"id\", \"value\": \"\"}]"

• Anda tidak dapat mengatur nama tabel dalam pernyataan SQL dengan parameter. Data API mengikuti aturan JDBCPreparedStatement.

• Output dari describe-statement operasi mengembalikan parameter query dari pernyataan SQL.

• Hanya execute-statement operasi yang mendukung pernyataan SQL dengan parameter.

Menjalankan pernyataan SQL dengan token idempotensi saat memanggil Amazon Redshift Data API

Saat Anda membuat permintaan API yang bermutasi, permintaan biasanya menampilkan hasil sebelum alur kerja asinkron operasi selesai. Operasi mungkin juga habis waktu atau mengalami masalah server lain sebelum selesai, meskipun permintaan telah mengembalikan hasilnya. Hal ini dapat membuat sulit untuk menentukan apakah permintaan berhasil atau tidak, dan dapat menyebabkan beberapa percobaan ulang untuk memastikan bahwa operasi selesai dengan sukses. Namun, jika permintaan asli dan percobaan ulang berikutnya berhasil, operasi selesai beberapa kali. Ini berarti Anda dapat memperbarui lebih banyak sumber daya daripada yang Anda inginkan.

Idempotency memastikan bahwa permintaan API selesai tidak lebih dari satu kali. Dengan permintaan idempoten, jika permintaan asli berhasil diselesaikan, percobaan ulang berikutnya berhasil diselesaikan tanpa melakukan tindakan lebih lanjut. Data API ExecuteStatement dan BatchExecuteStatement operasi memiliki parameter ClientToken idempoten opsional. ClientTokenKedaluwarsa setelah 8 jam.

penting

Jika Anda memanggil ExecuteStatement dan BatchExecuteStatement mengoperasikannya dari AWS SDK, secara otomatis akan menghasilkan token klien untuk digunakan saat mencoba lagi. Dalam hal ini, kami tidak menyarankan menggunakan client-token parameter dengan ExecuteStatement dan BatchExecuteStatement operasi. Lihat CloudTrail log untuk melihatClientToken. Untuk contoh CloudTrail log, lihatContoh API Data Amazon Redshift.

execute-statement AWS CLI Perintah berikut mengilustrasikan client-token parameter opsional untuk idempotensi.

aws redshift-data execute-statement 
    --region us-west-2 
    --secret arn:aws:secretsmanager:us-west-2:123456789012:secret:myuser-secret-hKgPWn 
    --cluster-identifier mycluster-test 
    --sql "select * from stl_query limit 1" 
    --database dev 
    --client-token b855dced-259b-444c-bc7b-d3e8e33f94g1                       

Tabel berikut menunjukkan beberapa tanggapan umum yang mungkin Anda dapatkan untuk permintaan API idempoten, dan memberikan rekomendasi coba ulang.

Respons	Rekomendasi	Komentar
200 (OK)	Jangan coba lagi	Permintaan asli berhasil diselesaikan. Setiap percobaan ulang berikutnya berhasil kembali.
Kode respons 400 seri	Jangan coba lagi	Ada masalah dengan permintaan, dari antara yang berikut: Ini termasuk parameter atau kombinasi parameter yang tidak valid. Ini menggunakan tindakan atau sumber daya yang Anda tidak memiliki izin. Ini menggunakan sumber daya yang sedang dalam proses mengubah keadaan. Jika permintaan melibatkan sumber daya yang sedang dalam proses mengubah status, mencoba kembali permintaan mungkin berhasil.
Kode respons 500 seri	Coba lagi	Kesalahan ini disebabkan oleh masalah AWS sisi server dan umumnya bersifat sementara. Ulangi permintaan dengan strategi backoff yang sesuai.

Untuk informasi tentang kode respons Amazon Redshift, lihat Kesalahan Umum di Referensi API Amazon Redshift.