ข้อมูลอ้างอิง

คุณกำลังดูเอกสารประกอบ Apigee Edge
ไปที่ เอกสารประกอบเกี่ยวกับ Apigee X. ข้อมูล

apigee-remote-service-cli อินเทอร์เฟซบรรทัดคำสั่ง (CLI) ช่วยให้คุณ จัดสรรและจัดการอะแดปเตอร์ Apigee สำหรับ Envoy

แสดงรายการคำสั่งการเชื่อมโยง

แสดงรายการผลิตภัณฑ์ API ทั้งหมดที่เชื่อมโยงกับบริการระยะไกล

การใช้งาน

apigee-remote-service-cli bindings list [flags]

พารามิเตอร์

พารามิเตอร์ การมีบุคคลอยู่ ใช้กับผลิตภัณฑ์ คำอธิบาย
-c,
‑‑config 		ต้องระบุ ทั้งหมด (สตริง) เส้นทางไปยังไฟล์การกำหนดค่า Apigee Remote Service
เคล็ดลับ: แฟล็กนี้ทำให้คุณสามารถข้ามพารามิเตอร์คำสั่งอื่นๆ ส่วนใหญ่ได้ เนื่องจาก CLI จะดึง URL จากไฟล์การกำหนดค่าได้โดยตรง โปรดดู กำลังใช้ตัวเลือก ‑‑config
-e,
‑‑environment 		ต้องระบุ ทั้งหมด (สตริง) สภาพแวดล้อมในองค์กร
-h,
‑‑help 		ไม่บังคับ ทั้งหมด แสดงความช่วยเหลือสำหรับพารามิเตอร์คำสั่ง
‑‑insecure ไม่บังคับ ทั้งหมด อนุญาตการเชื่อมต่อเซิร์ฟเวอร์ที่ไม่ปลอดภัยเมื่อใช้ SSL
‑‑legacy ต้องระบุ Edge ระบบคลาวด์สาธารณะเท่านั้น คุณต้องตั้งค่าสถานะนี้หากใช้ Apigee Edge สำหรับ Public Cloud อยู่ ตั้งค่า URL การจัดการและรันไทม์ สำหรับ Apigee Edge สำหรับ Public Cloud
-m,
‑‑management 		ต้องระบุ Edge Private Cloud เท่านั้น (สตริง) URL ฐานการจัดการสำหรับการติดตั้ง Apigee Edge สำหรับ Private Cloud ค่าเริ่มต้น: https://api.enterprise.apigee.com
‑‑mfa ต้องระบุ Edge ระบบคลาวด์สาธารณะเท่านั้น (สตริง) โทเค็นการให้สิทธิ์แบบหลายปัจจัยสำหรับ Apigee Edge สำหรับ Public Cloud จำเป็นต่อเมื่อ MFA เท่านั้น ได้รับการตั้งค่าในบัญชี Apigee Edge ของคุณ
‑‑opdk ต้องระบุ Edge Private Cloud เท่านั้น โดยคุณต้องตั้งค่าสถานะนี้หากใช้ Apigee Edge สำหรับ Private Cloud อยู่
-o,
‑‑organization 		ต้องระบุ ทั้งหมด (สตริง) องค์กร Apigee คุณต้องเป็นผู้ดูแลระบบขององค์กร
-p,
‑‑password 		จำเป็น
(การตรวจสอบสิทธิ์พื้นฐานเท่านั้น)		 Edge สาธารณะและ Private Cloud เท่านั้น (สตริง) รหัสผ่าน Apigee ของคุณ คุณสามารถเลือกระบุ รหัสผ่านในไฟล์ .netrc ดูเพิ่มเติม ใช้ .netrc สำหรับข้อมูลเข้าสู่ระบบ
-r,
‑‑runtime 		ต้องระบุ Edge Private Cloud และ Apigee แบบผสมเท่านั้น (สตริง) ระบุ URL รันไทม์สำหรับอินสแตนซ์แบบผสมของ Private Cloud หรือ Apigee URL ต้องขึ้นต้นด้วย https:// เช่น https://apitest.apigee-hybrid-docs.net
‑‑tls‑cert
‑‑tls‑key
‑‑tls‑ca 		ไม่บังคับ Edge Private Cloud เท่านั้น (สตริง) ระบุใบรับรอง TLS ฝั่งไคลเอ็นต์ คีย์ส่วนตัว และ CA รูทสำหรับการเชื่อมต่อ mTLS
-t,
‑‑token 		ต้องระบุ
(การตรวจสอบสิทธิ์โทเค็น OAuth เท่านั้น)		 ทั้งหมด (สตริง) โทเค็น OAuth หรือ SAML ที่คุณสร้าง จากข้อมูลบัญชี Apigee ลบล้างข้อมูลเข้าสู่ระบบอื่นๆ ที่ระบุ
-u,
‑‑username 		จำเป็น
(การตรวจสอบสิทธิ์พื้นฐานเท่านั้น)		 Edge สาธารณะและ Private Cloud เท่านั้น (สตริง) ชื่อผู้ใช้ 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:

คำสั่งช่วยเหลือ

จะมีความช่วยเหลือออนไลน์สำหรับทุกคำสั่ง 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 โดยที่ บัญชีบริการมีบทบาท Apigee Analytics Agent มีการใช้ SA เพื่ออัปโหลดข้อมูลวิเคราะห์ไปยัง Apigee โดยตรง หากคุณใช้ Apigee แบบไฮบริด ตัวเลือกนี้ช่วยให้คุณติดตั้งรันไทม์แบบไฮบริดในคลัสเตอร์เดียวและอะแดปเตอร์ ในคลัสเตอร์อื่น
-c,
‑‑config 		ต้องระบุ ทั้งหมด (สตริง) เส้นทางไปยังไฟล์การกำหนดค่า Apigee Remote Service
เคล็ดลับ: แฟล็กนี้ทำให้คุณสามารถข้ามพารามิเตอร์คำสั่งอื่นๆ ส่วนใหญ่ได้ เนื่องจาก CLI จะดึง URL จากไฟล์การกำหนดค่าได้โดยตรง โปรดดู กำลังใช้ตัวเลือก ‑‑config
-e,
‑‑environment 		ต้องระบุ ทั้งหมด (สตริง) สภาพแวดล้อมในองค์กร
-f, ‑‑force-proxy-install ไม่บังคับ ทั้งหมด (ไม่บังคับ) บังคับให้ติดตั้งพร็อกซี remote-service อีกครั้งหากใช่ ติดตั้งในองค์กรแล้ว
-h,
‑‑help 		ไม่บังคับ ทั้งหมด แสดงความช่วยเหลือสำหรับพารามิเตอร์คำสั่ง
‑‑insecure ไม่บังคับ ทั้งหมด อนุญาตการเชื่อมต่อเซิร์ฟเวอร์ที่ไม่ปลอดภัยเมื่อใช้ SSL
‑‑legacy ต้องระบุ Edge ระบบคลาวด์สาธารณะเท่านั้น คุณต้องตั้งค่าสถานะนี้หากใช้ Apigee Edge สำหรับ Public Cloud อยู่ ตั้งค่า URL การจัดการและรันไทม์ สำหรับ Apigee Edge สำหรับ Public Cloud
-m,
‑‑management 		ต้องระบุ Edge Private Cloud เท่านั้น (สตริง) URL ฐานการจัดการสำหรับการติดตั้ง Apigee Edge สำหรับ Private Cloud ค่าเริ่มต้น: https://api.enterprise.apigee.com
‑‑mfa ต้องระบุ Edge ระบบคลาวด์สาธารณะเท่านั้น โทเค็นการให้สิทธิ์แบบหลายปัจจัยสำหรับ Apigee Edge สำหรับระบบคลาวด์สาธารณะ จำเป็นต่อเมื่อ MFA เท่านั้น ได้รับการตั้งค่าในบัญชี Apigee Edge ของคุณ
-n, ‑‑namespace ไม่บังคับ ทั้งหมด (สตริง) ส่งการกําหนดค่าเป็น Envoy ConfigMap ในเนมสเปซที่ระบุ ค่าเริ่มต้น: apigee
‑‑opdk ต้องระบุ Edge Private Cloud เท่านั้น โดยคุณต้องตั้งค่าสถานะนี้หากใช้ Apigee Edge สำหรับ Private Cloud อยู่
-o,
‑‑organization 		ต้องระบุ ทั้งหมด (สตริง) องค์กร Apigee คุณต้องเป็นผู้ดูแลระบบขององค์กรจึงจะจัดสรรได้
-p,
‑‑password 		จำเป็น
(การตรวจสอบสิทธิ์พื้นฐานเท่านั้น)		 Edge สาธารณะและ Private Cloud เท่านั้น (สตริง) รหัสผ่าน Apigee ของคุณ คุณสามารถเลือกระบุ รหัสผ่านในไฟล์
.netrc หากดำเนินการดังกล่าว คุณไม่จำเป็นต้อง ระบุรหัสผ่านของคุณในบรรทัดคำสั่ง ดูเพิ่มเติม ใช้ .netrc สำหรับข้อมูลเข้าสู่ระบบ
‑‑rotate-int ไม่บังคับ Apigee แบบไฮบริดเท่านั้น (จำนวนเต็ม) หากเป็น n > 0 สร้างคีย์ส่วนตัวใหม่และเก็บคีย์สาธารณะ n ไว้ (แบบผสมเท่านั้น)
-r,
‑‑runtime 		ต้องระบุ Edge Private Cloud และ Apigee แบบผสมเท่านั้น (สตริง) ระบุ URL รันไทม์สำหรับอินสแตนซ์แบบผสมของ Private Cloud หรือ Apigee URL ต้องขึ้นต้นด้วย https:// เช่น https://apitest.apigee-hybrid-docs.net
‑‑tls‑cert
‑‑tls‑key
‑‑tls‑ca 		ไม่บังคับ Edge Private Cloud เท่านั้น (สตริง) ระบุใบรับรอง TLS ฝั่งไคลเอ็นต์ คีย์ส่วนตัว และ CA รูทสำหรับการเชื่อมต่อ mTLS
-t,
‑‑token 		ต้องระบุ
(การตรวจสอบสิทธิ์โทเค็น OAuth เท่านั้น)		 ทั้งหมด (สตริง) โทเค็น OAuth หรือ SAML ที่คุณสร้าง จากข้อมูลบัญชี Apigee ลบล้างข้อมูลเข้าสู่ระบบอื่นๆ ที่ระบุ
-u,
‑‑username 		จำเป็น
(การตรวจสอบสิทธิ์พื้นฐานเท่านั้น)		 Edge สาธารณะและ Private Cloud เท่านั้น (สตริง) ชื่อผู้ใช้ Apigee ของคุณ (โดยปกติแล้วจะเป็นอีเมล) หรือจะเลือกระบุชื่อผู้ใช้ในไฟล์ .netrc ก็ได้ โปรดดู การใช้ .netrc สำหรับข้อมูลรับรอง
-v,
‑‑verbose 		ไม่บังคับ ทั้งหมด (ไม่บังคับ) สร้างเอาต์พุตแบบละเอียด
‑‑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 Remote Service
เคล็ดลับ: แฟล็กนี้ทำให้คุณสามารถข้ามพารามิเตอร์คำสั่งอื่นๆ ส่วนใหญ่ได้ เนื่องจาก CLI จะดึง URL จากไฟล์การกำหนดค่าได้โดยตรง โปรดดู กำลังใช้ตัวเลือก ‑‑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,
‑‑config 		ต้องระบุ ทั้งหมด (สตริง) เส้นทางไปยังไฟล์การกำหนดค่า Apigee Remote Service
เคล็ดลับ: แฟล็กนี้ทำให้คุณสามารถข้ามพารามิเตอร์คำสั่งอื่นๆ ส่วนใหญ่ได้ เนื่องจาก CLI จะดึง URL จากไฟล์การกำหนดค่าได้โดยตรง โปรดดู กำลังใช้ตัวเลือก ‑‑config
-e,
‑‑environment 		ต้องระบุ ทั้งหมด (สตริง) สภาพแวดล้อมในองค์กร
-h,
‑‑help 		ไม่บังคับ ทั้งหมด แสดงความช่วยเหลือสำหรับพารามิเตอร์คำสั่ง
--i, --id ต้องระบุ ทั้งหมด (สตริง) ข้อมูลเข้าสู่ระบบคีย์ที่พบในแอปนักพัฒนาซอฟต์แวร์ Apigee ตามที่อธิบายไว้ใน วิธีรับคีย์ API
‑‑insecure ไม่บังคับ ทั้งหมด อนุญาตการเชื่อมต่อเซิร์ฟเวอร์ที่ไม่ปลอดภัยเมื่อใช้ SSL
‑‑legacy ต้องระบุ Edge ระบบคลาวด์สาธารณะเท่านั้น คุณต้องตั้งค่าสถานะนี้หากใช้ Apigee Edge สำหรับ Public Cloud อยู่ ตั้งค่า URL การจัดการและรันไทม์ สำหรับ Apigee Edge สำหรับ Public Cloud
‑‑opdk ต้องระบุ Edge Private Cloud เท่านั้น โดยคุณต้องตั้งค่าสถานะนี้หากใช้ Apigee Edge สำหรับ Private Cloud อยู่
-o,
‑‑organization 		ต้องระบุ ทั้งหมด (สตริง) องค์กร Apigee คุณต้องเป็นผู้ดูแลระบบขององค์กร
-r,
‑‑runtime 		ต้องระบุ Edge Private Cloud และ Apigee แบบผสมเท่านั้น (สตริง) ระบุ URL รันไทม์สำหรับอินสแตนซ์แบบผสมของ Private Cloud หรือ Apigee URL ต้องขึ้นต้นด้วย https:// เช่น https://apitest.apigee-hybrid-docs.net
--s, ‑‑secret ต้องระบุ ทั้งหมด (สตริง) ข้อมูลเข้าสู่ระบบ Secret ที่พบในแอปของนักพัฒนาซอฟต์แวร์ Apigee ตามที่อธิบายไว้ใน วิธีรับคีย์ API
‑‑tls‑cert
‑‑tls‑key
‑‑tls‑ca 		ไม่บังคับ Edge Private Cloud เท่านั้น (สตริง) ระบุใบรับรอง TLS ฝั่งไคลเอ็นต์ คีย์ส่วนตัว และ CA รูทสำหรับการเชื่อมต่อ mTLS
-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 ได้ด้วยคำสั่งนี้ โปรดดูเพิ่มเติมที่ตรวจสอบโทเค็น

การใช้งาน

apigee-remote-service-cli token inspect [flags]

พารามิเตอร์

พารามิเตอร์

พารามิเตอร์ การมีบุคคลอยู่ ใช้กับผลิตภัณฑ์ คำอธิบาย
-c,
‑‑config 		ต้องระบุ ทั้งหมด (สตริง) เส้นทางไปยังไฟล์การกำหนดค่า Apigee Remote Service
เคล็ดลับ: แฟล็กนี้ทำให้คุณสามารถข้ามพารามิเตอร์คำสั่งอื่นๆ ส่วนใหญ่ได้ เนื่องจาก CLI จะดึง URL จากไฟล์การกำหนดค่าได้โดยตรง โปรดดู กำลังใช้ตัวเลือก ‑‑config
-e,
‑‑environment 		ต้องระบุ ทั้งหมด (สตริง) สภาพแวดล้อมในองค์กร
-f,
‑‑file 		ต้องระบุ ทั้งหมด (สตริง) ไฟล์โทเค็น (ค่าเริ่มต้น: ใช้ stdin)
-h,
‑‑help 		ไม่บังคับ ทั้งหมด แสดงความช่วยเหลือสำหรับพารามิเตอร์คำสั่ง
‑‑insecure ไม่บังคับ ทั้งหมด อนุญาตการเชื่อมต่อเซิร์ฟเวอร์ที่ไม่ปลอดภัยเมื่อใช้ SSL
‑‑legacy ต้องระบุ Edge ระบบคลาวด์สาธารณะเท่านั้น คุณต้องตั้งค่าสถานะนี้หากใช้ Apigee Edge สำหรับ Public Cloud อยู่ ตั้งค่า URL การจัดการและรันไทม์ สำหรับ Apigee Edge สำหรับ Public Cloud
‑‑opdk ต้องระบุ Edge Private Cloud เท่านั้น โดยคุณต้องตั้งค่าสถานะนี้หากใช้ Apigee Edge สำหรับ Private Cloud อยู่
-o,
‑‑organization 		ต้องระบุ ทั้งหมด (สตริง) องค์กร Apigee คุณต้องเป็นผู้ดูแลระบบขององค์กร
-r,
‑‑runtime 		ต้องระบุ Edge Private Cloud และ Apigee แบบผสมเท่านั้น (สตริง) ระบุ URL รันไทม์สำหรับอินสแตนซ์แบบผสมของ Private Cloud หรือ Apigee URL ต้องขึ้นต้นด้วย https:// เช่น https://apitest.apigee-hybrid-docs.net
‑‑tls‑cert
‑‑tls‑key
‑‑tls‑ca 		ไม่บังคับ Edge Private Cloud เท่านั้น (สตริง) ระบุใบรับรอง TLS ฝั่งไคลเอ็นต์ คีย์ส่วนตัว และ CA รูทสำหรับการเชื่อมต่อ mTLS
-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 ในแมปคีย์-ค่าที่เข้ารหัส (KVM) ขั้นตอนในการสร้าง คู่คีย์ใหม่เรียกว่าการหมุนเวียนคีย์ เมื่อคุณหมุนเวียนคีย์ คู่คีย์ส่วนตัว/สาธารณะชุดใหม่ สร้างและจัดเก็บไว้ใน "istio" KVM ในองค์กร/สภาพแวดล้อม Apigee ของคุณ นอกจากนี้ คีย์สาธารณะเดิมจะยังคงอยู่พร้อมกับค่ารหัสคีย์เดิม

การใช้งาน

apigee-remote-service-cli token rotate-cert [flags]

พารามิเตอร์

พารามิเตอร์ การมีบุคคลอยู่ ใช้กับผลิตภัณฑ์ คำอธิบาย
-c,
‑‑config 		ต้องระบุ ทั้งหมด (สตริง) เส้นทางไปยังไฟล์การกำหนดค่า Apigee Remote Service
เคล็ดลับ: แฟล็กนี้ทำให้คุณสามารถข้ามพารามิเตอร์คำสั่งอื่นๆ ส่วนใหญ่ได้ เนื่องจาก CLI จะดึง URL จากไฟล์การกำหนดค่าได้โดยตรง โปรดดู กำลังใช้ตัวเลือก ‑‑config
-e,
‑‑environment 		ต้องระบุ ทั้งหมด (สตริง) สภาพแวดล้อมในองค์กร
-h,
‑‑help 		ไม่บังคับ Edge สาธารณะและ Private Cloud เท่านั้น แสดงความช่วยเหลือสำหรับพารามิเตอร์คำสั่ง
--k, --key ต้องระบุ Edge สาธารณะและ Private Cloud เท่านั้น (สตริง) คีย์การจัดสรร
‑‑insecure ไม่บังคับ Edge สาธารณะและ Private Cloud เท่านั้น อนุญาตการเชื่อมต่อเซิร์ฟเวอร์ที่ไม่ปลอดภัยเมื่อใช้ SSL
‑‑legacy ต้องระบุ Edge ระบบคลาวด์สาธารณะเท่านั้น คุณต้องตั้งค่าสถานะนี้หากใช้ Apigee Edge สำหรับ Public Cloud อยู่ ตั้งค่า URL การจัดการและรันไทม์ สำหรับ Apigee Edge สำหรับ Public Cloud
‑‑opdk ต้องระบุ Edge Private Cloud เท่านั้น โดยคุณต้องตั้งค่าสถานะนี้หากใช้ Apigee Edge สำหรับ Private Cloud อยู่
-o,
‑‑organization 		ต้องระบุ Edge สาธารณะและ Private Cloud เท่านั้น (สตริง) องค์กร Apigee คุณต้องเป็นผู้ดูแลระบบขององค์กร
-r,
‑‑runtime 		ต้องระบุ Edge Private Cloud เท่านั้น (สตริง) ระบุ URL รันไทม์สำหรับอินสแตนซ์แบบผสมของ Private Cloud หรือ Apigee URL ต้องขึ้นต้นด้วย https:// เช่น https://apitest.apigee-hybrid-docs.net
--s, ‑‑secret ต้องระบุ ทั้งหมด (สตริง) ความลับของการจัดสรร
‑‑tls‑cert
‑‑tls‑key
‑‑tls‑ca 		ไม่บังคับ Edge Private Cloud เท่านั้น (สตริง) ระบุใบรับรอง TLS ฝั่งไคลเอ็นต์ คีย์ส่วนตัว และ CA รูทสำหรับการเชื่อมต่อ mTLS
--t, ‑‑truncate ต้องระบุ ทั้งหมด (จำนวนเต็ม) จำนวนใบรับรองที่จะเก็บไว้ใน JWKS (ค่าเริ่มต้น 2)
-v,
‑‑verbose 		ไม่บังคับ ทั้งหมด (ไม่บังคับ) สร้างเอาต์พุตแบบละเอียด

ตัวอย่าง

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,
‑‑config 		ต้องระบุ Apigee แบบไฮบริดเท่านั้น (สตริง) เส้นทางไปยังไฟล์การกำหนดค่า Apigee Remote Service
เคล็ดลับ: แฟล็กนี้ทำให้คุณสามารถข้ามพารามิเตอร์คำสั่งอื่นๆ ส่วนใหญ่ได้ เนื่องจาก CLI จะดึง URL จากไฟล์การกำหนดค่าได้โดยตรง โปรดดู กำลังใช้ตัวเลือก ‑‑config
-d,
‑‑duration 		ต้องระบุ Apigee แบบไฮบริดเท่านั้น (สตริง) เวลาที่ถูกต้องสำหรับ JWT ภายในจากการสร้าง (ค่าเริ่มต้น: 10m0s (10 นาที))
-e,
‑‑environment 		ต้องระบุ Apigee แบบไฮบริดเท่านั้น (สตริง) สภาพแวดล้อมในองค์กร
-h,
‑‑help 		ไม่บังคับ Apigee แบบไฮบริดเท่านั้น แสดงความช่วยเหลือสำหรับพารามิเตอร์คำสั่ง
‑‑insecure ไม่บังคับ Apigee แบบไฮบริดเท่านั้น อนุญาตการเชื่อมต่อเซิร์ฟเวอร์ที่ไม่ปลอดภัยเมื่อใช้ SSL
-o,
‑‑organization 		ต้องระบุ Apigee แบบไฮบริดเท่านั้น (สตริง) องค์กร Apigee คุณต้องเป็นผู้ดูแลระบบขององค์กร
-r,
‑‑runtime 		ต้องระบุ Apigee แบบไฮบริดเท่านั้น (สตริง) ระบุ URL รันไทม์สำหรับอินสแตนซ์แบบผสมของ Apigee URL ต้องขึ้นต้นด้วย https:// เช่น https://apitest.apigee-hybrid-docs.net
-v,
‑‑verbose 		ไม่บังคับ 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