Anda sedang melihat dokumentasi Apigee Edge.
Buka dokumentasi
Apigee X. info
Antarmuka Command Line (CLI) apigee-remote-service-cli membantu Anda menyediakan dan mengelola Apigee Adapter for Envoy.
Perintah pengikatan
Pengikatan mengaitkan layanan yang di-deploy ke mesh Istio dengan produk API Apigee. CLI memungkinkan Anda mencantumkan dan memverifikasi binding.
Mencantumkan pengikatan
Mencantumkan semua produk API yang terikat ke Layanan Jarak Jauh.
Penggunaan
Untuk Edge Public Cloud:
apigee-remote-service-cli bindings list -o [organization] -e [environment] -u [username] -p [password]
Untuk Edge Private Cloud:
apigee-remote-service-cli bindings list -o [organization] -e [environment] -u [username] -p [password] -r [runtime]
Parameter
| Parameter | Jenis | Deskripsi |
|---|---|---|
-c, --config
|
String | (Wajib) Jalur ke file konfigurasi Apigee Remote Service. Tips: Dengan tanda ini, Anda dapat menghilangkan sebagian besar parameter perintah lainnya, karena CLI dapat menariknya langsung dari file konfigurasi. Lihat Menggunakan opsi --config.
|
-e, --env
|
String | (Wajib) Lingkungan di organisasi Anda. |
-h, --help
|
Menampilkan bantuan untuk parameter perintah. | |
--insecure
|
Mengizinkan koneksi server yang tidak aman saat menggunakan SSL | |
--legacy
|
Tetapkan tanda ini jika Anda menggunakan Apigee Edge Cloud. Tindakan ini menetapkan URL pengelolaan dan runtime untuk Edge Cloud. | |
--mfa
|
Token otorisasi multi-faktor Apigee (hanya digunakan dengan --legacy)
|
|
--opdk
|
Tetapkan tanda ini jika Anda menggunakan Apigee Edge for Private Cloud. | |
-o, --org
|
String | (Wajib) Organisasi Apigee. Anda harus menjadi administrator organisasi. |
-p, --password
|
String | (Hanya diperlukan untuk autentikasi dasar) Sandi Apigee Anda. Anda dapat secara opsional menentukan
sandi dalam file .netrc. Jika Anda melakukannya, Anda tidak perlu
memberikan sandi di command line. Lihat juga
Menggunakan .netrc untuk kredensial.
|
-r, --runtime
|
String | (Khusus Private Cloud) Menentukan URL runtime untuk instance Private Cloud Anda. |
-t, --token
|
String | (Hanya diperlukan untuk autentikasi token OAuth) Token OAuth atau SAML yang Anda buat dari informasi akun Apigee Anda. Untuk mengetahui informasi tentang cara membuat token, lihat Menggunakan get_token dan Mengakses Management API dengan SAML. |
-u, --username
|
String | (Hanya diperlukan untuk autentikasi dasar) Nama pengguna Apigee Anda (biasanya alamat email).
Anda dapat secara opsional menentukan nama pengguna dalam file .netrc. Jika Anda melakukannya, maka
Anda tidak perlu memberikan nama pengguna di command line. Lihat
juga Menggunakan .netrc untuk kredensial.
|
-v, --verbose
|
(Opsional) Menghasilkan output panjang. |
Contoh
apigee-remote-service-cli bindings list -o myorg -e test -u user@example.com -c config.yaml -p abc123
PI Products
============
Bound
-----
envoy-test:
Quota: 5 requests every 1 minute
Target bindings:
httpbin.org
Paths:
httpbin:
Quota: 5 requests every 1 minute
Target bindings:
httpbin.org
Paths:
/httpbin
/
Unbound
-------
product-1:
Quota: 100 requests every 1 hour
product-2:
Quota: 1000 requests every 1 month
product-3:
product-4:
Memverifikasi binding
Verifikasi bahwa produk API terikat yang ditentukan dan aplikasi developer terkaitnya juga memiliki produk layanan jarak jauh yang terkait dengannya. Jika Anda tidak menentukan nama produk API, maka perintah akan memeriksa semua produk terikat.
Penggunaan
Untuk Edge Public Cloud:
apigee-remote-service-cli bindings verify [product_name] -o [organization] -e [environment] -u [username] -p [password] -c [config]
Untuk Edge Private Cloud:
apigee-remote-service-cli bindings verify [product_name] -o [organization] -e [environment] -u [username] -p [password] -r [runtime] -c [config]
Dengan product_name bersifat opsional. Jika Anda tidak menentukan nama produk, semua produk yang terikat akan diperiksa.
Parameter
| Parameter | Jenis | Deskripsi |
|---|---|---|
-c, --config
|
String | (Wajib) Jalur ke file konfigurasi Apigee Remote Service. Tips: Dengan tanda ini, Anda dapat menghilangkan sebagian besar parameter perintah lainnya, karena CLI dapat menariknya langsung dari file konfigurasi. Lihat Menggunakan opsi --config.
|
-e, --env
|
String | (Wajib) Lingkungan di organisasi Anda. |
-h, --help
|
Menampilkan bantuan untuk parameter perintah. | |
--insecure
|
Mengizinkan koneksi server yang tidak aman saat menggunakan SSL | |
--legacy
|
Tetapkan tanda ini jika Anda menggunakan Apigee Edge Cloud. Tindakan ini menetapkan URL pengelolaan dan runtime untuk Edge Cloud. | |
--mfa
|
Token otorisasi multi-faktor Apigee (hanya digunakan dengan --legacy)
|
|
--opdk
|
Tetapkan tanda ini jika Anda menggunakan Apigee Edge for Private Cloud. | |
-o, --org
|
String | (Wajib) Organisasi Apigee. Anda harus menjadi administrator organisasi. |
-r, --runtime
|
String | (Khusus Private Cloud) Menentukan URL runtime untuk instance Private Cloud Anda. |
-t, --token
|
String | (Hanya diperlukan untuk autentikasi token OAuth) Token OAuth atau SAML yang Anda buat dari informasi akun Apigee Anda. Untuk mengetahui informasi tentang cara membuat token, lihat Menggunakan get_token dan Mengakses Management API dengan SAML. |
-v, --verbose
|
(Opsional) Menghasilkan output panjang. |
Contoh
./apigee-remote-service-cli bindings verify my-product -o myorg -e test -u user@example.com -c config.yaml -p xxxxxx app my-app associated with product my-product is verified
Perintah bantuan
Bantuan online disediakan untuk semua perintah apigee-remote-service-cli. Cukup ketik:
apigee-remote-service-cli help
Untuk mendapatkan bantuan terkait perintah apa pun, ketik:
apigee-remote-service-cli [command] help
Contoh:
apigee-remote-service-cli provision help
Perintah penyediaan
Perintah apigee-remote-service-cli provision menginstal proxy di organisasi Apigee Edge Anda, menyiapkan sertifikat, dan menghasilkan kredensial yang akan Anda perlukan untuk mengonfigurasi Apigee Adapter for Envoy.
Penggunaan
Jika Anda menggunakan Edge Public Cloud:
apigee-remote-service-cli provision -o $ORG -e $ENV -u $USERNAME -p $PASSWORD
Jika Anda menggunakan Edge Private Cloud:
apigee-remote-service-cli provision --opdk -o $ORG -e $ENV -u $USERNAME --management $MGMT_SERVER_URL --runtime $RUNTIME_URL -p $PASSWORD
Parameter
| Parameter | Jenis | Deskripsi |
|---|---|---|
--analytics-sa
|
String | Flag ini hanya
tersedia untuk penginstalan Apigee Hybrid dan Apigee di Google Cloud.
Gunakan tanda ini untuk menentukan jalur ke file kunci akun layanan Google Cloud, dengan
akun layanan memiliki peran |
-c, --config
|
String | Jalur ke file konfigurasi Apigee Remote Service. Lihat juga
Menggunakan opsi --config.
|
-e, --environment
|
String | (Wajib) Lingkungan di organisasi Anda. |
-f, --force-proxy-install
|
(Opsional) Memaksa proxy remote-service diinstal ulang jika sudah diinstal di organisasi Anda.
|
|
-h, --help
|
Menampilkan bantuan untuk parameter perintah. | |
-k, --key
|
String | Menentukan kunci yang ditampilkan dari
perintah apigee-remote-service-cli provision.
|
--legacy
|
Tetapkan tanda ini jika Anda menggunakan Apigee Edge Cloud. Tindakan ini menetapkan URL pengelolaan dan runtime untuk Edge Cloud. | |
--mfa
|
Token otorisasi multi-faktor Apigee (hanya digunakan dengan --legacy)
|
|
-m, --management
|
String | (Wajib jika Anda menggunakan Apigee Private Cloud) URL dasar pengelolaan Apigee Anda.
Default: https://api.enterprise.apigee.com
|
-n, --namespace
|
String | Memancarkan konfigurasi sebagai Envoy ConfigMap di namespace yang ditentukan. Default: apigee |
--opdk
|
String | Apigee OPDK. |
-o, --organization
|
String | (Wajib) Organisasi Apigee Anda. Anda harus menjadi administrator organisasi. |
-p, --password
|
String | (Hanya diperlukan untuk autentikasi dasar) Sandi Apigee Anda. Anda dapat secara opsional menentukan
sandi dalam file .netrc. Jika Anda melakukannya, Anda tidak perlu
memberikan sandi di command line. Lihat juga
Menggunakan .netrc untuk kredensial.
|
--rotate-int
|
int | Jika n > 0, buat kunci pribadi baru dan simpan n kunci publik (khusus hybrid) |
-r, --runtime
|
String | (Khusus Private Cloud) Menentukan URL runtime untuk instance Private Cloud Anda. |
-s, --secret
|
String | Menentukan rahasia yang ditampilkan dari perintah apigee-remote-service-cli provision.
|
--strength
|
int | (Opsional) Menentukan kekuatan enkripsi untuk sertifikat SSL yang digunakan dalam penyediaan adaptor. Default 2048 |
-t, --token
|
String | (Khusus Hybrid) Token OAuth atau SAML Apigee. |
-u, --username
|
String | (Hanya diperlukan untuk autentikasi dasar) Nama pengguna Apigee Anda (biasanya alamat email).
Anda dapat secara opsional menentukan nama pengguna dalam file .netrc.
Lihat juga Menggunakan .netrc untuk kredensial.
|
-v, --verbose
|
(Opsional) Menghasilkan output panjang. | |
--virtual-hosts
|
String | Mengganti host virtual default, yaitu default,secure. Gunakan opsi ini jika Anda
telah menentukan host virtual untuk organisasi-lingkungan Edge selain default ini.
Lihat dokumentasi Edge untuk mempelajari
host virtual.
|
--years
|
int | (Opsional) Jumlah tahun sebelum masa berlaku sertifikat SSL yang digunakan dalam penyediaan berakhir. Default: 1 |
Contoh
Pastikan untuk merekam output perintah provision dalam file, yang digunakan
sebagai input untuk operasi Apigee Adapter for Envoy lainnya.
Contoh Edge Public Cloud:
apigee-remote-service-cli provision --legacy --mfa $MFA --username $USER --password $PASSWORD --organization $ORG --environment $ENV > config.yaml
Perintah sampel
Membuat contoh file konfigurasi untuk deployment Envoy atau Istio native.
Penggunaan
apigee-remote-service-cli samples create [flags]
Deskripsi
Perintah ini memerlukan file config.yaml valid yang dibuat melalui penyediaan.
Secara default, file contoh akan dikeluarkan ke direktori bernama ./samples. Perintah
membuat direktori ini untuk Anda.
Jika Anda menggunakan Envoy native, perintah akan mengambil host layanan target dan nama yang diinginkan untuk
clusternya. Selain itu, layanan ini juga menetapkan koneksi SSL kustom dari proxy Envoy ke cluster layanan jarak jauh jika folder yang berisi tls.key dan tls.crt disediakan melalui --tls.
Jika Anda menggunakan Istio, dengan proxy Envoy bertindak sebagai sidecar, jika target tidak ditentukan,
contoh httpbin akan dibuat. Jika tidak, Anda bertanggung jawab untuk menyiapkan
file konfigurasi yang terkait dengan deployment layanan target Anda.
Parameter
| Parameter | Jenis | Deskripsi |
|---|---|---|
-c, --config
|
String | (Wajib) Jalur ke file konfigurasi Apigee Remote Service. Tips: Dengan tanda ini, Anda dapat menghilangkan sebagian besar parameter perintah lainnya, karena CLI dapat menariknya langsung dari file konfigurasi. Lihat Menggunakan opsi --config.
|
-f, --force
|
Memaksa direktori yang ada untuk ditimpa. | |
-h, --help
|
Menampilkan bantuan untuk parameter perintah. | |
--host
|
Host layanan target (default "httpbin.org") | |
-n, --name
|
Nama layanan target (default "httpbin") | |
--out
|
Direktori tempat membuat file konfigurasi contoh. Default: ./samples
|
|
-t, --template
|
Nama template. Jika Anda melakukan deployment Istio (khusus hybrid), pilih salah satu opsi Istio yang tersedia. Gunakan opsi native untuk deployment Envoy native. Opsi yang tersedia adalah:
|
|
--tls
|
Direktori tempat menyimpan file kunci dan crt TLS. |
Contoh
apigee-remote-service-cli samples create -c ./config.yaml
Mencantumkan opsi template yang tersedia
Mencantumkan opsi yang tersedia untuk digunakan dengan parameter --templates.
Penggunaan
apigee-remote-service-cli samples templates
Parameter
Tidak ada.
Contoh
apigee-remote-service-cli samples templates
Supported templates (native is deprecated): envoy-1.14 envoy-1.15 envoy-1.16 istio-1.5 istio-1.6 istio-1.7 istio-1.8 native
Perintah token
Anda dapat menggunakan token JWT untuk melakukan panggilan proxy API terautentikasi, bukan menggunakan kunci API. Perintah token memungkinkan Anda membuat, memeriksa, dan merotasi token JWT untuk tujuan ini.
Membuat token JWT
Anda dapat menggunakan token JWT untuk melakukan panggilan proxy API terautentikasi ke target layanan jarak jauh. Lihat juga Menggunakan autentikasi berbasis JWT.Penggunaan
Untuk Edge Public Cloud:apigee-remote-service-cli token create -c [config_file] --id [consumer_key] --secret [consumer_secret] -o [org] -e [env]
apigee-remote-service-cli token create -c [config_file] --id [consumer_key] --secret [consumer_secret] -r [runtime] -o [org] -e [env]
Parameter
| Parameter | Jenis | Deskripsi |
|---|---|---|
-c, --config
|
String | (Wajib) Jalur ke file konfigurasi Apigee Remote Service. Tips: Dengan tanda ini, Anda dapat menghilangkan sebagian besar parameter perintah lainnya, karena CLI dapat menariknya langsung dari file konfigurasi. Lihat Menggunakan opsi --config.
|
-e, --env
|
String | (Wajib) Lingkungan di organisasi Anda. |
-h, --help
|
Menampilkan bantuan untuk parameter perintah. | |
--insecure
|
Mengizinkan koneksi server yang tidak aman saat menggunakan SSL. | |
-o, --org
|
String | (Wajib) Organisasi Apigee. Anda harus menjadi administrator organisasi. |
-r, --runtime
|
String | (Khusus Private Cloud) Menentukan URL runtime untuk instance Private Cloud Anda. |
-v, --verbose
|
(Opsional) Menghasilkan output panjang. |
Contoh
apigee-remote-service-cli token create -o myorg -e test -i YUmlZAcBKNsTAelJqPZFl3sh58ObATX9 -s icTARgaKHqvUH1dq -c config.yaml
Output
Jika berhasil, Anda akan melihat output token JST yang mirip dengan berikut ini:eyJraWQiOiIxIiwidHlwIjoiSldUIiwiYWxnIjoiUlMyNTYifQ.eyJhY2Nlc3NfdG9rZW4iOiJ0a2tlVzVKQTY2a0pZYTB4bFV1cVBsUW1BMU43IiwiYXVkIjoiaXN0aW8iLCJuYmYiOjE1MzAxMzg1OTEsImFwaV9wcm9kdWN0X2xpc3QiOlsiaXN0aW8tcHJvZHVjdCJdLCJhcHBsaWNhdGlvbl9uYW1lIjoiaXN0aW8tYXBwIiwiZGV2ZWxvcGVyX2VtYWlsIjoicFluZ2Zsb3lkQGdvb2dsZS5jb20iLCJpc3MiOiJodHRwczovL2FwaWdlZXNlYXJjaC10ZXN0LmFwaWdlZS5uZXQvaXN0aW8tYXV0aC90b2tlbiIsImV4cCI6MTUzMDEzOTQ5MSwiaWF0IjoxNTMwMTM4NTkxLCJqdGkiOiIxODgzMzViZi0wMmE4LTRjZGUsOGFkOS0yMWJmNDZjNmRjZDkiLCJjbGllbnRfaWQiOiJZVW1sWkFjQktOc1RBZWxKcVBZRmwzc2g1OE9iQVRYOSJ9.AL7pKSTmond-NSPRNNHVbIzTdAnZjOXcjQ-BbOJ_8lsQvF7PuiOUrGIhY5XTcJusisKgbCdtIxBl8Wq1EiQ_fKnUc3JYYOqzpTB5bGoFy0Yqbfu96dneuWyzgZnoQBkqwZkbQTIg7WNTGx1TJX-UTePvBPxAefiAbaEUcigX9tTsXPoRJZOTrm7IOeKpxpB_gQYkxQtV1_NbERxjTPyMbHdMWal9_xRVzSt7mpTGudMN9OR-VtQ1uXA67GOqhZWcOzq57qImOiCMbaoKnKUADevyWjX_VscN5ZZUtzQUQhTrmv8aR69-uVhMIPKp9juMyYKaYn2IsYZEeCWfhfV45Q
Memeriksa token JWT
Anda dapat memeriksa token JWT dengan perintah ini. Lihat juga Memeriksa token.Penggunaan
Untuk Edge Public Cloud:apigee-remote-service-cli token inspect -o [organization] -e [environment] -f [token_file]
apigee-remote-service-cli token inspect -o [organization] -e [environment] -f [token_file] --runtime [host_alias]
Parameter
| Parameter | Jenis | Deskripsi |
|---|---|---|
-c, --config
|
String | (Wajib) Jalur ke file konfigurasi Apigee Remote Service. Tips: Dengan tanda ini, Anda dapat menghilangkan sebagian besar parameter perintah lainnya, karena CLI dapat menariknya langsung dari file konfigurasi. Lihat Menggunakan opsi --config.
|
-e, --env
|
String | (Wajib) Lingkungan di organisasi Anda. |
-h, --help
|
Menampilkan bantuan untuk parameter perintah. | |
--insecure
|
Mengizinkan koneksi server yang tidak aman saat menggunakan SSL. | |
-o, --org
|
String | (Wajib) Organisasi Apigee. Anda harus menjadi administrator organisasi. |
-r, --runtime
|
String | (Khusus Private Cloud) Menentukan URL runtime untuk instance Private Cloud Anda. |
-v, --verbose
|
(Opsional) Menghasilkan output panjang. |
Contoh
apigee-remote-service-cli token inspect -c config.yaml <<< $TOKEN
Output
Jika berhasil, Anda akan melihat output yang mirip dengan berikut ini:
{
"aud": [
"remote-service-client"
],
"exp": 1591741549,
"iat": 1591740649,
"iss": "https://apigee-docs-test.apigee.net/remote-service/token",
"jti": "99325d2e-6440-4278-9f7f-b252a1a79e53",
"nbf": 1591740649,
"access_token": "VfzpXzBGAQ07po0bPMKY4JgQjus",
"api_product_list": [
"httpbin"
],
"application_name": "httpbin",
"client_id": "GYDGHy5TRpV8AejXCOlreP7dPVepA8H",
"developer_email": "user@example.com",
"scope": ""
}
verifying...
token ok.
Memutar token JWT
Beberapa waktu setelah Anda membuat JWT untuk pertama kalinya, Anda mungkin perlu mengubah pasangan kunci publik/pribadi yang disimpan oleh Apigee Edge dalam key-value map (KVM) terenkripsinya. Proses pembuatan pasangan kunci baru ini disebut rotasi kunci. Saat Anda merotasi kunci, pasangan kunci pribadi/publik baru dibuat dan disimpan di KVM "istio" di organisasi/lingkungan Apigee Edge Anda. Selain itu, kunci publik lama dipertahankan bersama dengan nilai ID kunci aslinya.Penggunaan
Jika Anda menggunakan Edge Public Cloud:apigee-remote-service-cli token rotate-cert -c [config_file] -o [organization] -e [environment] -k [provision_key] -s [provision_secret] --kid [new_key_id]
apigee-remote-service-cli token rotate-cert -o [organization] -e [environment] -u [username] -p [password] -k [provision_key] -s [provision_secret] --kid [new_key_id]
Parameter
| Parameter | Jenis | Deskripsi |
|---|---|---|
-c, --config
|
String | (Wajib) Jalur ke file konfigurasi Apigee Remote Service. Tips: Dengan tanda ini, Anda dapat menghilangkan sebagian besar parameter perintah lainnya, karena CLI dapat menariknya langsung dari file konfigurasi. Lihat Menggunakan opsi --config.
|
-e, --env
|
String | (Wajib) Lingkungan di organisasi Anda. |
-h, --help
|
Menampilkan bantuan untuk parameter perintah. | |
--insecure
|
Mengizinkan koneksi server yang tidak aman saat menggunakan SSL | |
--truncate
|
int | Jumlah sertifikat yang akan disimpan di jwks (default 2) |
-o, --org
|
String | (Wajib) Organisasi Apigee. Anda harus menjadi administrator organisasi. |
-r, --runtime
|
String | (Khusus Private Cloud) Menentukan URL runtime untuk instance Private Cloud Anda. |
-v, --verbose
|
(Opsional) Menghasilkan output panjang. |
Contoh
apigee-remote-service-cli token rotate-cert -c config.yaml -o myorg -e test -k 2e238ffa15dc5ab6a1e97868e7581f6c60ddb8575478582c256d8b7e5b2677a8 -s 51058077223fa7b683c3bea845c5cca138340d1d5583922b6d465f9f918a4b08
Output
certificate successfully rotated
Menggunakan .netrc untuk kredensial
apigee-remote-service-cli otomatis mengambil username dan
password (untuk autentikasi dasar jika diperlukan) dari file .netrc
di direktori beranda Anda jika Anda menggunakan Edge Public Cloud dan memiliki entri untuk
mesin api.enterprise.apigee.com. Jika Anda menggunakan Apigee Private Cloud, nilai mesin sama dengan URL management Anda (misalnya: http://192.162.55.100).
Misalnya di Edge Public Cloud:
machine api.enterprise.apigee.com login jdoe@google.com password abc123
machine http://192.162.55.100 login jdoe@google.com password abc123
Perintah versi
Mencetak versi CLI.
apigee-remote-service-cli version
Menggunakan opsi perintah --config
Opsi --config menentukan lokasi
file konfigurasi yang dibuat oleh perintah provision. Manfaat yang berguna dari opsi ini adalah Anda dapat melewati sebagian besar parameter perintah lainnya, yang ditarik CLI dari file konfigurasi.
Opsi ini mencakup:
- organisasi
- lingkungan
- runtime
- pengelolaan
- tidak aman
- namespace
- legacy
- opdk
Misalnya, Anda dapat menjalankan perintah provision seperti ini:
apigee-remote-service-cli provision --config='old-config.yaml' > new-config.yaml
File konfigurasi
Bagian ini menunjukkan contoh file konfigurasi dengan semua opsi yang tersedia.
global:
temp_dir: /tmp/apigee-istio
keep_alive_max_connection_age: 1m
api_address: :5000
metrics_address: :5001
tls:
cert_file: tls.crt
key_file: tls.key
tenant:
internal_api: https://istioservices.apigee.net/edgemicro
remote_service_api: https://org-test.apigee.net/remote-service
org_name: org
env_name: env
key: mykey
secret: mysecret
client_timeout: 30s
allow_unverified_ssl_cert: false
products:
refresh_rate: 2m
analytics:
legacy_endpoint: false
file_limit: 1024
send_channel_size: 10
collection_interval: 10s
fluentd_endpoint: apigee-udca-myorg-test.apigee.svc.cluster.local:20001
tls:
ca_file: /opt/apigee/tls/ca.crt
cert_file: /opt/apigee/tls/tls.crt
key_file: /opt/apigee/tls/tls.key
allow_unverified_ssl_cert: false
auth:
api_key_claim: claim
api_key_cache_duration: 30m
api_key_header: x-api-key
api_target_header: :authority
reject_unauthorized: true
jwks_poll_interval: 0s
jwt_provider_key: https://org-test.apigee.net/remote-service/token