คุณกำลังดูเอกสารประกอบของ Apigee Edge
ไปที่เอกสารประกอบของ
Apigee X info
apigee-remote-service-cli อินเทอร์เฟซบรรทัดคำสั่ง (CLI) ช่วยให้คุณ
จัดสรรและจัดการ Apigee Adapter for Envoy ได้
การเชื่อมโยงคำสั่ง
การเชื่อมโยงจะเชื่อมโยงบริการที่ติดตั้งใช้งานกับ Istio Mesh กับผลิตภัณฑ์ Apigee API CLI ช่วยให้คุณสร้าง นำออก และแสดงรายการการเชื่อมโยงได้
หมายเหตุ: ใน UI การสร้างผลิตภัณฑ์ คุณสามารถระบุบริการอย่างน้อย 1 รายการพร้อมกับผลิตภัณฑ์ได้ การดำเนินการนี้เทียบเท่ากับการสร้างการเชื่อมโยงโดยใช้ CLIเพิ่มการเชื่อมโยง
เพิ่มการเชื่อมโยงเป้าหมายระยะไกลกับผลิตภัณฑ์ API
การใช้งาน
สำหรับ Edge Public Cloud
apigee-remote-service-cli bindings add [service_name] [product_name] -o [organization] -e [environment] -u [username] -p [password] -c [config]
สำหรับ Edge Private Cloud
apigee-remote-service-cli bindings add [service_name] [product_name] -o [organization] -e [environment] -u [username] -p [password] -r [runtime] -c [config]
สำหรับ Apigee Hybrid
apigee-remote-service-cli bindings add [service_name] [product_name] -o [organization] -e [environment] -t [token]
พารามิเตอร์
| พารามิเตอร์ | ประเภท | คำอธิบาย |
|---|---|---|
-c, --config
|
สตริง | (ต้องระบุ) เส้นทางไปยังไฟล์การกำหนดค่า Apigee Remote Service เคล็ดลับ: เมื่อระบุตัวเลือกนี้ คุณจะละเว้นพารามิเตอร์คำสั่งอื่นๆ ส่วนใหญ่ได้ ดู
การใช้ตัวเลือก--config
|
-e, --env
|
สตริง | (ต้องระบุ) สภาพแวดล้อมในองค์กร |
-h, --help
|
แสดงความช่วยเหลือสำหรับพารามิเตอร์คำสั่ง | |
--insecure
|
อนุญาตการเชื่อมต่อเซิร์ฟเวอร์ที่ไม่ปลอดภัยเมื่อใช้ SSL | |
--legacy
|
ตั้งค่าสถานะนี้หากคุณใช้ Apigee Edge Cloud โดยจะตั้งค่า URL การจัดการและรันไทม์ สำหรับ Edge Cloud | |
--opdk
|
ตั้งค่าสถานะนี้หากคุณใช้ Apigee Edge สำหรับ Private Cloud | |
-o, --org
|
สตริง | (ต้องระบุ) องค์กร Apigee คุณต้องเป็นผู้ดูแลระบบขององค์กร |
-p, --password
|
สตริง | (จำเป็นสำหรับการตรวจสอบสิทธิ์พื้นฐานเท่านั้น) รหัสผ่าน Apigee คุณเลือกที่จะระบุ
รหัสผ่านในไฟล์ .netrc ได้ หากทำเช่นนั้น คุณก็ไม่จำเป็นต้อง
ระบุรหัสผ่านในบรรทัดคำสั่ง ดูเพิ่มเติม
การใช้ .netrc สำหรับข้อมูลเข้าสู่ระบบ
|
-r, --runtime
|
สตริง | URL ฐานของรันไทม์ Apigee (ต้องระบุสำหรับ Hybrid หรือ opdk) |
-t, --token
|
สตริง | (ต้องใช้สำหรับการตรวจสอบสิทธิ์โทเค็น OAuth เท่านั้น) โทเค็น OAuth หรือ SAML ที่คุณสร้าง จากข้อมูลบัญชี Apigee ดูข้อมูลเกี่ยวกับการสร้างโทเค็นได้ที่ การใช้ get_token และ เข้าถึง Management API ด้วย SAML |
-u, --username
|
สตริง | (ต้องใช้สำหรับการตรวจสอบสิทธิ์พื้นฐานเท่านั้น) ชื่อผู้ใช้ Apigee (โดยปกติคืออีเมล)
คุณระบุชื่อผู้ใช้ในไฟล์ .netrc ได้หากต้องการ หากทำเช่นนั้น คุณก็ไม่จำเป็นต้องระบุชื่อผู้ใช้ในบรรทัดคำสั่ง ดูการใช้ .netrc สำหรับข้อมูลเข้าสู่ระบบด้วย
|
-v, --verbose
|
(ไม่บังคับ) สร้างเอาต์พุตแบบละเอียด |
ตัวอย่าง
./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
แสดงรายการการผูก
แสดงรายการผลิตภัณฑ์ API ทั้งหมดที่เชื่อมโยงกับบริการระยะไกล
การใช้งาน
สำหรับ Edge Public Cloud
apigee-remote-service-cli bindings list -o [organization] -e [environment] -u [username] -p [password]
สำหรับ Edge Private Cloud
apigee-remote-service-cli bindings list -o [organization] -e [environment] -u [username] -p [password] -r [runtime]
พารามิเตอร์
| พารามิเตอร์ | ประเภท | คำอธิบาย |
|---|---|---|
-c, --config
|
สตริง | (ต้องระบุ) เส้นทางไปยังไฟล์การกำหนดค่า Apigee Remote Service เคล็ดลับ: เมื่อระบุตัวเลือกนี้ คุณจะละเว้นพารามิเตอร์คำสั่งอื่นๆ ส่วนใหญ่ได้ ดู
การใช้ตัวเลือก--config
|
-e, --env
|
สตริง | (ต้องระบุ) สภาพแวดล้อมในองค์กร |
-h, --help
|
แสดงความช่วยเหลือสำหรับพารามิเตอร์คำสั่ง | |
--insecure
|
อนุญาตการเชื่อมต่อเซิร์ฟเวอร์ที่ไม่ปลอดภัยเมื่อใช้ SSL | |
--legacy
|
ตั้งค่าสถานะนี้หากคุณใช้ Apigee Edge Cloud โดยจะตั้งค่า URL การจัดการและรันไทม์ สำหรับ Edge Cloud | |
--opdk
|
ตั้งค่าสถานะนี้หากคุณใช้ Apigee Edge สำหรับ Private Cloud | |
-o, --org
|
สตริง | (ต้องระบุ) องค์กร Apigee คุณต้องเป็นผู้ดูแลระบบขององค์กร |
-p, --password
|
สตริง | (จำเป็นสำหรับการตรวจสอบสิทธิ์พื้นฐานเท่านั้น) รหัสผ่าน Apigee คุณระบุรหัสผ่านในไฟล์ .netrc ได้ (ไม่บังคับ) หากทำเช่นนั้น คุณก็ไม่จำเป็นต้อง
ระบุรหัสผ่านในบรรทัดคำสั่ง ดูเพิ่มเติม
การใช้ .netrc สำหรับข้อมูลเข้าสู่ระบบ
|
-r, --runtime
|
สตริง | URL ฐานของรันไทม์ Apigee (ต้องระบุสำหรับ Hybrid หรือ opdk) |
-t, --token
|
สตริง | (ต้องใช้สำหรับการตรวจสอบสิทธิ์โทเค็น OAuth เท่านั้น) โทเค็น OAuth หรือ SAML ที่คุณสร้าง จากข้อมูลบัญชี Apigee ดูข้อมูลเกี่ยวกับการสร้างโทเค็นได้ที่ การใช้ get_token และ เข้าถึง Management API ด้วย SAML |
-u, --username
|
สตริง | (ต้องใช้สำหรับการตรวจสอบสิทธิ์พื้นฐานเท่านั้น) ชื่อผู้ใช้ Apigee (โดยปกติคืออีเมล)
คุณระบุชื่อผู้ใช้ในไฟล์ .netrc ได้หากต้องการ หากทำเช่นนั้น คุณก็ไม่จำเป็นต้องระบุชื่อผู้ใช้ในบรรทัดคำสั่ง ดูการใช้ .netrc สำหรับข้อมูลเข้าสู่ระบบด้วย
|
-v, --verbose
|
(ไม่บังคับ) สร้างเอาต์พุตแบบละเอียด |
ตัวอย่าง
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:
นำการเชื่อมโยงออก
นำการเชื่อมโยงของบริการระยะไกลสำหรับ Envoy ออกจากผลิตภัณฑ์ API
หมายเหตุ: คุณยังนำการเชื่อมโยงบริการระยะไกลสำหรับ Envoy ออกได้ด้วยการนำชื่อบริการออกจากผลิตภัณฑ์ใน Edge UIการใช้งาน
สำหรับ Edge Public Cloud
apigee-remote-service-cli bindings remove [service_name] [product_name] -o [organization] -e [environment] -u [username] -p [password] -c [config]
สำหรับ Edge Private Cloud
apigee-remote-service-cli bindings remove [service_name] [product_name] -o [organization] -e [environment] -u [username] -p [password] -r [runtime] -c [config]
สำหรับ Apigee Hybrid
apigee-remote-service-cli bindings remove [service_name] [product_name] -o [organization] -e [environment] -t [token]
พารามิเตอร์
| พารามิเตอร์ | ประเภท | คำอธิบาย |
|---|---|---|
-c, --config
|
สตริง | (ต้องระบุ) เส้นทางไปยังไฟล์การกำหนดค่า Apigee Remote Service เคล็ดลับ: เมื่อระบุตัวเลือกนี้ คุณจะละเว้นพารามิเตอร์คำสั่งอื่นๆ ส่วนใหญ่ได้ ดู
การใช้ตัวเลือก--config
|
-e, --env
|
สตริง | (ต้องระบุ) สภาพแวดล้อมในองค์กร |
-h, --help
|
แสดงความช่วยเหลือสำหรับพารามิเตอร์คำสั่ง | |
--insecure
|
อนุญาตการเชื่อมต่อเซิร์ฟเวอร์ที่ไม่ปลอดภัยเมื่อใช้ SSL | |
--legacy
|
ตั้งค่าสถานะนี้หากคุณใช้ Apigee Edge Cloud โดยจะตั้งค่า URL การจัดการและรันไทม์ สำหรับ Edge Cloud | |
--opdk
|
ตั้งค่าสถานะนี้หากคุณใช้ Apigee Edge สำหรับ Private Cloud | |
-o, --org
|
สตริง | (ต้องระบุ) องค์กร Apigee คุณต้องเป็นผู้ดูแลระบบขององค์กร |
-p, --password
|
สตริง | (จำเป็นสำหรับการตรวจสอบสิทธิ์พื้นฐานเท่านั้น) รหัสผ่าน Apigee คุณระบุรหัสผ่านในไฟล์ .netrc ได้ (ไม่บังคับ) หากทำเช่นนั้น คุณก็ไม่จำเป็นต้อง
ระบุรหัสผ่านในบรรทัดคำสั่ง ดูเพิ่มเติม
การใช้ .netrc สำหรับข้อมูลเข้าสู่ระบบ
|
-r, --runtime
|
สตริง | URL ฐานของรันไทม์ Apigee (ต้องระบุสำหรับ Hybrid หรือ opdk) |
-t, --token
|
สตริง | (ต้องใช้สำหรับการตรวจสอบสิทธิ์โทเค็น OAuth เท่านั้น) โทเค็น OAuth หรือ SAML ที่คุณสร้าง จากข้อมูลบัญชี Apigee ดูข้อมูลเกี่ยวกับการสร้างโทเค็นได้ที่ การใช้ get_token และ เข้าถึง Management API ด้วย SAML |
-u, --username
|
สตริง | (ต้องใช้สำหรับการตรวจสอบสิทธิ์พื้นฐานเท่านั้น) ชื่อผู้ใช้ Apigee (โดยปกติคืออีเมล)
คุณระบุชื่อผู้ใช้ในไฟล์ .netrc ได้หากต้องการ หากทำเช่นนั้น คุณก็ไม่จำเป็นต้องระบุชื่อผู้ใช้ในบรรทัดคำสั่ง ดูการใช้ .netrc สำหรับข้อมูลเข้าสู่ระบบด้วย
|
-v, --verbose
|
(ไม่บังคับ) สร้างเอาต์พุตแบบละเอียด |
ตัวอย่าง
./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
คำสั่งความช่วยเหลือ
มีวิธีใช้แบบออนไลน์สำหรับคำสั่ง apigee-remote-service-cli ทั้งหมด เพียงพิมพ์ดังนี้
apigee-remote-service-cli help
หากต้องการความช่วยเหลือเกี่ยวกับคำสั่งใด ให้พิมพ์
apigee-remote-service-cli [command] help
เช่น
apigee-remote-service-cli provision help
คำสั่งจัดสรร
คำสั่ง apigee-remote-service-cli provision จะติดตั้งพร็อกซีในองค์กร Apigee
Edge ตั้งค่าใบรับรอง และสร้างข้อมูลเข้าสู่ระบบที่คุณจะต้องใช้
เพื่อกำหนดค่า Apigee Adapter สำหรับ Envoy
การใช้งาน
หากคุณใช้ Edge Public Cloud ให้ทำดังนี้
apigee-remote-service-cli provision -o $ORG -e $ENV -u $USERNAME -p $PASSWORD
หากคุณใช้ Edge Private Cloud ให้ทำดังนี้
apigee-remote-service-cli provision --opdk -o $ORG -e $ENV -u $USERNAME --management $MGMT_SERVER_URL --runtime $RUNTIME_URL -p $PASSWORD
พารามิเตอร์
| พารามิเตอร์ | ประเภท | คำอธิบาย |
|---|---|---|
-c, --config
|
สตริง | เส้นทางไปยังไฟล์กำหนดค่าบริการระยะไกลของ Apigee เคล็ดลับ: เมื่อระบุตัวเลือกนี้ คุณจะละเว้นพารามิเตอร์คำสั่งอื่นๆ ส่วนใหญ่ได้ ดู
การใช้ตัวเลือก--config
|
-e, --environment
|
สตริง | (ต้องระบุ) สภาพแวดล้อมในองค์กร |
-f, --force-proxy-install
|
(ไม่บังคับ) บังคับให้ติดตั้งพร็อกซี remote-service อีกครั้งหากมีการติดตั้งไว้ในองค์กรอยู่แล้ว
|
|
-h, --help
|
แสดงความช่วยเหลือสำหรับพารามิเตอร์คำสั่ง | |
-k, --key
|
สตริง | ระบุคีย์ที่ส่งคืนจาก
คำสั่ง apigee-remote-service-cli provision
|
--legacy
|
Apigee SaaS (ตั้งค่าการจัดการและ URL รันไทม์) | |
-m, --management
|
สตริง | (ต้องระบุหากคุณใช้ Apigee Private Cloud) URL ฐานของการจัดการ Apigee
ค่าเริ่มต้น: https://api.enterprise.apigee.com
|
-n, --namespace
|
สตริง | ส่งการกำหนดค่าเป็น Envoy ConfigMap ในเนมสเปซที่ระบุ |
--opdk
|
สตริง | Apigee OPDK |
-o, --organization
|
สตริง | (ต้องระบุ) องค์กร Apigee ของคุณ คุณต้องเป็นผู้ดูแลระบบขององค์กร |
-p, --password
|
สตริง | (จำเป็นสำหรับการตรวจสอบสิทธิ์พื้นฐานเท่านั้น) รหัสผ่าน Apigee คุณเลือกที่จะระบุ
รหัสผ่านในไฟล์ .netrc ได้ หากทำเช่นนั้น คุณก็ไม่จำเป็นต้อง
ระบุรหัสผ่านในบรรทัดคำสั่ง ดูเพิ่มเติม
การใช้ .netrc สำหรับข้อมูลเข้าสู่ระบบ
|
--rotate-int
|
int | หาก n > 0 ให้สร้างคีย์ส่วนตัวใหม่และเก็บคีย์สาธารณะ n คีย์ (ไฮบริดเท่านั้น) |
-r, --runtime
|
สตริง | URL ฐานของรันไทม์ Apigee (ต้องระบุสำหรับ Hybrid หรือ OPDK) |
-s, --secret
|
สตริง | ระบุลับที่ส่งคืนจากคำสั่ง apigee-remote-service-cli provision
|
--strength
|
int | (ไม่บังคับ) ระบุระดับความปลอดภัยของการเข้ารหัสสำหรับใบรับรอง SSL ที่ใช้ในการจัดสรรอะแดปเตอร์ ค่าเริ่มต้น 2048 |
-t, --token
|
สตริง | (Hybrid เท่านั้น) โทเค็น OAuth หรือ SAML ของ Apigee |
-u, --username
|
สตริง | (ต้องใช้สำหรับการตรวจสอบสิทธิ์พื้นฐานเท่านั้น) ชื่อผู้ใช้ Apigee (โดยปกติคืออีเมล)
คุณระบุชื่อผู้ใช้ในไฟล์ .netrc ได้หากต้องการ
ดูเพิ่มเติมที่การใช้ .netrc สำหรับข้อมูลเข้าสู่ระบบ
|
-v, --verbose
|
(ไม่บังคับ) สร้างเอาต์พุตแบบละเอียด | |
--virtual-hosts
|
สตริง | ลบล้างโฮสต์เสมือนเริ่มต้น ซึ่งคือ "default,secure" ใช้ตัวเลือกนี้หากคุณ มีโฮสต์เสมือนที่ระบุไว้สำหรับองค์กร-สภาพแวดล้อม Edge อื่นๆ นอกเหนือจากค่าเริ่มต้นเหล่านี้ ดูข้อมูลเกี่ยวกับโฮสต์เสมือนได้ในเอกสารประกอบของ Edge |
--years
|
int | (ไม่บังคับ) จำนวนปีก่อนที่ใบรับรอง SSL ที่ใช้ในการจัดสรรจะหมดอายุ ค่าเริ่มต้น: 1 |
ตัวอย่าง
อย่าลืมบันทึกเอาต์พุตของคำสั่ง provision ในไฟล์ ซึ่งจะใช้เป็นอินพุตสำหรับการดำเนินการอื่นๆ ของ Apigee Adapter สำหรับ Envoy
ตัวอย่าง Edge Public Cloud
apigee-remote-service-cli provision --legacy --username $USER --password $PASSWORD --organization $ORG --environment $ENV > config.yaml
ตัวอย่าง Apigee Hybrid
apigee-remote-service-cli provision --organization $ORG --environment $ENV --runtime $RUNTIME --namespace $NAMESPACE --token $TOKEN > config.yaml
คำสั่งโทเค็น
คุณใช้โทเค็น JWT เพื่อทำการเรียกพร็อกซี API ที่ได้รับการตรวจสอบสิทธิ์แทนการใช้คีย์ API ได้ คำสั่งโทเค็นช่วยให้คุณสร้าง ตรวจสอบ และหมุนเวียนโทเค็น JWT เพื่อวัตถุประสงค์นี้ได้
สร้างโทเค็น JWT
คุณสามารถใช้โทเค็น JWT เพื่อทำการเรียกพร็อกซี API ที่มีการตรวจสอบสิทธิ์ไปยังเป้าหมายบริการระยะไกล ดูการใช้การตรวจสอบสิทธิ์ตาม JWT ด้วยการใช้งาน
สำหรับ Edge Public Cloudapigee-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]
apigee-remote-service-cli token create -c [config_file] --id [consumer_key] --secret [consumer_secret] -r [runtime] -o [org] -e [env]
พารามิเตอร์
| พารามิเตอร์ | ประเภท | คำอธิบาย |
|---|---|---|
-c, --config
|
สตริง | (ต้องระบุ) เส้นทางไปยังไฟล์การกำหนดค่า Apigee Remote Service เคล็ดลับ: เมื่อระบุตัวเลือกนี้ คุณจะละเว้นพารามิเตอร์คำสั่งอื่นๆ ส่วนใหญ่ได้ ดู
การใช้ตัวเลือก--config
|
-e, --env
|
สตริง | (ต้องระบุ) สภาพแวดล้อมในองค์กร |
-h, --help
|
แสดงความช่วยเหลือสำหรับพารามิเตอร์คำสั่ง | |
--insecure
|
อนุญาตการเชื่อมต่อเซิร์ฟเวอร์ที่ไม่ปลอดภัยเมื่อใช้ SSL | |
-o, --org
|
สตริง | (ต้องระบุ) องค์กร Apigee คุณต้องเป็นผู้ดูแลระบบขององค์กร |
-r, --runtime
|
สตริง | URL ฐานของรันไทม์ Apigee (ต้องระบุสำหรับ Hybrid หรือ opdk เท่านั้น) |
-v, --verbose
|
(ไม่บังคับ) สร้างเอาต์พุตแบบละเอียด |
ตัวอย่าง
apigee-remote-service-cli token create -o myorg -e test -i YUmlZAcBKNsTAelJqPZFl3sh58ObATX9 -s icTARgaKHqvUH1dq -c config.yaml
เอาต์พุต
เมื่อสำเร็จ คุณจะเห็นเอาต์พุตโทเค็น JST ที่คล้ายกับตัวอย่างต่อไปนี้eyJraWQiOiIxIiwidHlwIjoiSldUIiwiYWxnIjoiUlMyNTYifQ.eyJhY2Nlc3NfdG9rZW4iOiJ0a2tlVzVKQTY2a0pZYTB4bFV1cVBsUW1BMU43IiwiYXVkIjoiaXN0aW8iLCJuYmYiOjE1MzAxMzg1OTEsImFwaV9wcm9kdWN0X2xpc3QiOlsiaXN0aW8tcHJvZHVjdCJdLCJhcHBsaWNhdGlvbl9uYW1lIjoiaXN0aW8tYXBwIiwiZGV2ZWxvcGVyX2VtYWlsIjoicFluZ2Zsb3lkQGdvb2dsZS5jb20iLCJpc3MiOiJodHRwczovL2FwaWdlZXNlYXJjaC10ZXN0LmFwaWdlZS5uZXQvaXN0aW8tYXV0aC90b2tlbiIsImV4cCI6MTUzMDEzOTQ5MSwiaWF0IjoxNTMwMTM4NTkxLCJqdGkiOiIxODgzMzViZi0wMmE4LTRjZGUsOGFkOS0yMWJmNDZjNmRjZDkiLCJjbGllbnRfaWQiOiJZVW1sWkFjQktOc1RBZWxKcVBZRmwzc2g1OE9iQVRYOSJ9.AL7pKSTmond-NSPRNNHVbIzTdAnZjOXcjQ-BbOJ_8lsQvF7PuiOUrGIhY5XTcJusisKgbCdtIxBl8Wq1EiQ_fKnUc3JYYOqzpTB5bGoFy0Yqbfu96dneuWyzgZnoQBkqwZkbQTIg7WNTGx1TJX-UTePvBPxAefiAbaEUcigX9tTsXPoRJZOTrm7IOeKpxpB_gQYkxQtV1_NbERxjTPyMbHdMWal9_xRVzSt7mpTGudMN9OR-VtQ1uXA67GOqhZWcOzq57qImOiCMbaoKnKUADevyWjX_VscN5ZZUtzQUQhTrmv8aR69-uVhMIPKp9juMyYKaYn2IsYZEeCWfhfV45Q
ตรวจสอบโทเค็น JWT
คุณตรวจสอบโทเค็น JWT ได้ด้วยคำสั่งนี้ ดูตรวจสอบโทเค็นด้วยการใช้งาน
สำหรับ Edge Public Cloudapigee-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]
apigee-remote-service-cli token inspect -o [organization] -e [environment] -f [token_file] --runtime [host_alias]
พารามิเตอร์
| พารามิเตอร์ | ประเภท | คำอธิบาย |
|---|---|---|
-c, --config
|
สตริง | (ต้องระบุ) เส้นทางไปยังไฟล์การกำหนดค่า Apigee Remote Service เคล็ดลับ: เมื่อระบุตัวเลือกนี้ คุณจะละเว้นพารามิเตอร์คำสั่งอื่นๆ ส่วนใหญ่ได้ ดู
การใช้ตัวเลือก--config
|
-e, --env
|
สตริง | (ต้องระบุ) สภาพแวดล้อมในองค์กร |
-h, --help
|
แสดงความช่วยเหลือสำหรับพารามิเตอร์คำสั่ง | |
--insecure
|
อนุญาตการเชื่อมต่อเซิร์ฟเวอร์ที่ไม่ปลอดภัยเมื่อใช้ SSL | |
-o, --org
|
สตริง | (ต้องระบุ) องค์กร Apigee คุณต้องเป็นผู้ดูแลระบบขององค์กร |
-r, --runtime
|
สตริง | URL ฐานของรันไทม์ Apigee (ต้องระบุสำหรับ Hybrid หรือ opdk เท่านั้น) |
-v, --verbose
|
(ไม่บังคับ) สร้างเอาต์พุตแบบละเอียด |
ตัวอย่าง
apigee-remote-service-cli token inspect -c config.yaml <<< $TOKEN
เอาต์พุต
เมื่อสำเร็จ คุณจะเห็นเอาต์พุตคล้ายกับตัวอย่างต่อไปนี้
{
"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.
หมุนเวียนโทเค็น JWT
หลังจากสร้าง JWT ในครั้งแรก คุณอาจต้องเปลี่ยนคู่คีย์สาธารณะ/คีย์ส่วนตัว ที่ Apigee Edge จัดเก็บไว้ในแผนที่คีย์-ค่า (KVM) ที่เข้ารหัส กระบวนการสร้างคู่คีย์ใหม่นี้เรียกว่าการหมุนเวียนคีย์ เมื่อหมุนเวียนคีย์ ระบบจะสร้างคู่คีย์ส่วนตัว/สาธารณะใหม่ และจัดเก็บไว้ใน KVM "istio" ในองค์กร/สภาพแวดล้อม Apigee Edge นอกจากนี้ ระบบจะเก็บคีย์สาธารณะเดิมไว้พร้อมกับค่ารหัสคีย์เดิมการใช้งาน
หากคุณใช้ 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]
พารามิเตอร์
| พารามิเตอร์ | ประเภท | คำอธิบาย |
|---|---|---|
-c, --config
|
สตริง | (ต้องระบุ) เส้นทางไปยังไฟล์การกำหนดค่า Apigee Remote Service เคล็ดลับ: เมื่อระบุตัวเลือกนี้ คุณจะละเว้นพารามิเตอร์คำสั่งอื่นๆ ส่วนใหญ่ได้ ดู
การใช้ตัวเลือก--config
|
-e, --env
|
สตริง | (ต้องระบุ) สภาพแวดล้อมในองค์กร |
-h, --help
|
แสดงความช่วยเหลือสำหรับพารามิเตอร์คำสั่ง | |
--insecure
|
อนุญาตการเชื่อมต่อเซิร์ฟเวอร์ที่ไม่ปลอดภัยเมื่อใช้ SSL | |
--truncate
|
int | จำนวนใบรับรองที่จะเก็บไว้ใน JWKS (ค่าเริ่มต้นคือ 2) |
-o, --org
|
สตริง | (ต้องระบุ) องค์กร Apigee คุณต้องเป็นผู้ดูแลระบบขององค์กร |
-r, --runtime
|
สตริง | URL ฐานของรันไทม์ Apigee (ต้องระบุสำหรับ Hybrid หรือ opdk) |
-v, --verbose
|
(ไม่บังคับ) สร้างเอาต์พุตแบบละเอียด |
ตัวอย่าง
apigee-remote-service-cli token rotate-cert -c config.yaml -o myorg -e test -k 2e238ffa15dc5ab6a1e97868e7581f6c60ddb8575478582c256d8b7e5b2677a8 -s 51058077223fa7b683c3bea845c5cca138340d1d5583922b6d465f9f918a4b08
เอาต์พุต
certificate successfully rotated
การใช้ .netrc สำหรับข้อมูลเข้าสู่ระบบ
apigee-remote-service-cli จะเลือก username และ
password (สำหรับการตรวจสอบสิทธิ์พื้นฐานเมื่อจำเป็น) จากไฟล์ .netrc
ในไดเรกทอรีหน้าแรกโดยอัตโนมัติ หากคุณใช้ Edge Public Cloud และมีรายการสำหรับเครื่อง api.enterprise.apigee.com หากคุณใช้ Apigee Private Cloud
ค่าเครื่องจะเหมือนกับ URL ของ management (เช่น
http://192.162.55.100)
ตัวอย่างใน 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
คำสั่งเวอร์ชัน
พิมพ์เวอร์ชัน CLI
apigee-remote-service-cli version
การใช้ตัวเลือกคำสั่ง --config
อาร์กิวเมนต์ --config จะระบุตำแหน่ง
ของไฟล์การกำหนดค่าที่สร้างขึ้นโดยคำสั่ง provision ข้อดีที่สำคัญของตัวเลือกนี้คือช่วยให้คุณข้ามพารามิเตอร์คำสั่งอื่นๆ ส่วนใหญ่ได้ ซึ่ง CLI จะดึงมาจากไฟล์กำหนดค่า
ตัวเลือกเหล่านี้มีดังนี้
- องค์กร
- สภาพแวดล้อม
- รันไทม์
- การจัดการ
- ไม่ปลอดภัย
- เนมสเปซ
- เดิม
- opdk
ตัวอย่างเช่น คุณสามารถเรียกใช้คำสั่ง provision ได้ดังนี้
apigee-remote-service-cli provision --config='old-config.yaml' > new-config.yaml
ไฟล์การกำหนดค่า
ส่วนนี้แสดงไฟล์การกำหนดค่าตัวอย่างที่มีตัวเลือกทั้งหมดที่ใช้ได้
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