หน้านี้ได้รับการแปลโดย Cloud Translation API

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

คุณกําลังดูเอกสารประกอบของ Apigee Edge
ไปที่เอกสารประกอบของ Apigee X info

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

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

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

การใช้งาน

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

พารามิเตอร์

พารามิเตอร์	การมีบุคคลอยู่	ใช้กับผลิตภัณฑ์	คำอธิบาย
`-c, ‑‑config`	ต้องระบุ	ทั้งหมด	(สตริง) เส้นทางไปยังไฟล์การกําหนดค่าบริการระยะไกลของ Apigee เคล็ดลับ: แฟล็กนี้ช่วยให้คุณข้ามพารามิเตอร์คำสั่งอื่นๆ ส่วนใหญ่ได้ เนื่องจาก CLI ดึงพารามิเตอร์เหล่านี้จากไฟล์การกำหนดค่าได้โดยตรง โปรดดู การใช้ตัวเลือก `‑‑config`
`-e, ‑‑environment`	ต้องระบุ	ทั้งหมด	(สตริง) สภาพแวดล้อมในองค์กร
`-h, ‑‑help`	ไม่บังคับ	ทั้งหมด	แสดงความช่วยเหลือเกี่ยวกับพารามิเตอร์คำสั่ง
`‑‑insecure`	ไม่บังคับ	ทั้งหมด	อนุญาตการเชื่อมต่อเซิร์ฟเวอร์ที่ไม่ปลอดภัยเมื่อใช้ SSL
`‑‑legacy`	ต้องระบุ	Edge Public Cloud เท่านั้น	คุณต้องตั้งค่าสถานะนี้หากใช้ Apigee Edge สำหรับ Public Cloud อยู่ ตั้งค่า URL การจัดการและรันไทม์สำหรับ Apigee Edge สำหรับระบบคลาวด์สาธารณะ
`-m, ‑‑management`	ต้องระบุ	Edge Private Cloud เท่านั้น	(สตริง) URL ฐานการจัดการสําหรับการติดตั้ง Apigee Edge สําหรับระบบคลาวด์ส่วนตัว ค่าเริ่มต้น: `https://api.enterprise.apigee.com`
`‑‑mfa`	ต้องระบุ	Edge Public Cloud เท่านั้น	(สตริง) โทเค็นการให้สิทธิ์แบบหลายปัจจัยสําหรับ Apigee Edge สําหรับระบบคลาวด์สาธารณะ ต้องระบุเฉพาะในกรณีที่มีการตั้งค่า MFA ในบัญชี Apigee Edge
`‑‑opdk`	ต้องระบุ	Edge Private Cloud เท่านั้น	คุณต้องตั้งค่า Flag นี้หากใช้ Apigee Edge สําหรับ Private Cloud
`-o, ‑‑organization`	ต้องระบุ	ทั้งหมด	(สตริง) องค์กร Apigee คุณต้องเป็นผู้ดูแลระบบองค์กร
`-p, ‑‑password`	ต้องระบุ (การตรวจสอบสิทธิ์พื้นฐานเท่านั้น)	Edge สาธารณะและ Private Cloud เท่านั้น	(สตริง) รหัสผ่าน Apigee คุณจะระบุรหัสผ่านในไฟล์ `.netrc` ก็ได้ โปรดดูหัวข้อการใช้ .netrc สำหรับข้อมูลเข้าสู่ระบบด้วย
`-r, ‑‑runtime`	ต้องระบุ	Edge Private Cloud และ Apigee แบบผสมเท่านั้น	(สตริง) ระบุ URL รันไทม์สําหรับอินสแตนซ์แบบผสมของ 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 Public และ 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 Hybrid และ Apigee X เท่านั้น	(สตริง) ใช้แฟล็กนี้เพื่อระบุเส้นทางไปยังไฟล์คีย์บัญชีบริการ Google Cloud โดยที่บัญชีบริการมีบทบาท `Apigee Analytics Agent` อะแดปเตอร์ใช้ SA เพื่ออัปโหลดข้อมูลวิเคราะห์ไปยัง Apigee โดยตรง หากคุณใช้ Apigee แบบไฮบริด ตัวเลือกนี้จะช่วยให้คุณติดตั้งรันไทม์แบบไฮบริดในคลัสเตอร์หนึ่งและแอตทริบิวเตอร์ในอีกคลัสเตอร์หนึ่งได้ หมายเหตุ: เราขอแนะนําให้คุณอัปเดตการติดตั้งเพื่อใช้การอัปโหลดข้อมูลวิเคราะห์โดยตรง เลิกใช้งานวิธีการที่ไม่ใช่โดยตรงสำหรับการอัปโหลด Analytics ที่ใช้ Fluentd แล้ว
`-c, ‑‑config`	ต้องระบุ	ทั้งหมด	(สตริง) เส้นทางไปยังไฟล์การกําหนดค่าบริการระยะไกลของ Apigee เคล็ดลับ: แฟล็กนี้ช่วยให้คุณละเว้นพารามิเตอร์คำสั่งอื่นๆ ส่วนใหญ่ได้ เนื่องจาก CLI สามารถดึงพารามิเตอร์เหล่านั้นจากไฟล์การกําหนดค่าได้โดยตรง โปรดดู การใช้ตัวเลือก `‑‑config`
`-e, ‑‑environment`	ต้องระบุ	ทั้งหมด	(สตริง) สภาพแวดล้อมในองค์กร
`-f, ‑‑force-proxy-install`	ไม่บังคับ	ทั้งหมด	(ไม่บังคับ) บังคับให้ติดตั้งพร็อกซี `remote-service` อีกครั้งหากติดตั้งไว้ในองค์กรแล้ว หมายเหตุการอัปเกรด: หากอัปเกรดเป็น v1.1.0 ขึ้นไป คุณต้องใส่ Flag `--force-proxy-install` เพื่อแทนที่พร็อกซีบริการระยะไกลที่มีอยู่ซึ่งติดตั้งใช้งานใน Apigee
`-h, ‑‑help`	ไม่บังคับ	ทั้งหมด	แสดงความช่วยเหลือเกี่ยวกับพารามิเตอร์คำสั่ง
`‑‑insecure`	ไม่บังคับ	ทั้งหมด	อนุญาตการเชื่อมต่อเซิร์ฟเวอร์ที่ไม่ปลอดภัยเมื่อใช้ SSL
`‑‑legacy`	ต้องระบุ	Edge Public Cloud เท่านั้น	คุณต้องตั้งค่าสถานะนี้หากใช้ Apigee Edge สำหรับ Public Cloud อยู่ ตั้งค่า URL การจัดการและรันไทม์สำหรับ Apigee Edge สำหรับระบบคลาวด์สาธารณะ
`-m, ‑‑management`	ต้องระบุ	Edge Private Cloud เท่านั้น	(สตริง) URL ฐานการจัดการสําหรับการติดตั้ง Apigee Edge สําหรับระบบคลาวด์ส่วนตัว ค่าเริ่มต้น: `https://api.enterprise.apigee.com`
`‑‑mfa`	ต้องระบุ	Edge ระบบคลาวด์สาธารณะเท่านั้น	โทเค็นการให้สิทธิ์แบบหลายปัจจัยสําหรับ Apigee Edge สําหรับระบบคลาวด์สาธารณะ ต้องระบุเฉพาะในกรณีที่มีการตั้งค่า MFA ในบัญชี Apigee Edge
`-n, ‑‑namespace`	ไม่บังคับ	ทั้งหมด	(สตริง) ส่งออกการกำหนดค่าเป็น ConfigMap ของ Envoy ในเนมสเปซที่ระบุ ค่าเริ่มต้น: `apigee`
`‑‑opdk`	ต้องระบุ	Edge Private Cloud เท่านั้น	คุณต้องตั้งค่า Flag นี้หากใช้ 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 รันไทม์สําหรับอินสแตนซ์แบบผสมของ 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 Public และ Private Cloud เท่านั้น	(สตริง) ชื่อผู้ใช้ Apigee (ปกติจะเป็นอีเมล) หรือคุณจะระบุชื่อผู้ใช้ในไฟล์ `.netrc` ก็ได้ โปรดดูหัวข้อการใช้ .netrc สำหรับข้อมูลเข้าสู่ระบบด้วย
`-v, ‑‑verbose`	ไม่บังคับ	ทั้งหมด	(ไม่บังคับ) แสดงผลลัพธ์แบบละเอียด
`‑‑virtual-hosts`	ไม่บังคับ	Edge Private Cloud เท่านั้น	(สตริง) ลบล้างโฮสต์เสมือนเริ่มต้น ซึ่งก็คือ `default,secure` ใช้ตัวเลือกนี้หากคุณระบุโฮสต์เสมือนสําหรับสภาพแวดล้อมองค์กร Edge นอกเหนือจากค่าเริ่มต้นเหล่านี้

ตัวอย่าง

ดังที่ตัวอย่างต่อไปนี้แสดง คุณต้องบันทึกเอาต์พุตของคำสั่ง provision ในไฟล์ ซึ่งจะใช้เป็นอินพุตสำหรับการดำเนินการอื่นๆ ของ Apigee Adapter สำหรับ 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, ‑‑config`	ต้องระบุ	ทั้งหมด	(สตริง) เส้นทางไปยังไฟล์การกําหนดค่าบริการระยะไกลของ Apigee เคล็ดลับ: แฟล็กนี้ช่วยให้คุณละเว้นพารามิเตอร์คำสั่งอื่นๆ ส่วนใหญ่ได้ เนื่องจาก CLI สามารถดึงพารามิเตอร์เหล่านั้นจากไฟล์การกําหนดค่าได้โดยตรง โปรดดู การใช้ตัวเลือก `‑‑config`
`-e, ‑‑environment`	ต้องระบุ	ทั้งหมด	(สตริง) สภาพแวดล้อมในองค์กร
`-h, ‑‑help`	ไม่บังคับ	ทั้งหมด	แสดงความช่วยเหลือเกี่ยวกับพารามิเตอร์คำสั่ง
`--i, --id`	ต้องระบุ	ทั้งหมด	(สตริง) ข้อมูลเข้าสู่ระบบคีย์ที่พบในแอปนักพัฒนาแอป Apigee ตามที่อธิบายไว้ในวิธีขอรับคีย์ API
`‑‑insecure`	ไม่บังคับ	ทั้งหมด	อนุญาตการเชื่อมต่อเซิร์ฟเวอร์ที่ไม่ปลอดภัยเมื่อใช้ SSL
`‑‑legacy`	ต้องระบุ	Edge Public Cloud เท่านั้น	คุณต้องตั้งค่าสถานะนี้หากใช้ Apigee Edge สำหรับ Public Cloud อยู่ ตั้งค่า URL การจัดการและรันไทม์สำหรับ Apigee Edge สำหรับระบบคลาวด์สาธารณะ
`‑‑opdk`	ต้องระบุ	Edge Private Cloud เท่านั้น	คุณต้องตั้งค่า Flag นี้หากใช้ 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`	ต้องระบุ	ทั้งหมด	(สตริง) ข้อมูลเข้าสู่ระบบลับที่พบในแอปนักพัฒนาแอป 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 เคล็ดลับ: แฟล็กนี้ช่วยให้คุณละเว้นพารามิเตอร์คำสั่งอื่นๆ ส่วนใหญ่ได้ เนื่องจาก CLI สามารถดึงพารามิเตอร์เหล่านั้นจากไฟล์การกําหนดค่าได้โดยตรง โปรดดู การใช้ตัวเลือก `‑‑config`
`-e, ‑‑environment`	ต้องระบุ	ทั้งหมด	(สตริง) สภาพแวดล้อมในองค์กร
`-f, ‑‑file`	ต้องระบุ	ทั้งหมด	(สตริง) ไฟล์โทเค็น (ค่าเริ่มต้น: ใช้ `stdin`)
`-h, ‑‑help`	ไม่บังคับ	ทั้งหมด	แสดงความช่วยเหลือเกี่ยวกับพารามิเตอร์คำสั่ง
`‑‑insecure`	ไม่บังคับ	ทั้งหมด	อนุญาตการเชื่อมต่อเซิร์ฟเวอร์ที่ไม่ปลอดภัยเมื่อใช้ SSL
`‑‑legacy`	ต้องระบุ	Edge Public Cloud เท่านั้น	คุณต้องตั้งค่าสถานะนี้หากใช้ Apigee Edge สำหรับ Public Cloud อยู่ ตั้งค่า URL การจัดการและรันไทม์สำหรับ Apigee Edge สำหรับระบบคลาวด์สาธารณะ
`‑‑opdk`	ต้องระบุ	Edge Private Cloud เท่านั้น	คุณต้องตั้งค่า Flag นี้หากใช้ Apigee Edge สําหรับ Private Cloud
`-o, ‑‑organization`	ต้องระบุ	ทั้งหมด	(สตริง) องค์กร Apigee คุณต้องเป็นผู้ดูแลระบบองค์กร
`-r, ‑‑runtime`	ต้องระบุ	Edge Private Cloud และ Apigee แบบผสมเท่านั้น	(สตริง) ระบุ URL รันไทม์สําหรับอินสแตนซ์แบบผสมของ 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) กระบวนการสร้างคู่คีย์ใหม่นี้เรียกว่าการเปลี่ยนคีย์ เมื่อหมุนเวียนคีย์ ระบบจะสร้างคู่คีย์ส่วนตัว/สาธารณะใหม่และเก็บไว้ใน KVM "istio" ในองค์กร/สภาพแวดล้อม Apigee ของคุณ นอกจากนี้ ระบบจะเก็บคีย์สาธารณะเดิมไว้พร้อมกับค่ารหัสคีย์เดิม

การใช้งาน

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

พารามิเตอร์

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

คำสั่งเวอร์ชัน

พิมพ์เวอร์ชัน 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

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

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

การใช้งาน

พารามิเตอร์

ตัวอย่าง

ตัวอย่างเอาต์พุต

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

คำสั่งการจัดสรร

การใช้งาน

พารามิเตอร์

ตัวอย่าง

คำสั่งลองฟัง

สร้างไฟล์การกำหนดค่าตัวอย่าง

การใช้งาน

คำอธิบาย

พารามิเตอร์

ตัวอย่าง

แสดงรายการตัวเลือกเทมเพลตที่ใช้ได้

การใช้งาน

พารามิเตอร์

ตัวอย่าง

คำสั่งโทเค็น

สร้างโทเค็น JWT

การใช้งาน

พารามิเตอร์

ตัวอย่าง

เอาต์พุต

ตรวจสอบโทเค็น JWT

การใช้งาน

พารามิเตอร์

พารามิเตอร์

ตัวอย่าง

เอาต์พุต

หมุนโทเค็น JWT

การใช้งาน

พารามิเตอร์

ตัวอย่าง

เอาต์พุต

สร้างโทเค็นภายใน

การใช้งาน

พารามิเตอร์

พารามิเตอร์

คำสั่งเวอร์ชัน

การใช้ .netrc สำหรับข้อมูลเข้าสู่ระบบ

การใช้ตัวเลือกคำสั่ง ‑‑config

ไฟล์การกำหนดค่า

การใช้ตัวเลือกคำสั่ง `‑‑config`