คุณกำลังดูเอกสารประกอบของ Apigee Edge
ไปที่เอกสารประกอบของ Apigee X ข้อมูล
apigee-remote-service-cli
Command Line Interface (CLI) ช่วยให้คุณจัดสรรและจัดการอะแดปเตอร์ Apigee สำหรับ Envoy ได้
แสดงรายการคำสั่งการเชื่อมโยง
แสดงรายการผลิตภัณฑ์ API ทั้งหมดที่เชื่อมโยงกับบริการระยะไกล
การใช้งาน
apigee-remote-service-cli bindings list [flags]
พารามิเตอร์
พารามิเตอร์ | การมีบุคคลอยู่ | ใช้กับผลิตภัณฑ์ | คำอธิบาย |
---|---|---|---|
-c,
|
จำเป็น | ทั้งหมด | (สตริง) เส้นทางไปยังไฟล์การกำหนดค่าบริการระยะไกลของ Apigee เคล็ดลับ: แฟล็กนี้ทำให้คุณยกเว้นพารามิเตอร์คำสั่งอื่นๆ ส่วนใหญ่ได้ เนื่องจาก CLI ดึงพารามิเตอร์เหล่านั้นจากไฟล์การกำหนดค่าได้โดยตรง โปรดดูหัวข้อ การใช้ตัวเลือก ‑‑config
|
-e,
|
จำเป็น | ทั้งหมด | (สตริง) สภาพแวดล้อมในองค์กรของคุณ |
-h,
|
ไม่บังคับ | ทั้งหมด | แสดงความช่วยเหลือสำหรับพารามิเตอร์คำสั่ง |
‑‑insecure
|
ไม่บังคับ | ทั้งหมด | อนุญาตการเชื่อมต่อเซิร์ฟเวอร์ที่ไม่ปลอดภัยเมื่อใช้ SSL |
‑‑legacy
|
จำเป็น | Edge Public Cloud เท่านั้น | คุณต้องตั้งค่าแฟล็กนี้หากใช้ Apigee Edge สำหรับระบบคลาวด์สาธารณะ ตั้งค่า URL การจัดการและรันไทม์สำหรับ Apigee Edge สำหรับระบบคลาวด์สาธารณะ |
-m,
|
จำเป็น | Edge Private Cloud เท่านั้น | (สตริง) URL ฐานการจัดการของ Apigee Edge สำหรับการติดตั้ง Private Cloud
ค่าเริ่มต้น: https://api.enterprise.apigee.com
|
‑‑mfa
| จำเป็น | Edge Public Cloud เท่านั้น | (สตริง) โทเค็นการให้สิทธิ์แบบหลายปัจจัยสำหรับ Apigee Edge สำหรับระบบคลาวด์สาธารณะ จำเป็นต่อเมื่อมีการตั้งค่า MFA ในบัญชี Apigee Edge เท่านั้น |
‑‑opdk
| จำเป็น | Edge Private Cloud เท่านั้น | คุณต้องตั้งค่าแฟล็กนี้หากใช้ Apigee Edge สำหรับ Private Cloud |
-o,
|
จำเป็น | ทั้งหมด | (สตริง) องค์กร Apigee คุณต้องเป็นผู้ดูแลระบบองค์กร |
-p,
|
จำเป็น (การตรวจสอบสิทธิ์พื้นฐานเท่านั้น) |
Edge Public และ Private Cloud เท่านั้น | (สตริง) รหัสผ่าน Apigee คุณจะระบุรหัสผ่านในไฟล์ .netrc หรือไม่ก็ได้ ดูการใช้ .netrc สำหรับข้อมูลเข้าสู่ระบบ
|
-r,
|
จำเป็น | Edge Private Cloud และ Apigee แบบผสมเท่านั้น | (สตริง) ระบุ URL รันไทม์สำหรับอินสแตนซ์ Private Cloud หรืออินสแตนซ์แบบผสมของ Apigee
URL ต้องขึ้นต้นด้วย https:// ตัวอย่าง: https://apitest.apigee-hybrid-docs.net
|
|
ไม่บังคับ | Edge Private Cloud เท่านั้น | (สตริง) ระบุใบรับรอง TLS ฝั่งไคลเอ็นต์ คีย์ส่วนตัว และ CA รูทสำหรับการเชื่อมต่อ mTLS |
-t,
|
จำเป็น (การตรวจสอบสิทธิ์โทเค็น OAuth เท่านั้น) |
ทั้งหมด | (สตริง) โทเค็น OAuth หรือ SAML ที่คุณสร้างจากข้อมูลบัญชี Apigee ลบล้างข้อมูลเข้าสู่ระบบอื่นๆ ที่ให้ไว้ |
-u,
|
จำเป็น (การตรวจสอบสิทธิ์พื้นฐานเท่านั้น) |
Edge Public และ Private Cloud เท่านั้น |
(สตริง) ชื่อผู้ใช้ Apigee ของคุณ (โดยทั่วไปจะเป็นอีเมล)
คุณจะระบุชื่อผู้ใช้ในไฟล์ .netrc หรือไม่ก็ได้ หากทำเช่นนั้น คุณไม่จำเป็นต้องระบุชื่อผู้ใช้ในบรรทัดคำสั่ง ดูการใช้ .netrc สำหรับข้อมูลเข้าสู่ระบบ
|
-v,
|
ไม่บังคับ | ทั้งหมด | (ไม่บังคับ) สร้างเอาต์พุตแบบละเอียด |
ตัวอย่าง
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:
คำสั่งช่วยเหลือ
มีความช่วยเหลือออนไลน์สำหรับคำสั่งทั้งหมดของ 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
จะติดตั้งพร็อกซี API 2 รายการในองค์กร Apigee Edge ของคุณ ตั้งค่าใบรับรอง และสร้างข้อมูลเข้าสู่ระบบที่คุณจะต้องใช้กำหนดค่าอะแดปเตอร์ Apigee สำหรับ Envoy
การใช้งาน
apigee-remote-service-cli provision [flags]
พารามิเตอร์
พารามิเตอร์ | การมีบุคคลอยู่ | ใช้กับผลิตภัณฑ์ | คำอธิบาย |
---|---|---|---|
‑‑analytics-sa
|
ไม่บังคับ | Apigee แบบผสมและ Apigee X เท่านั้น |
(สตริง) ใช้แฟล็กนี้เพื่อระบุเส้นทางไปยังไฟล์คีย์บัญชีบริการ Google Cloud ซึ่งบัญชีบริการมีบทบาท |
-c,
|
จำเป็น | ทั้งหมด | (สตริง) เส้นทางไปยังไฟล์การกำหนดค่าบริการระยะไกลของ Apigee เคล็ดลับ: แฟล็กนี้ทำให้คุณยกเว้นพารามิเตอร์คำสั่งอื่นๆ ส่วนใหญ่ได้ เนื่องจาก CLI ดึงพารามิเตอร์เหล่านั้นจากไฟล์การกำหนดค่าได้โดยตรง โปรดดูหัวข้อ การใช้ตัวเลือก ‑‑config
|
-e,
|
จำเป็น | ทั้งหมด | (สตริง) สภาพแวดล้อมในองค์กรของคุณ |
-f, ‑‑force-proxy-install
|
ไม่บังคับ | ทั้งหมด | (ไม่บังคับ) บังคับให้ติดตั้งพร็อกซี remote-service ใหม่หากมีการติดตั้งไว้ในองค์กรแล้ว
|
-h,
|
ไม่บังคับ | ทั้งหมด | แสดงความช่วยเหลือสำหรับพารามิเตอร์คำสั่ง |
‑‑insecure
|
ไม่บังคับ | ทั้งหมด | อนุญาตการเชื่อมต่อเซิร์ฟเวอร์ที่ไม่ปลอดภัยเมื่อใช้ SSL |
‑‑legacy
|
จำเป็น | Edge Public Cloud เท่านั้น | คุณต้องตั้งค่าแฟล็กนี้หากใช้ Apigee Edge สำหรับระบบคลาวด์สาธารณะ ตั้งค่า URL การจัดการและรันไทม์สำหรับ Apigee Edge สำหรับระบบคลาวด์สาธารณะ |
-m,
|
จำเป็น | Edge Private Cloud เท่านั้น | (สตริง) URL ฐานการจัดการของ Apigee Edge สำหรับการติดตั้ง Private Cloud
ค่าเริ่มต้น: https://api.enterprise.apigee.com
|
‑‑mfa
| จำเป็น | Edge Public Cloud เท่านั้น | โทเค็นการให้สิทธิ์แบบหลายปัจจัยสำหรับ Apigee Edge สำหรับระบบคลาวด์สาธารณะ จำเป็นต่อเมื่อมีการตั้งค่า MFA ในบัญชี Apigee Edge เท่านั้น |
-n, ‑‑namespace
|
ไม่บังคับ | ทั้งหมด | (สตริง) ส่งการกำหนดค่าเป็น Envoy ConfigMap ในเนมสเปซที่ระบุ ค่าเริ่มต้น: apigee
|
‑‑opdk
| จำเป็น | Edge Private Cloud เท่านั้น | คุณต้องตั้งค่าแฟล็กนี้หากใช้ Apigee Edge สำหรับ Private Cloud |
-o,
|
จำเป็น | ทั้งหมด | (สตริง) องค์กร Apigee คุณต้องเป็นผู้ดูแลระบบองค์กรจึงจะจัดสรรได้ |
-p,
|
จำเป็น (การตรวจสอบสิทธิ์พื้นฐานเท่านั้น) |
Edge Public และ Private Cloud เท่านั้น | (สตริง) รหัสผ่าน Apigee หรือคุณจะระบุรหัสผ่านในไฟล์ .netrc ก็ได้ หากทำเช่นนั้น คุณไม่จำเป็นต้องระบุรหัสผ่านในบรรทัดคำสั่ง ดูการใช้ .netrc สำหรับข้อมูลเข้าสู่ระบบ
|
‑‑rotate-int
|
ไม่บังคับ | Apigee แบบผสมเท่านั้น | (จำนวนเต็ม) หากเป็น n > 0 ให้สร้างคีย์ส่วนตัวใหม่และเก็บคีย์สาธารณะ n ไว้ (ไฮบริดเท่านั้น) |
-r,
|
จำเป็น | Edge Private Cloud และ Apigee แบบผสมเท่านั้น | (สตริง) ระบุ URL รันไทม์สำหรับอินสแตนซ์ Private Cloud หรืออินสแตนซ์แบบผสมของ Apigee
URL ต้องขึ้นต้นด้วย https:// ตัวอย่าง: https://apitest.apigee-hybrid-docs.net
|
|
ไม่บังคับ | Edge Private Cloud เท่านั้น | (สตริง) ระบุใบรับรอง TLS ฝั่งไคลเอ็นต์ คีย์ส่วนตัว และ CA รูทสำหรับการเชื่อมต่อ mTLS |
-t,
|
จำเป็น (การตรวจสอบสิทธิ์โทเค็น OAuth เท่านั้น) |
ทั้งหมด | (สตริง) โทเค็น OAuth หรือ SAML ที่คุณสร้างจากข้อมูลบัญชี Apigee ลบล้างข้อมูลเข้าสู่ระบบอื่นๆ ที่ให้ไว้ |
-u,
|
จำเป็น (การตรวจสอบสิทธิ์พื้นฐานเท่านั้น) |
Edge Public และ Private Cloud เท่านั้น |
(สตริง) ชื่อผู้ใช้ Apigee ของคุณ (โดยทั่วไปจะเป็นอีเมล)
คุณจะระบุชื่อผู้ใช้ในไฟล์ .netrc หรือไม่ก็ได้ ดูการใช้ .netrc สำหรับข้อมูลเข้าสู่ระบบ
|
-v,
|
ไม่บังคับ | ทั้งหมด | (ไม่บังคับ) สร้างเอาต์พุตแบบละเอียด |
‑‑virtual-hosts
|
ไม่บังคับ | Edge Private Cloud เท่านั้น | (สตริง) ลบล้างโฮสต์เสมือนเริ่มต้น ซึ่งก็คือ default,secure ใช้ตัวเลือกนี้หากคุณมีโฮสต์เสมือนที่ระบุไว้สำหรับสภาพแวดล้อมองค์กร Edge ของคุณนอกเหนือจากค่าเริ่มต้นเหล่านี้
|
ตัวอย่าง
ตามตัวอย่างต่อไปนี้ คุณต้องบันทึกเอาต์พุตของคำสั่ง provision
ในไฟล์ ซึ่งใช้เป็นอินพุตสำหรับอะแดปเตอร์ Apigee อื่นๆ สำหรับการดำเนินการของ Envoy
ตัวอย่าง
apigee-remote-service-cli provision --legacy --mfa $MFA --username $USER --password $PASSWORD \ --organization $ORG --environment $ENV > config.yaml
คำสั่งลองฟัง
สร้างและแสดงไฟล์การกำหนดค่าตัวอย่าง
สร้างไฟล์การกำหนดค่าตัวอย่าง
สร้างไฟล์การกำหนดค่าตัวอย่างสำหรับการทำให้ Envoy และ Istio ใช้งานได้แบบเนทีฟ
การใช้งาน
apigee-remote-service-cli samples create [flags]
คำอธิบาย
คำสั่งนี้ต้องใช้ไฟล์ config.yaml
ที่ถูกต้องเป็นอินพุต ไฟล์อินพุตนี้คือไฟล์ที่สร้างขึ้นผ่านการจัดสรร
โดยค่าเริ่มต้น ไฟล์ตัวอย่างจะแสดงไปยังไดเรกทอรีที่ชื่อ ./samples
คำสั่งจะสร้างไดเรกทอรีนี้ให้คุณ
หากคุณใช้ Envoy แบบเนทีฟ คำสั่งจะใช้โฮสต์บริการเป้าหมายและชื่อที่ต้องการสำหรับคลัสเตอร์ นอกจากนี้ ยังตั้งค่าการเชื่อมต่อ SSL ที่กำหนดเองจากพร็อกซี Envoy ไปยังคลัสเตอร์บริการระยะไกล หากมีโฟลเดอร์ที่มี tls.key
และ tls.crt
ผ่าน --tls
หากคุณใช้ Istio โดยที่พร็อกซี Envoy ทําหน้าที่เป็นไฟล์ช่วยเหลือ หากไม่ได้กําหนดเป้าหมาย ระบบจะสร้างตัวอย่าง httpbin
ไม่เช่นนั้น คุณต้องรับผิดชอบในการเตรียมไฟล์การกำหนดค่าที่เกี่ยวข้องกับการทำให้บริการเป้าหมายใช้งานได้
พารามิเตอร์
พารามิเตอร์ | การมีบุคคลอยู่ | ใช้กับผลิตภัณฑ์ | คำอธิบาย |
---|---|---|---|
‑‑adapter‑host
|
จำเป็นสำหรับเทมเพลต Envoy เท่านั้น | ทั้งหมด | (สตริง) ชื่อโฮสต์ของอะแดปเตอร์ (ค่าเริ่มต้น: localhost )
|
-c, ‑‑config
|
จำเป็น | ทั้งหมด | (สตริง) เส้นทางไปยังไฟล์การกำหนดค่าบริการระยะไกลของ Apigee เคล็ดลับ: แฟล็กนี้ทำให้คุณยกเว้นพารามิเตอร์คำสั่งอื่นๆ ส่วนใหญ่ได้ เนื่องจาก CLI ดึงพารามิเตอร์เหล่านั้นจากไฟล์การกำหนดค่าได้โดยตรง โปรดดูหัวข้อ การใช้ตัวเลือก ‑‑config
|
-f, ‑‑force
|
ไม่บังคับ | ทั้งหมด | บังคับเขียนทับไดเรกทอรีที่มีอยู่ |
-h, ‑‑help
|
ไม่บังคับ | ทั้งหมด | แสดงความช่วยเหลือสำหรับพารามิเตอร์คำสั่ง |
‑‑host |
จำเป็นสำหรับเทมเพลต Envoy เท่านั้น | ทั้งหมด | (สตริง) โฮสต์บริการเป้าหมาย (ค่าเริ่มต้น httpbin.org )
|
-n, ‑‑name |
จำเป็น | ทั้งหมด | (สตริง) ชื่อบริการเป้าหมาย (ค่าเริ่มต้น httpbin.org )
|
‑‑out
|
ไม่บังคับ | ทั้งหมด | (สตริง) ไดเรกทอรีที่ใช้สร้างไฟล์การกำหนดค่าตัวอย่าง ค่าเริ่มต้น: ./samples
|
‑‑tag
|
จำเป็นสำหรับเทมเพลต Istio เท่านั้น | ทั้งหมด | (สตริง) แท็กเวอร์ชันของอิมเมจอะแดปเตอร์ Envoy ค่าเริ่มต้น: v2.0.0
|
-t, ‑‑template
|
จำเป็น | ทั้งหมด | (สตริง) ชื่อเทมเพลต Envoy หรือ Istio หากต้องการดูรายการเทมเพลตที่ใช้ได้ ให้เรียกใช้คำสั่ง apigee-remote-service samples templates
|
‑‑tls
|
ไม่บังคับ สำหรับเทมเพลต Envoy เท่านั้น | ทั้งหมด | (สตริง) ไดเรกทอรีที่มีไฟล์ tls.key และ tls.crt ซึ่งใช้สำหรับบริการอะแดปเตอร์
|
ตัวอย่าง
apigee-remote-service-cli samples create -c ./config.yaml
แสดงรายการตัวเลือกเทมเพลตที่ใช้ได้
แสดงรายการเทมเพลตที่ใช้ได้กับพารามิเตอร์ --templates
สำหรับคำสั่ง samples
การใช้งาน
apigee-remote-service-cli samples templates
พารามิเตอร์
ไม่มี
ตัวอย่าง
apigee-remote-service-cli samples templates
Supported templates (native is deprecated): envoy-1.15 envoy-1.16 envoy-1.17 istio-1.7 istio-1.8 istio-1.9
คำสั่งโทเค็น
คุณใช้โทเค็น JWT เพื่อทำการเรียกพร็อกซี API ที่ผ่านการตรวจสอบสิทธิ์แทนการใช้คีย์ API ได้ คำสั่งโทเค็นช่วยให้คุณสร้าง ตรวจสอบ และหมุนเวียนโทเค็น JWT เพื่อวัตถุประสงค์นี้ได้
สร้างโทเค็น JWT
คุณใช้โทเค็น JWT เพื่อทำการเรียกพร็อกซี API ที่ตรวจสอบสิทธิ์ไปยังเป้าหมายบริการระยะไกลได้ ดูการใช้การตรวจสอบสิทธิ์ที่ใช้ JWT เพิ่มเติมการใช้งาน
apigee-remote-service-cli token create [flags]
พารามิเตอร์
พารามิเตอร์ | การมีบุคคลอยู่ | ใช้กับผลิตภัณฑ์ | คำอธิบาย |
---|---|---|---|
-c,
|
จำเป็น | ทั้งหมด | (สตริง) เส้นทางไปยังไฟล์การกำหนดค่าบริการระยะไกลของ Apigee เคล็ดลับ: แฟล็กนี้ทำให้คุณยกเว้นพารามิเตอร์คำสั่งอื่นๆ ส่วนใหญ่ได้ เนื่องจาก CLI ดึงพารามิเตอร์เหล่านั้นจากไฟล์การกำหนดค่าได้โดยตรง โปรดดูหัวข้อ การใช้ตัวเลือก ‑‑config
|
-e,
|
จำเป็น | ทั้งหมด | (สตริง) สภาพแวดล้อมในองค์กรของคุณ |
-h,
|
ไม่บังคับ | ทั้งหมด | แสดงความช่วยเหลือสำหรับพารามิเตอร์คำสั่ง |
--i, --id
|
จำเป็น | ทั้งหมด | (สตริง) ข้อมูลเข้าสู่ระบบคีย์ที่พบในแอปนักพัฒนาซอฟต์แวร์ Apigee ตามที่อธิบายไว้ในวิธีรับคีย์ API |
‑‑insecure
|
ไม่บังคับ | ทั้งหมด | อนุญาตการเชื่อมต่อเซิร์ฟเวอร์ที่ไม่ปลอดภัยเมื่อใช้ SSL |
‑‑legacy
|
จำเป็น | Edge Public Cloud เท่านั้น | คุณต้องตั้งค่าแฟล็กนี้หากใช้ Apigee Edge สำหรับระบบคลาวด์สาธารณะ ตั้งค่า URL การจัดการและรันไทม์สำหรับ Apigee Edge สำหรับระบบคลาวด์สาธารณะ |
‑‑opdk
| จำเป็น | Edge Private Cloud เท่านั้น | คุณต้องตั้งค่าแฟล็กนี้หากใช้ Apigee Edge สำหรับ Private Cloud |
-o,
|
จำเป็น | ทั้งหมด | (สตริง) องค์กร Apigee คุณต้องเป็นผู้ดูแลระบบองค์กร |
-r,
|
จำเป็น | Edge Private Cloud และ Apigee แบบผสมเท่านั้น | (สตริง) ระบุ URL รันไทม์สำหรับอินสแตนซ์ Private Cloud หรืออินสแตนซ์แบบผสมของ Apigee
URL ต้องขึ้นต้นด้วย https:// ตัวอย่าง: https://apitest.apigee-hybrid-docs.net
|
--s, ‑‑secret
|
จำเป็น | ทั้งหมด | (สตริง) ข้อมูลเข้าสู่ระบบ Secret ที่พบในแอปนักพัฒนาซอฟต์แวร์ Apigee ตามที่อธิบายไว้ในวิธีรับคีย์ API |
|
ไม่บังคับ | Edge Private Cloud เท่านั้น | (สตริง) ระบุใบรับรอง TLS ฝั่งไคลเอ็นต์ คีย์ส่วนตัว และ CA รูทสำหรับการเชื่อมต่อ mTLS |
-v,
|
ไม่บังคับ | ทั้งหมด | (ไม่บังคับ) สร้างเอาต์พุตแบบละเอียด |
ตัวอย่าง
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 ด้วยคำสั่งนี้ได้ โปรดดูหัวข้อตรวจสอบโทเค็นการใช้งาน
apigee-remote-service-cli token inspect [flags]
พารามิเตอร์
พารามิเตอร์
พารามิเตอร์ | การมีบุคคลอยู่ | ใช้กับผลิตภัณฑ์ | คำอธิบาย |
---|---|---|---|
-c,
|
จำเป็น | ทั้งหมด | (สตริง) เส้นทางไปยังไฟล์การกำหนดค่าบริการระยะไกลของ Apigee เคล็ดลับ: แฟล็กนี้ทำให้คุณยกเว้นพารามิเตอร์คำสั่งอื่นๆ ส่วนใหญ่ได้ เนื่องจาก CLI ดึงพารามิเตอร์เหล่านั้นจากไฟล์การกำหนดค่าได้โดยตรง โปรดดูหัวข้อ การใช้ตัวเลือก ‑‑config
|
-e,
|
จำเป็น | ทั้งหมด | (สตริง) สภาพแวดล้อมในองค์กรของคุณ |
-f,
|
จำเป็น | ทั้งหมด | (สตริง) ไฟล์โทเค็น (ค่าเริ่มต้น: ใช้ stdin )
|
-h,
|
ไม่บังคับ | ทั้งหมด | แสดงความช่วยเหลือสำหรับพารามิเตอร์คำสั่ง |
‑‑insecure
|
ไม่บังคับ | ทั้งหมด | อนุญาตการเชื่อมต่อเซิร์ฟเวอร์ที่ไม่ปลอดภัยเมื่อใช้ SSL |
‑‑legacy
|
จำเป็น | Edge Public Cloud เท่านั้น | คุณต้องตั้งค่าแฟล็กนี้หากใช้ Apigee Edge สำหรับระบบคลาวด์สาธารณะ ตั้งค่า URL การจัดการและรันไทม์สำหรับ Apigee Edge สำหรับระบบคลาวด์สาธารณะ |
‑‑opdk
| จำเป็น | Edge Private Cloud เท่านั้น | คุณต้องตั้งค่าแฟล็กนี้หากใช้ Apigee Edge สำหรับ Private Cloud |
-o,
|
จำเป็น | ทั้งหมด | (สตริง) องค์กร Apigee คุณต้องเป็นผู้ดูแลระบบองค์กร |
-r,
|
จำเป็น | Edge Private Cloud และ Apigee แบบผสมเท่านั้น | (สตริง) ระบุ URL รันไทม์สำหรับอินสแตนซ์ Private Cloud หรืออินสแตนซ์แบบผสมของ Apigee
URL ต้องขึ้นต้นด้วย https:// ตัวอย่าง: https://apitest.apigee-hybrid-docs.net
|
|
ไม่บังคับ | Edge Private Cloud เท่านั้น | (สตริง) ระบุใบรับรอง TLS ฝั่งไคลเอ็นต์ คีย์ส่วนตัว และ CA รูทสำหรับการเชื่อมต่อ mTLS |
-v,
|
ไม่บังคับ | ทั้งหมด | (ไม่บังคับ) สร้างเอาต์พุตแบบละเอียด |
ตัวอย่าง
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 จัดเก็บไว้ในแมปคีย์-ค่าที่เข้ารหัส (KVM) กระบวนการสร้างคู่คีย์ใหม่เรียกว่าการหมุนเวียนคีย์ เมื่อคุณหมุนเวียนคีย์ ระบบจะสร้างคู่คีย์ส่วนตัว/สาธารณะใหม่และจัดเก็บใน KVM "istio" ในองค์กร/สภาพแวดล้อม Apigee นอกจากนี้ ระบบจะเก็บคีย์สาธารณะเดิมพร้อมกับค่ารหัสคีย์เดิมการใช้งาน
apigee-remote-service-cli token rotate-cert [flags]
พารามิเตอร์
พารามิเตอร์ | การมีบุคคลอยู่ | ใช้กับผลิตภัณฑ์ | คำอธิบาย |
---|---|---|---|
-c,
|
จำเป็น | ทั้งหมด | (สตริง) เส้นทางไปยังไฟล์การกำหนดค่าบริการระยะไกลของ Apigee เคล็ดลับ: แฟล็กนี้ทำให้คุณยกเว้นพารามิเตอร์คำสั่งอื่นๆ ส่วนใหญ่ได้ เนื่องจาก CLI ดึงพารามิเตอร์เหล่านั้นจากไฟล์การกำหนดค่าได้โดยตรง โปรดดูหัวข้อ การใช้ตัวเลือก ‑‑config
|
-e,
|
จำเป็น | ทั้งหมด | (สตริง) สภาพแวดล้อมในองค์กรของคุณ |
-h,
|
ไม่บังคับ | Edge Public และ Private Cloud เท่านั้น | แสดงความช่วยเหลือสำหรับพารามิเตอร์คำสั่ง |
--k, --key
|
จำเป็น | Edge Public และ Private Cloud เท่านั้น | (สตริง) คีย์การจัดสรร |
‑‑insecure
|
ไม่บังคับ | Edge Public และ Private Cloud เท่านั้น | อนุญาตการเชื่อมต่อเซิร์ฟเวอร์ที่ไม่ปลอดภัยเมื่อใช้ SSL |
‑‑legacy
|
จำเป็น | Edge Public Cloud เท่านั้น | คุณต้องตั้งค่าแฟล็กนี้หากใช้ Apigee Edge สำหรับระบบคลาวด์สาธารณะ ตั้งค่า URL การจัดการและรันไทม์สำหรับ Apigee Edge สำหรับระบบคลาวด์สาธารณะ |
‑‑opdk
| จำเป็น | Edge Private Cloud เท่านั้น | คุณต้องตั้งค่าแฟล็กนี้หากใช้ Apigee Edge สำหรับ Private Cloud |
-o,
|
จำเป็น | Edge Public และ Private Cloud เท่านั้น | (สตริง) องค์กร Apigee คุณต้องเป็นผู้ดูแลระบบองค์กร |
-r,
|
จำเป็น | Edge Private Cloud เท่านั้น | (สตริง) ระบุ URL รันไทม์สำหรับอินสแตนซ์ Private Cloud หรืออินสแตนซ์แบบผสมของ Apigee
URL ต้องขึ้นต้นด้วย https:// ตัวอย่าง: https://apitest.apigee-hybrid-docs.net
|
--s, ‑‑secret
|
จำเป็น | ทั้งหมด | (สตริง) ข้อมูลลับในการจัดสรร |
|
ไม่บังคับ | Edge Private Cloud เท่านั้น | (สตริง) ระบุใบรับรอง TLS ฝั่งไคลเอ็นต์ คีย์ส่วนตัว และ CA รูทสำหรับการเชื่อมต่อ mTLS |
--t, ‑‑truncate
|
จำเป็น | ทั้งหมด | (จำนวนเต็ม) จำนวนใบรับรองที่จะเก็บไว้ใน JWKS (ค่าเริ่มต้นคือ 2) |
-v,
|
ไม่บังคับ | ทั้งหมด | (ไม่บังคับ) สร้างเอาต์พุตแบบละเอียด |
ตัวอย่าง
apigee-remote-service-cli token rotate-cert -c config.yaml -o myorg -e test \ -k 2e238ffa15dc5ab6a1e97868e7581f6c60ddb8575478582c256d8b7e5b2677a8 \ -s 51058077223fa7b683c3bea845c5cca138340d1d5583922b6d465f9f918a4b08
เอาต์พุต
certificate successfully rotated
สร้างโทเค็นภายใน
สร้างโทเค็น JWT สำหรับการให้สิทธิ์การเรียก API บริการระยะไกลการใช้งาน
apigee-remote-service-cli token internal [flags]
พารามิเตอร์
พารามิเตอร์
พารามิเตอร์ | การมีบุคคลอยู่ | ใช้กับผลิตภัณฑ์ | คำอธิบาย |
---|---|---|---|
-c,
|
จำเป็น | Apigee แบบผสมเท่านั้น | (สตริง) เส้นทางไปยังไฟล์การกำหนดค่าบริการระยะไกลของ Apigee เคล็ดลับ: แฟล็กนี้ทำให้คุณยกเว้นพารามิเตอร์คำสั่งอื่นๆ ส่วนใหญ่ได้ เนื่องจาก CLI ดึงพารามิเตอร์เหล่านั้นจากไฟล์การกำหนดค่าได้โดยตรง โปรดดูหัวข้อ การใช้ตัวเลือก ‑‑config
|
-d,
|
จำเป็น | Apigee แบบผสมเท่านั้น | (สตริง) เวลาที่ถูกต้องของ JWT ภายในตั้งแต่การสร้าง (ค่าเริ่มต้น: 10m0s (10 นาที))
|
-e,
|
จำเป็น | Apigee แบบผสมเท่านั้น | (สตริง) สภาพแวดล้อมในองค์กรของคุณ |
-h,
|
ไม่บังคับ | Apigee แบบผสมเท่านั้น | แสดงความช่วยเหลือสำหรับพารามิเตอร์คำสั่ง |
‑‑insecure
|
ไม่บังคับ | Apigee แบบผสมเท่านั้น | อนุญาตการเชื่อมต่อเซิร์ฟเวอร์ที่ไม่ปลอดภัยเมื่อใช้ SSL |
-o,
|
จำเป็น | Apigee แบบผสมเท่านั้น | (สตริง) องค์กร Apigee คุณต้องเป็นผู้ดูแลระบบองค์กร |
-r,
|
จำเป็น | Apigee แบบผสมเท่านั้น | (สตริง) ระบุ URL รันไทม์สำหรับอินสแตนซ์แบบผสมของ Apigee
URL ต้องขึ้นต้นด้วย https:// ตัวอย่าง: https://apitest.apigee-hybrid-docs.net
|
-v,
|
ไม่บังคับ | Apigee แบบผสมเท่านั้น | (ไม่บังคับ) สร้างเอาต์พุตแบบละเอียด |
คำสั่งเวอร์ชัน
พิมพ์เวอร์ชัน CLI
apigee-remote-service-cli version
การใช้ .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ตัวอย่างเช่น Edge Private Cloud
machine http://192.162.55.100 login jdoe@google.com password abc123
การใช้ตัวเลือกคําสั่ง ‑‑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 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 products: refresh_rate: 2m analytics: legacy_endpoint: false file_limit: 1024 send_channel_size: 10 collection_interval: 10s auth: api_key_claim: claim api_key_cache_duration: 30m api_key_header: x-api-key api_header: :authority allow_unauthorized: false jwt_provider_key: https://org-test.apigee.net/remote-token/token append_metadata_headers: true