Halaman ini diterjemahkan oleh Cloud Translation API.

Referensi

Halaman ini berlaku untuk Apigee dan Apigee hybrid.

Antarmuka Command Line (CLI) apigee-remote-service-cli membantu Anda menyediakan dan mengelola Adaptor Apigee untuk Envoy.

Mengikat perintah

Binding mengaitkan layanan yang di-deploy ke mesh Istio dengan produk Apigee API. CLI ini memungkinkan Anda membuat, menghapus, dan mencantumkan binding.

Catatan: Di UI Create Product, Anda dapat menentukan satu atau beberapa layanan dengan sebuah produk. Melakukannya sama dengan membuat binding menggunakan CLI.

Menambahkan binding

Menambahkan binding target jarak jauh ke produk API.

Penggunaan

Untuk Apigee Hybrid:

apigee-remote-service-cli bindings add [service_name] [product_name]  -o [organization] -e [environment] -t [token]

Parameter

Parameter	Jenis	Deskripsi
`-c, --config`	String	(Wajib) Jalur ke file konfigurasi Apigee Remote Service. Tips: Jika Anda menentukan opsi ini, Anda dapat menghilangkan sebagian besar parameter perintah lainnya. Lihat Menggunakan opsi `--config`.
`-e, --env`	String	(Wajib) Lingkungan di organisasi Anda.
`-h, --help`		Menampilkan bantuan untuk parameter perintah.
`--insecure`		Izinkan koneksi server yang tidak aman saat menggunakan SSL
`--legacy`		Tetapkan tanda ini jika Anda menggunakan Apigee Cloud. Tag Assistant menetapkan URL pengelolaan dan runtime untuk Edge Cloud.
`--opdk`		Tetapkan tanda ini jika Anda menggunakan Apigee untuk Private Cloud.
`-o, --org`	String	(Wajib) Organisasi Apigee. Anda harus menjadi administrator org.
`-p, --password`	String	(Hanya diperlukan untuk autentikasi dasar) Sandi Apigee Anda. Anda dapat secara opsional menentukan sandi dalam file `.netrc`. Jika Anda melakukannya, maka Anda tidak harus masukkan {i>password<i} Anda melalui baris perintah. Lihat juga Menggunakan .netrc untuk kredensial.
`-r, --runtime`	String	URL dasar runtime Apigee (wajib untuk hybrid atau opdk).
`-t, --token`	String	(Hanya wajib untuk autentikasi token OAuth) Token OAuth atau SAML yang Anda buat dari informasi akun Apigee Anda. Untuk informasi tentang cara membuat token, lihat Mendapatkan token akses OAuth 2.0 dan Ringkasan SAML.
`-u, --username`	String	(Hanya diperlukan untuk autentikasi dasar) Nama pengguna Apigee Anda (biasanya alamat email). Secara opsional, Anda dapat menentukan nama pengguna dalam file `.netrc`. Jika Anda melakukannya, maka Anda tidak perlu memasukkan nama pengguna Anda di baris perintah. Lihat Menggunakan .netrc untuk kredensial.
`-v, --verbose`		(Opsional) Menghasilkan output panjang.

Contoh

./apigee-remote-service-cli bindings add httpbin.org envoy-test -o myorg -e test -u user@example.com -c config.yaml -p xxxxxx
product envoy-test is now bound to: httpbin.org

Mencantumkan pengikatan

Cantumkan semua produk API yang terikat dengan Remote Service.

Penggunaan

Parameter

Parameter	Jenis	Deskripsi
`-c, --config`	String	(Wajib) Jalur ke file konfigurasi Apigee Remote Service. Tips: Jika Anda menentukan opsi ini, Anda dapat menghilangkan sebagian besar parameter perintah lainnya. Lihat Menggunakan opsi `--config`.
`-e, --env`	String	(Wajib) Lingkungan di organisasi Anda.
`-h, --help`		Menampilkan bantuan untuk parameter perintah.
`--insecure`		Izinkan koneksi server yang tidak aman saat menggunakan SSL
`--legacy`		Tetapkan tanda ini jika Anda menggunakan Apigee Cloud. Tag Assistant menetapkan URL pengelolaan dan runtime untuk Edge Cloud.
`--opdk`		Tetapkan tanda ini jika Anda menggunakan Apigee untuk Private Cloud.
`-o, --org`	String	(Wajib) Organisasi Apigee. Anda harus menjadi administrator org.
`-p, --password`	String	(Hanya diperlukan untuk autentikasi dasar) Sandi Apigee Anda. Anda dapat secara opsional menentukan sandi dalam file `.netrc`. Jika Anda melakukannya, maka Anda tidak harus masukkan {i>password<i} Anda melalui baris perintah. Lihat juga Menggunakan .netrc untuk kredensial.
`-r, --runtime`	String	URL dasar runtime Apigee (wajib untuk hybrid atau opdk).
`-t, --token`	String	(Hanya diperlukan untuk autentikasi token OAuth) Token OAuth atau SAML yang Anda buat dari informasi akun Apigee Anda. Untuk informasi tentang cara membuat token, lihat Mendapatkan token akses OAuth 2.0 dan Ringkasan SAML.
`-u, --username`	String	(Hanya diperlukan untuk autentikasi dasar) Nama pengguna Apigee Anda (biasanya alamat email). Secara opsional, Anda dapat menentukan nama pengguna dalam file `.netrc`. Jika Anda melakukannya, maka Anda tidak perlu memasukkan nama pengguna Anda di baris perintah. Lihat 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:

Menghapus binding

Hapus binding Remote Service for Envoy dari produk API.

Catatan: Anda juga dapat menghapus Remote Service untuk binding Envoy dengan menghapus nama layanan dari produk di UI.

Penggunaan

Untuk Apigee Hybrid:

apigee-remote-service-cli bindings remove [service_name] [product_name]  -o [organization] -e [environment] -t [token]

Parameter

Parameter	Jenis	Deskripsi
`-c, --config`	String	(Wajib) Jalur ke file konfigurasi Apigee Remote Service. Tips: Jika Anda menentukan opsi ini, Anda dapat menghilangkan sebagian besar parameter perintah lainnya. Lihat Menggunakan opsi `--config`.
`-e, --env`	String	(Wajib) Lingkungan di organisasi Anda.
`-h, --help`		Menampilkan bantuan untuk parameter perintah.
`--insecure`		Izinkan koneksi server yang tidak aman saat menggunakan SSL
`--legacy`		Tetapkan tanda ini jika Anda menggunakan Apigee Cloud. Tag Assistant menetapkan URL pengelolaan dan runtime untuk Edge Cloud.
`--opdk`		Tetapkan tanda ini jika Anda menggunakan Apigee untuk Private Cloud.
`-o, --org`	String	(Wajib) Organisasi Apigee. Anda harus menjadi administrator org.
`-p, --password`	String	(Hanya diperlukan untuk autentikasi dasar) Sandi Apigee Anda. Anda dapat secara opsional menentukan sandi dalam file `.netrc`. Jika Anda melakukannya, maka Anda tidak harus masukkan {i>password<i} Anda melalui baris perintah. Lihat juga Menggunakan .netrc untuk kredensial.
`-r, --runtime`	String	URL dasar runtime Apigee (wajib untuk hybrid atau opdk).
`-t, --token`	String	(Hanya diperlukan untuk autentikasi token OAuth) Token OAuth atau SAML yang Anda buat dari informasi akun Apigee Anda. Untuk informasi tentang cara membuat token, lihat Mendapatkan token akses OAuth 2.0 dan Ringkasan SAML.
`-u, --username`	String	(Hanya diperlukan untuk autentikasi dasar) Nama pengguna Apigee Anda (biasanya alamat email). Secara opsional, Anda dapat menentukan nama pengguna dalam file `.netrc`. Jika Anda melakukannya, maka Anda tidak perlu memasukkan nama pengguna Anda di baris perintah. Lihat Menggunakan .netrc untuk kredensial.
`-v, --verbose`		(Opsional) Menghasilkan output panjang.

Contoh

./apigee-remote-service-cli bindings remove httpbin.org envoy-test -o myorg -e test -u user@example.com -c config.yaml -p xxxxxx
product envoy-test is no longer bound to: httpbin.org

Perintah bantuan

Bantuan online disediakan untuk semua perintah apigee-remote-service-cli. Cukup ketik:

apigee-remote-service-cli help

Untuk 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, menyiapkan sertifikat, dan membuat kredensial yang Anda perlukan mengonfigurasi Adaptor Apigee untuk Envoy.

Penggunaan

Parameter

Parameter	Jenis	Deskripsi
`-c, --config`	String	Jalur ke file konfigurasi Apigee Remote Service. Tips: Jika Anda menentukan opsi ini, Anda dapat menghilangkan sebagian besar parameter perintah lainnya. Lihat Menggunakan opsi `--config`.
`-e, --environment`	String	(Wajib) Lingkungan di organisasi Anda.
`-f, --force-proxy-install`		(Opsional) Memaksa proxy `remote-service` untuk diinstal ulang jika sudah terinstal di organisasi Anda. CATATAN UPGRADE: Jika Anda mengupgrade ke v1.0-beta.4 atau versi yang lebih baru, Anda harus menyertakan tanda `--force-proxy-install` untuk mengganti proxy layanan jarak jauh yang ada yang di-deploy di Apigee.
`-h, --help`		Menampilkan bantuan untuk parameter perintah.
`-k, --key`	String	Menentukan kunci yang ditampilkan dari menggunakan perintah `apigee-remote-service-cli provision`.
`--legacy`		Apigee Edge (menyetel URL runtime dan pengelolaan)
`-m, --management`	String	(Wajib jika Anda menggunakan Apigee Private Cloud) URL dasar pengelolaan Apigee Anda. Default: `https://api.enterprise.apigee.com`
`-n, --namespace`	String	memunculkan konfigurasi sebagai Envoy ConfigMap dalam namespace yang ditentukan.
`--opdk`	String	OPDK Apigee.
`-o, --organization`	String	(Wajib) Organisasi Apigee Anda. Anda harus menjadi administrator org.
`-p, --password`	String	(Hanya diperlukan untuk autentikasi dasar) Sandi Apigee Anda. Anda dapat secara opsional menentukan sandi dalam file `.netrc`. Jika Anda melakukannya, maka Anda tidak harus masukkan {i>password<i} Anda melalui baris perintah. Lihat juga Menggunakan .netrc untuk kredensial.
`--rotate-int`	int	Jika n > 0, buat kunci pribadi baru dan simpan n kunci publik (khusus campuran)
`-r, --runtime`	String	URL dasar runtime Apigee (wajib untuk hybrid atau opdk)
`-s, --secret`	String	Menentukan rahasia yang ditampilkan dari `apigee-remote-service-cli provision` perintah.
`--strength`	int	(Opsional) Menentukan kekuatan enkripsi untuk sertifikat SSL yang digunakan dalam menyediakan {i>adaptor<i}. 2048 default
`-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). Secara opsional, Anda dapat 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.
`--years`	int	(Opsional) Jumlah tahun sebelum sertifikat SSL digunakan dalam penyediaan tidak berlaku lagi. Default: 1

Contoh

Pastikan untuk merekam output perintah provision dalam file yang digunakan sebagai input untuk Adaptor Apigee lainnya untuk operasi Envoy.

Contoh hybrid Apigee:

apigee-remote-service-cli provision --organization $ORG --environment $ENV --runtime $RUNTIME --namespace $NAMESPACE --token $TOKEN > config.yaml

Perintah token

Anda dapat menggunakan token JWT untuk melakukan panggilan proxy API yang diautentikasi daripada 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 yang diautentikasi ke target layanan jarak jauh. Lihat Menggunakan autentikasi berbasis JWT.

Penggunaan

Untuk Apigee Hybrid:

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: Jika Anda menentukan opsi ini, Anda dapat menghilangkan sebagian besar parameter perintah lainnya. Lihat Menggunakan opsi `--config`.
`-e, --env`	String	(Wajib) Lingkungan di organisasi Anda.
`-h, --help`		Menampilkan bantuan untuk parameter perintah.
`--insecure`		Izinkan koneksi server yang tidak aman saat menggunakan SSL.
`-o, --org`	String	(Wajib) Organisasi Apigee. Anda harus menjadi administrator org.
`-r, --runtime`	String	URL dasar runtime Apigee (hanya diperlukan untuk hybrid atau opdk).
`-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 Apigee Hybrid:

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: Jika Anda menentukan opsi ini, Anda dapat menghilangkan sebagian besar parameter perintah lainnya. Lihat Menggunakan opsi `--config`.
`-e, --env`	String	(Wajib) Lingkungan di organisasi Anda.
`-h, --help`		Menampilkan bantuan untuk parameter perintah.
`--insecure`		Izinkan koneksi server yang tidak aman saat menggunakan SSL.
`-o, --org`	String	(Wajib) Organisasi Apigee. Anda harus menjadi administrator org.
`-r, --runtime`	String	URL dasar runtime Apigee (hanya diperlukan untuk hybrid atau opdk).
`-v, --verbose`		(Opsional) Menghasilkan output panjang.

Contoh

apigee-remote-service-cli token inspect -c config.yaml <<< $TOKEN

Output

Jika berhasil, Anda akan melihat output mirip seperti berikut:

{
	"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.

Merotasi token JWT

Pada waktu tertentu setelah pertama kali membuat JWT, Anda mungkin perlu mengubah kunci publik/pribadi disimpan oleh Apigee dalam peta nilai kunci (KVM) terenkripsinya. Proses pembuatan pasangan kunci baru disebut rotasi kunci. Saat Anda merotasi kunci, pasangan kunci pribadi/publik baru akan dibuat dan disimpan di "istio" di organisasi/lingkungan Apigee Anda. Selain itu, kunci publik lama dipertahankan bersama dengan nilai ID kunci aslinya.

Penggunaan

Parameter

Parameter	Jenis	Deskripsi
`-c, --config`	String	(Wajib) Jalur ke file konfigurasi Apigee Remote Service. Tips: Jika Anda menentukan opsi ini, Anda dapat menghilangkan sebagian besar parameter perintah lainnya. Lihat Menggunakan opsi `--config`.
`-e, --env`	String	(Wajib) Lingkungan di organisasi Anda.
`-h, --help`		Menampilkan bantuan untuk parameter perintah.
`--insecure`		Izinkan koneksi server yang tidak aman saat menggunakan SSL
`--truncate`	int	Jumlah sertifikat yang perlu dipertahankan di jwks (default 2)
`-o, --org`	String	(Wajib) Organisasi Apigee. Anda harus menjadi administrator org.
`-r, --runtime`	String	URL dasar runtime Apigee (wajib untuk hybrid atau opdk).
`-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 .netrc di direktori utama jika menggunakan Apigee dan memiliki entri untuk komputer api.enterprise.apigee.com. Jika Anda menggunakan Apigee Private Cloud, nilai mesin sama dengan URL management Anda (misalnya: http://192.162.55.100).

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. Keuntungan yang dapat membantu dari opsi ini adalah memungkinkan Anda untuk melewati sebagian besar parameter perintah lain, yang diambil CLI dari file konfigurasi. Opsi ini mencakup:

organisasi
lingkungan
runtime
management
tidak aman
namespace
yang lalu
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: 10m
  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

Referensi

Mengikat perintah

Menambahkan binding

Penggunaan

Parameter

Contoh

Mencantumkan pengikatan

Penggunaan

Parameter

Contoh

Menghapus binding

Penggunaan

Parameter

Contoh

Perintah bantuan

Perintah penyediaan

Penggunaan

Parameter

Contoh

Perintah token

Membuat token JWT

Penggunaan

Parameter

Contoh

Output

Memeriksa token JWT

Penggunaan

Parameter

Contoh

Output

Merotasi token JWT

Penggunaan

Parameter

Contoh

Output

Menggunakan .netrc untuk kredensial

Perintah versi

Menggunakan opsi perintah --config

File konfigurasi

Menggunakan opsi perintah `--config`