ดัชนี
Customers
(อินเทอร์เฟซ)DeviceManager
(อินเทอร์เฟซ)PolicyService
(อินเทอร์เฟซ)Assignment
(ข้อความ)BillingMode
(enum)ChannelType
(enum)CreateDeploymentRequest
(ข้อความ)CreateDeviceRequest
(ข้อความ)CreateNodeRequest
(ข้อความ)CreateSignedDeviceRequest
(ข้อความ)Customer
(ข้อความ)DeleteDeploymentRequest
(ข้อความ)DeleteDeviceRequest
(ข้อความ)DeleteNodeRequest
(ข้อความ)Deployment
(ข้อความ)Device
(ข้อความ)Device.State
(enum)DeviceAirInterface
(ข้อความ)DeviceAirInterface.RadioTechnology
(enum)DeviceCategory
(enum)DeviceConfig
(ข้อความ)DeviceConfig.State
(enum)DeviceGrant
(ข้อความ)DeviceMetadata
(ข้อความ)DeviceModel
(ข้อความ)DpaMoveList
(ข้อความ)FrequencyRange
(ข้อความ)GenerateSecretRequest
(ข้อความ)GenerateSecretResponse
(ข้อความ)GetCustomerRequest
(ข้อความ)GetDeploymentRequest
(ข้อความ)GetDeviceRequest
(ข้อความ)GetNodeRequest
(ข้อความ)GetPolicyRequest
(ข้อความ)GrantState
(enum)HeightType
(enum)InstallationParams
(ข้อความ)ListCustomersRequest
(ข้อความ)ListCustomersResponse
(ข้อความ)ListDeploymentsRequest
(ข้อความ)ListDeploymentsResponse
(ข้อความ)ListDevicesRequest
(ข้อความ)ListDevicesResponse
(ข้อความ)ListNodesRequest
(ข้อความ)ListNodesResponse
(ข้อความ)MeasurementCapability
(enum)MoveDeploymentRequest
(ข้อความ)MoveDeviceRequest
(ข้อความ)MoveNodeRequest
(ข้อความ)Node
(ข้อความ)Policy
(ข้อความ)SetPolicyRequest
(ข้อความ)SignDeviceRequest
(ข้อความ)TestPermissionsRequest
(ข้อความ)TestPermissionsResponse
(ข้อความ)UpdateCustomerRequest
(ข้อความ)UpdateDeploymentRequest
(ข้อความ)UpdateDeviceRequest
(ข้อความ)UpdateNodeRequest
(ข้อความ)UpdateSignedDeviceRequest
(ข้อความ)ValidateInstallerRequest
(ข้อความ)ValidateInstallerResponse
(ข้อความ)
ลูกค้า
บริการที่จัดการลูกค้า SAS
หาลูกค้า | |
---|---|
แสดงผล
|
รายชื่อลูกค้า | |
---|---|
แสดงผลรายการ
|
อัปเดตลูกค้า | |
---|---|
อัปเดต
|
โปรแกรมจัดการอุปกรณ์
บริการจัดการอุปกรณ์วิทยุกระจายเสียงของพลเมือง
สร้างการทําให้ใช้งานได้ | |
---|---|
สร้าง
|
สร้างอุปกรณ์ | |
---|---|
สร้าง
|
สร้างโหนด | |
---|---|
สร้าง
|
สร้างลายเซ็นในอุปกรณ์ | |
---|---|
สร้าง
|
ลบการทําให้ใช้งานได้ | |
---|---|
ลบ
|
ลบอุปกรณ์ | |
---|---|
ลบ
|
ลบโหนด | |
---|---|
ลบ
|
สร้างข้อมูลลับ | |
---|---|
สร้างข้อมูลลับเพื่อใช้กับ
|
รับการทําให้ใช้งานได้ | |
---|---|
แสดงผล
|
รับอุปกรณ์ | |
---|---|
ดูรายละเอียดเกี่ยวกับ
|
ดาวน์โหลดโหนด | |
---|---|
แสดงผล
|
แสดงรายการการทําให้ใช้งานได้ | |
---|---|
รายการ
|
รายการอุปกรณ์ | |
---|---|
แสดงรายการ
|
รายการโหนด | |
---|---|
รายการ
|
ย้ายการทําให้ใช้งานได้ | |
---|---|
ย้าย
|
ย้ายอุปกรณ์ | |
---|---|
ย้าย
|
ย้ายโหนด | |
---|---|
ย้าย
|
อุปกรณ์ลงนาม | |
---|---|
ลงนาม
|
อัปเดตการทําให้ใช้งานได้ | |
---|---|
อัปเดต
|
อัปเดตอุปกรณ์ | |
---|---|
อัปเดต
|
อัปเดตโหนด | |
---|---|
อัปเดต
|
อัปเดต SignedDevice | |
---|---|
อัปเดต
|
ผู้ตรวจสอบการติดตั้ง | |
---|---|
ตรวจสอบข้อมูลระบุตัวตนของผู้ติดตั้งมืออาชีพที่ผ่านการรับรอง (CPI)
|
บริการนโยบาย
เข้าถึงบริการควบคุมการเข้าถึง Spectrum Resource Manager
รับนโยบาย | |
---|---|
รับนโยบายควบคุมการเข้าถึงสําหรับทรัพยากร แสดงนโยบายที่ว่างเปล่าหากมีทรัพยากรอยู่และไม่ได้ตั้งค่านโยบายไว้
|
กําหนดนโยบาย | |
---|---|
ตั้งค่านโยบายการควบคุมการเข้าถึงสําหรับทรัพยากรที่ระบุ แทนที่นโยบายที่มีอยู่
|
สิทธิ์ทดสอบ | |
---|---|
แสดงผลสิทธิ์ที่ผู้โทรมีในทรัพยากรที่ระบุ
|
งาน
เชื่อมโยง members
กับ role
ช่อง | |
---|---|
role |
ต้องระบุ บทบาทที่กําหนดให้กับ |
members[] |
ข้อมูลประจําตัวที่มีการมอบหมายบทบาท ซึ่งมีค่าต่อไปนี้
|
โหมดการเรียกเก็บเงิน
โหมดการเรียกเก็บเงินของ CBSD
Enum | |
---|---|
BILLING_MODE_UNSPECIFIED |
ไม่ได้ระบุโหมดการเรียกเก็บเงิน |
MOBILE |
ราคาอิงตามหมวดหมู่ CBSD: หมวดหมู่ A หมวดหมู่ B ที่ลงทะเบียนกับ SAS |
FIXED_WIRELESS |
ราคาอิงตามประเภทของ CBSD: สถานีฐานหรือ CPE |
ประเภทช่อง
Enum | |
---|---|
CHANNEL_TYPE_UNSPECIFIED |
|
CHANNEL_TYPE_GAA |
|
CHANNEL_TYPE_PAL |
สร้างคําขอทําให้ใช้งานได้
คําขอสําหรับ CreateDeployment
ช่อง | |
---|---|
parent |
ต้องระบุ ชื่อทรัพยากรระดับบนสุดที่จะสร้างการทําให้ใช้งานได้ |
deployment |
ต้องระบุ รายละเอียดการทําให้ใช้งานได้ |
สร้างคําขออุปกรณ์
คําขอสําหรับ CreateDevice
ช่อง | |
---|---|
parent |
ต้องระบุ ชื่อของทรัพยากรระดับบนสุด |
device |
รายละเอียดการจดทะเบียน |
สร้าง NodeRequest
คําขอสําหรับ CreateNode
ช่อง | |
---|---|
parent |
ต้องระบุ ชื่อทรัพยากรระดับบนสุดที่จะสร้างโหนด |
node |
รายละเอียดโหนด |
สร้าง SignedDeviceRequest
คําขอสําหรับ CreateSignedDevice
ช่อง | |
---|---|
parent |
ต้องระบุ ชื่อของทรัพยากรระดับบนสุด |
encoded_device |
ต้องระบุ โทเค็นเว็บ JSON ที่รับรองโดยใช้คีย์ส่วนตัว CPI เพย์โหลดต้องเป็นการเข้ารหัส JSON ของ |
installer_id |
ต้องระบุ รหัสโปรแกรมติดตั้งที่ไม่ซ้ํา (รหัส CPI) จากฐานข้อมูลโปรแกรมติดตั้งที่ได้รับการรับรอง |
ลูกค้า
เอนทิตีที่แสดงลูกค้า SAS
ช่อง | |
---|---|
name |
เอาต์พุตเท่านั้น ชื่อทรัพยากรของลูกค้า |
display_name |
ต้องระบุ ชื่อขององค์กรที่ลูกค้าเป็นตัวแทน |
sas_user_ids[] |
รหัสผู้ใช้ที่ใช้โดยอุปกรณ์ของลูกค้ารายนี้ |
ลบคําขอทําให้ใช้งานได้
คําขอสําหรับ DeleteDeployment
ช่อง | |
---|---|
name |
ต้องระบุ ชื่อ |
ลบคําขออุปกรณ์
คําขอสําหรับ DeleteDevice
ช่อง | |
---|---|
name |
ต้องระบุ ชื่ออุปกรณ์ |
ลบคําขอโหนด
คําขอสําหรับ DeleteNode
ช่อง | |
---|---|
name |
ต้องระบุ ชื่อ |
การทำให้ใช้งานได้
การทําให้ใช้งานได้
ช่อง | |
---|---|
name |
เอาต์พุตเท่านั้น ชื่อทรัพยากร |
display_name |
ชื่อที่แสดงของการทําให้ใช้งานได้ |
sas_user_ids[] |
รหัสผู้ใช้ที่ใช้โดยอุปกรณ์ของการทําให้ใช้งานได้นี้ การทําให้ใช้งานได้แต่ละรายการควรเชื่อมโยงกับ User-ID ที่ไม่ซ้ํากัน 1 รายการ |
default_billing_mode |
โหมดการเรียกเก็บเงินเริ่มต้นสําหรับการทําให้ใช้งานได้และอุปกรณ์ที่อยู่ภายใต้การตั้งค่า |
allowed_billing_modes[] |
โหมดการเรียกเก็บเงินที่อนุญาตภายใต้การทําให้ใช้งานได้นี้ |
อุปกรณ์
ช่อง | |
---|---|
name |
เอาต์พุตเท่านั้น ชื่อเส้นทางทรัพยากร |
fcc_id |
ตัวระบุ FCC ของอุปกรณ์ |
serial_number |
หมายเลขซีเรียลที่ผู้ผลิตอุปกรณ์กําหนดให้ |
preloaded_config |
การกําหนดค่าอุปกรณ์ตามที่ระบุไว้ใน SAS Portal API |
active_config |
เอาต์พุตเท่านั้น การกําหนดค่าปัจจุบันของอุปกรณ์ตามที่ลงทะเบียนกับ SAS |
state |
เอาต์พุตเท่านั้น สถานะอุปกรณ์ |
grants[] |
เอาต์พุตเท่านั้น เงินสนับสนุนที่อุปกรณ์ครอบครอง |
display_name |
ชื่อที่แสดงของอุปกรณ์ |
device_metadata |
พารามิเตอร์อุปกรณ์ที่ลบล้างได้โดยทั้งพอร์ทัล SAS และคําขอลงทะเบียน SAS |
รัฐ
สถานะของอุปกรณ์
Enum | |
---|---|
DEVICE_STATE_UNSPECIFIED |
สถานะที่ไม่ระบุ |
RESERVED |
อย่างไรก็ตาม อุปกรณ์ที่สร้างในพอร์ทัล SAS ยังไม่ได้ลงทะเบียนกับ SAS |
REGISTERED |
อุปกรณ์ลงทะเบียนกับ SAS แล้ว |
DEREGISTERED |
ยกเลิกการลงทะเบียนอุปกรณ์กับ SAS แล้ว |
อินเทอร์เฟซ AirAir
ข้อมูลเกี่ยวกับอินเทอร์เฟซทางอากาศของอุปกรณ์
ช่อง | |
---|---|
radio_technology |
มีเงื่อนไข ช่องนี้ระบุเทคโนโลยีการเข้าถึงวิทยุที่ใช้สําหรับ CBSD |
supported_spec |
ไม่บังคับ ช่องนี้เกี่ยวข้องกับ |
เทคโนโลยีวิทยุ
ประเภทเทคโนโลยีการเข้าถึงวิทยุที่ได้รับอนุมัติ
Enum | |
---|---|
RADIO_TECHNOLOGY_UNSPECIFIED |
|
E_UTRA |
|
CAMBIUM_NETWORKS |
|
FOUR_G_BBW_SAA_1 |
|
NR |
|
DOODLE_CBRS |
|
CW |
|
REDLINE |
|
TARANA_WIRELESS |
หมวดหมู่อุปกรณ์
หมวดหมู่ FCC ของอุปกรณ์ ตามที่กําหนดไว้ในส่วนที่ 96
Enum | |
---|---|
DEVICE_CATEGORY_UNSPECIFIED |
หมวดหมู่อุปกรณ์ที่ไม่ระบุ |
DEVICE_CATEGORY_A |
หมวดหมู่ A |
DEVICE_CATEGORY_B |
หมวดหมู่ B |
การกําหนดค่าอุปกรณ์
ข้อมูลเกี่ยวกับการกําหนดค่าอุปกรณ์
ช่อง | |
---|---|
category |
หมวดหมู่ FCC ของอุปกรณ์ |
model |
ข้อมูลเกี่ยวกับรุ่นอุปกรณ์นี้ |
air_interface |
ข้อมูลเกี่ยวกับอินเทอร์เฟซอากาศของอุปกรณ์นี้ |
installation_params |
พารามิเตอร์การติดตั้งสําหรับอุปกรณ์ |
measurement_capabilities[] |
ความสามารถในการรายงานการวัดผลของอุปกรณ์ |
user_id |
ตัวระบุของผู้ใช้อุปกรณ์ |
call_sign |
สัญญาณเรียกขานของโอเปอเรเตอร์อุปกรณ์ |
state |
สถานะของการกําหนดค่า |
is_signed |
เอาต์พุตเท่านั้น การกําหนดค่าได้รับการลงนามโดย CPI หรือไม่ |
update_time |
เอาต์พุตเท่านั้น การแก้ไขการกําหนดค่าอุปกรณ์ครั้งล่าสุด |
รัฐ
สถานะของการกําหนดค่าอุปกรณ์ เฉพาะการกําหนดค่าในสถานะ DEVICE_CONFIG_STATE_FINAL
ที่ใช้ได้ในระหว่างการจดทะเบียน CBSD
Enum | |
---|---|
DEVICE_CONFIG_STATE_UNSPECIFIED |
|
DRAFT |
|
FINAL |
ให้สิทธิ์อุปกรณ์
การให้สิทธิ์อุปกรณ์ โดยเป็นการให้สิทธิ์จากระบบการเข้าถึงสเปกตรัมสําหรับอุปกรณ์เพื่อส่งโดยใช้พารามิเตอร์การทํางานที่ระบุหลังจากที่อุปกรณ์ฮาร์ตบีตสําเร็จ
ช่อง | |
---|---|
max_eirp |
พลังงานรังสีไอโซโทรปิกเทียบเท่า (EIRP) สูงสุดที่ได้รับอนุญาต EIRP สูงสุดอยู่ในหน่วย dBm/MHz ค่า |
frequency_range |
ช่วงความถี่ของการส่งข้อมูล |
state |
สถานะการให้สิทธิ์ |
channel_type |
ประเภทช่องทางที่ใช้ |
move_list[] |
การย้าย DPA จะแสดงการสมนาคุณนี้ |
expire_time |
เวลาของการให้สิทธิ์ |
suspension_reason[] |
หากการให้สิทธิ์ถูกระงับ สาเหตุของการระงับ |
grant_id |
รหัส Grant |
ข้อมูลเมตาของอุปกรณ์
ข้อมูลอุปกรณ์ลบล้างได้โดยทั้งพอร์ทัล SAS และคําขอลงทะเบียน
รุ่นอุปกรณ์
ข้อมูลเกี่ยวกับรุ่นของอุปกรณ์
ช่อง | |
---|---|
vendor |
ชื่อผู้ให้บริการอุปกรณ์ |
name |
ชื่อรุ่นของอุปกรณ์ |
software_version |
เวอร์ชันซอฟต์แวร์ของอุปกรณ์ |
hardware_version |
เวอร์ชันฮาร์ดแวร์ของอุปกรณ์ |
firmware_version |
เวอร์ชันเฟิร์มแวร์ของอุปกรณ์ |
รายการ DpaMove
ข้อมูลในรายการการย้ายของ DPA'
ช่อง | |
---|---|
dpa_id |
รหัสของ DPA |
frequency_range |
ช่วงความถี่ที่รายการย้ายได้รับผลกระทบ |
ช่วงความถี่
ช่วงความถี่จาก low_frequency
ถึง high_frequency
ช่อง | |
---|---|
low_frequency_mhz |
ความถี่ต่ําสุดของช่วงความถี่ในหน่วยมิลลิวินาที |
high_frequency_mhz |
ความถี่สูงสุดของช่วงความถี่ในหน่วยเมกะเฮิร์ตซ์ |
สร้างคําขอลับ
คําขอสําหรับ GenerateSecret
สร้างการตอบกลับลับ
คําตอบสําหรับ GenerateSecret
ช่อง | |
---|---|
secret |
ข้อมูลลับที่สร้างโดยสตริงและใช้โดย |
รับคําขอของลูกค้า
คําขอสําหรับ GetCustomer
ช่อง | |
---|---|
name |
ต้องระบุ ชื่อ |
รับ GetDeployment
คําขอสําหรับ GetDeployment
ช่อง | |
---|---|
name |
ต้องระบุ ชื่อ |
คําขอรับอุปกรณ์
คําขอสําหรับ GetDevice
ช่อง | |
---|---|
name |
ต้องระบุ ชื่ออุปกรณ์ |
รับ GetNode
คําขอสําหรับ GetNode
ช่อง | |
---|---|
name |
ต้องระบุ ชื่อ |
คําขอรับนโยบาย
ข้อความคําขอสําหรับเมธอด GetPolicy
ช่อง | |
---|---|
resource |
ต้องระบุ ทรัพยากรที่มีการขอนโยบาย |
GrantState
สถานะการให้สิทธิ์
Enum | |
---|---|
GRANT_STATE_UNSPECIFIED |
|
GRANT_STATE_GRANTED |
ให้สิทธิ์แล้ว แต่อุปกรณ์ไม่มีประสิทธิภาพ |
GRANT_STATE_TERMINATED |
SAS ได้ยกเลิกสิทธิ์ดังกล่าวแล้ว |
GRANT_STATE_SUSPENDED |
SAS ถูกระงับสิทธิ์ |
GRANT_STATE_AUTHORIZED |
อุปกรณ์กําลังส่งข้อมูลอยู่ในขณะนี้ |
GRANT_STATE_EXPIRED |
การให้สิทธิ์หมดอายุแล้ว |
ประเภทความสูง
ระบุวิธีวัดความสูง
Enum | |
---|---|
HEIGHT_TYPE_UNSPECIFIED |
ประเภทความสูงที่ไม่ระบุ |
HEIGHT_TYPE_AGL |
ความสูง AGL จะวัดโดยสัมพันธ์กับระดับพื้น |
HEIGHT_TYPE_AMSL |
ความสูงของ AMSL จะวัดโดยสัมพันธ์กับระดับน้ําทะเลเฉลี่ย |
พารามิเตอร์การติดตั้ง
ข้อมูลเกี่ยวกับพารามิเตอร์การติดตั้งอุปกรณ์
ช่อง | |
---|---|
latitude |
ละติจูดของตําแหน่งเสาอากาศของอุปกรณ์ เป็นองศาเมื่อเทียบกับมูลฐาน WGS 84 ช่วงที่อนุญาตคือตั้งแต่ -90.000000 ถึง +90.000000 ค่าบวกแสดงถึงละติจูดทางทิศเหนือของเส้นศูนย์สูตร ส่วนค่าลบทางทิศใต้ของเส้นศูนย์สูตร |
longitude |
ลองจิจูดของตําแหน่งเสาอากาศของอุปกรณ์ หน่วยเป็นองศาเมื่อเทียบกับมูลฐาน WGS 84 ช่วงที่อนุญาตคือตั้งแต่ -180.000000 ถึง +180.000000 ค่าบวกแสดงถึงลองจิจูดทางตะวันออกของเส้นเมริเดียนแรก ค่าลบทางด้านตะวันตกของเส้นเมริเดียนแรก |
height |
ความสูงของเสาอากาศของอุปกรณ์ หน่วยเป็นเมตร เมื่อค่าพารามิเตอร์ |
height_type |
ระบุวิธีวัดความสูง |
horizontal_accuracy |
จํานวนบวกเป็นเมตรเพื่อแสดงความแม่นยําของตําแหน่งเสาอากาศของอุปกรณ์ พารามิเตอร์ที่ไม่บังคับนี้ควรจะแสดงเฉพาะในกรณีที่ค่าน้อยกว่าข้อกําหนด FCC ที่ 50 เมตร |
vertical_accuracy |
จํานวนบวกในหน่วยเมตรเพื่อระบุความแม่นยําของตําแหน่งเสาอากาศของอุปกรณ์ พารามิเตอร์ที่ไม่บังคับนี้ควรจะแสดงเมื่อค่าน้อยกว่าข้อกําหนด FCC ขนาด 3 เมตร |
indoor_deployment |
เสาอากาศภายในอาคารเป็นแบบในร่มหรือไม่ |
antenna_azimuth |
ทิศทางของระนาบแนวนอนของเสาอากาศในหน่วยองศาตามทิศเหนือจริง ค่าของพารามิเตอร์นี้เป็นจํานวนเต็มที่มีค่าระหว่าง 0 ถึง 359 ค่า 0 องศาหมายถึงทิศเหนือจริง ค่า 90 องศาหมายถึงทิศตะวันออก พารามิเตอร์นี้จะใส่หรือไม่ก็ได้สําหรับอุปกรณ์หมวดหมู่ A และมีเงื่อนไขสําหรับอุปกรณ์หมวดหมู่ B |
antenna_downtilt |
เสาอากาศเอียงเป็นองศาและเป็นจํานวนเต็มที่มีค่าระหว่าง -90 ถึง +90 ส่วนค่าลบหมายความว่าเสาอากาศจะเอียงขึ้น (เหนือแนวนอน) พารามิเตอร์นี้จะใส่หรือไม่ก็ได้สําหรับอุปกรณ์หมวดหมู่ A และมีเงื่อนไขสําหรับอุปกรณ์หมวดหมู่ B |
antenna_gain |
ค่าเสาอากาศสูงสุดในหน่วย dBi พารามิเตอร์นี้เป็นจํานวนเต็มที่มีค่าระหว่าง -127 ถึง +128 (dBi) |
eirp_capability |
พารามิเตอร์นี้เป็น EIRP สูงสุดของอุปกรณ์ในหน่วย dBm/10MHz และเป็นจํานวนเต็มที่มีค่าระหว่าง -127 ถึง +47 (dBm/10 MHz) หากไม่ระบุ SAS จะตีความว่าเป็น EIRP สูงสุดที่อนุญาตในหน่วยหน่วย dBm/10MHz สําหรับหมวดหมู่อุปกรณ์ |
antenna_beamwidth |
เสาอากาศ 3dd แบบกระจายแสงของเสาอากาศในระนาบแนวนอน หน่วยเป็นองศา พารามิเตอร์นี้เป็นจํานวนเต็มที่ไม่ได้รับการรับรองที่มีค่าระหว่าง 0 ถึง 360 (องศา) พารามิเตอร์นี้เป็นตัวเลือกสําหรับอุปกรณ์หมวดหมู่ A และมีเงื่อนไขสําหรับอุปกรณ์หมวดหมู่ B |
antenna_model |
หากใช้เสาอากาศภายนอก รูปแบบเสาอากาศจะระบุไว้ในช่องนี้หรือไม่ก็ได้ สตริงมีความยาวได้สูงสุด 128 อ็อกเท็ต |
cpe_cbsd_indication |
พารามิเตอร์นี้จะระบุว่า CBSD เป็น CPE-CBSD หรือไม่ |
คําขอรายชื่อลูกค้า
คําขอสําหรับ ListCustomers
ช่อง | |
---|---|
page_size |
จํานวนสูงสุดของ |
page_token |
โทเค็นการใส่เลขหน้าที่แสดงผลจากการเรียกไปยัง |
การตอบกลับรายชื่อลูกค้า
คําตอบสําหรับ ListCustomers
ช่อง | |
---|---|
customers[] |
รายการของ |
next_page_token |
โทเค็นการใส่เลขหน้าที่แสดงผลจากการเรียกไปยัง |
แสดงรายการคําขอการทําให้ใช้งานได้
คําขอสําหรับ ListDeployments
ช่อง | |
---|---|
parent |
ต้องระบุ ชื่อทรัพยากรระดับบนสุด เช่น "nodes/1", customer/1/nodes/2 |
page_size |
จํานวนสูงสุดของการทําให้ใช้งานได้ที่จะส่งคืนในการตอบสนอง |
page_token |
โทเค็นการใส่เลขหน้าที่แสดงผลจากการเรียกไปยัง |
filter |
นิพจน์ตัวกรอง ตัวกรองควรมีรูปแบบต่อไปนี้: "DIRECT_CHILDREN" หรือรูปแบบ: "direct_children" ตัวกรองไม่คํานึงถึงตัวพิมพ์เล็กและตัวพิมพ์ใหญ่ หากว่างเปล่า ระบบจะไม่กรองการทําให้ใช้งานได้ |
การตอบกลับรายการการทําให้ใช้งานได้
คําตอบสําหรับ ListDeployments
ช่อง | |
---|---|
deployments[] |
|
next_page_token |
โทเค็นการใส่เลขหน้าที่แสดงผลจากการเรียกไปยัง |
คําขอรายการอุปกรณ์
คําขอสําหรับ ListDevices
ช่อง | |
---|---|
parent |
ต้องระบุ ชื่อของทรัพยากรระดับบนสุด |
page_size |
จํานวนสูงสุดของอุปกรณ์ที่จะแสดงผลในการตอบกลับ หากว่างเปล่าหรือมีค่าเป็น 0 อุปกรณ์ทั้งหมดจะแสดงในรายการ ต้องอยู่ในช่วง [0, 1000] |
page_token |
โทเค็นการใส่เลขหน้าที่แสดงผลจากการเรียกไปยัง |
filter |
นิพจน์ตัวกรอง ตัวกรองควรมีรูปแบบใดรูปแบบหนึ่งต่อไปนี้ ได้แก่ "sn=123454" หรือ "display_name=MyDevice". sn จะสอดคล้องกับหมายเลขซีเรียลของอุปกรณ์ ตัวกรองไม่คํานึงถึงตัวพิมพ์เล็กและตัวพิมพ์ใหญ่ |
คําตอบรายการอุปกรณ์
คําตอบสําหรับ ListDevices
ช่อง | |
---|---|
devices[] |
|
next_page_token |
โทเค็นการใส่เลขหน้าที่แสดงผลจากการเรียกไปยัง |
ขอรายการโหนด
คําขอสําหรับ ListNodes
ช่อง | |
---|---|
parent |
ต้องระบุ ชื่อทรัพยากรระดับบนสุด เช่น "nodes/1" |
page_size |
จํานวนโหนดสูงสุดที่จะแสดงในการตอบกลับ |
page_token |
โทเค็นการใส่เลขหน้าที่แสดงผลจากการเรียกไปยัง |
filter |
นิพจน์ตัวกรอง ตัวกรองควรมีรูปแบบต่อไปนี้: "DIRECT_CHILDREN" หรือรูปแบบ: "direct_children" ตัวกรองไม่คํานึงถึงตัวพิมพ์เล็กและตัวพิมพ์ใหญ่ หากเว้นว่างไว้ ระบบจะไม่กรองโหนด |
การตอบกลับรายการ
คําตอบสําหรับ ListNodes
ช่อง | |
---|---|
nodes[] |
|
next_page_token |
โทเค็นการใส่เลขหน้าที่แสดงผลจากการเรียกไปยัง |
ความสามารถในการวัด
ความสามารถในการวัดอุปกรณ์ ค่านี้กําหนดโดย WINNF-SSC-0002
Enum | |
---|---|
MEASUREMENT_CAPABILITY_UNSPECIFIED |
|
MEASUREMENT_CAPABILITY_RECEIVED_POWER_WITH_GRANT |
|
MEASUREMENT_CAPABILITY_RECEIVED_POWER_WITHOUT_GRANT |
ย้ายคําขอการติดตั้งใช้งาน
คําขอสําหรับ MoveDeployment
ช่อง | |
---|---|
name |
ต้องระบุ ชื่อของ |
destination |
ต้องระบุ ชื่อทรัพยากรระดับบนสุดใหม่ |
คําขอย้ายอุปกรณ์
คําขอสําหรับ MoveDevice
ช่อง | |
---|---|
name |
ต้องระบุ ชื่ออุปกรณ์ที่จะย้าย |
destination |
ต้องระบุ ชื่อทรัพยากรระดับบนสุดใหม่ |
ย้ายคําขอโหนด
คําขอสําหรับ MoveNode
ช่อง | |
---|---|
name |
ต้องระบุ ชื่อของ |
destination |
ต้องระบุ ชื่อของทรัพยากรระดับบนสุดใหม่ |
โหนด
โหนด
ช่อง | |
---|---|
name |
เอาต์พุตเท่านั้น ชื่อทรัพยากร |
display_name |
ชื่อที่แสดงของโหนด' |
sas_user_ids[] |
รหัสผู้ใช้ที่ใช้โดยอุปกรณ์ที่อยู่ในโหนดนี้ |
นโยบาย
กําหนดนโยบายการควบคุมการเข้าถึงทรัพยากร
ช่อง | |
---|---|
assignments[] |
รายการ |
etag |
โดยใช้เพื่อควบคุมการเกิดขึ้นพร้อมกันให้ได้มากที่สุด เพื่อป้องกันไม่ให้อัปเดตนโยบายพร้อมกันมากเกินไป เราขอแนะนําอย่างยิ่งให้ระบบใช้แท็กอิเล็กทรอนิกส์ในวงจร Read-modify-Write เพื่อทําการปรับปรุงนโยบายเพื่อหลีกเลี่ยงเงื่อนไขการแข่งขัน ได้แก่ แท็กจะส่งคืนเพื่อตอบสนองต่อ หากไม่ได้ใส่ Etag ไว้ในการเรียก |
คําขอตั้งค่านโยบาย
ข้อความคําขอสําหรับเมธอด SetPolicy
ช่อง | |
---|---|
resource |
ต้องระบุ ทรัพยากรที่มีการระบุนโยบาย นโยบายนี้จะแทนที่นโยบายที่มีอยู่ |
policy |
ต้องระบุ นโยบายที่จะนําไปใช้กับ |
คําขอ SignDevice
คําขอสําหรับ SignDevice
ช่อง | |
---|---|
device |
ต้องระบุ เครื่องหมาย |
คําขอสิทธิ์ทดสอบ
ข้อความคําขอสําหรับเมธอด TestPermissions
ช่อง | |
---|---|
resource |
ต้องระบุ ทรัพยากรที่มีการขอสิทธิ์ |
permissions[] |
ชุดของสิทธิ์ในการตรวจสอบ |
การตอบกลับเกี่ยวกับสิทธิ์ทดสอบ
ข้อความตอบกลับสําหรับเมธอด TestPermissions
ช่อง | |
---|---|
permissions[] |
ชุดสิทธิ์ที่ผู้โทรอนุญาต |
อัปเดตคําขอลูกค้า
คําขอสําหรับ UpdateCustomer
ช่อง | |
---|---|
customer |
ต้องระบุ ค่าใหม่สําหรับ |
update_mask |
ช่องที่จะอัปเดต |
อัปเดตคําขอทําให้ใช้งานได้
คําขอสําหรับ UpdateDeployment
ช่อง | |
---|---|
deployment |
ต้องระบุ ค่าใหม่สําหรับ |
update_mask |
ช่องที่จะอัปเดต |
อัปเดตคําขออุปกรณ์
คําขอสําหรับ UpdateDevice
ช่อง | |
---|---|
device |
ต้องระบุ |
update_mask |
ช่องที่จะอัปเดต |
อัปเดต NodeRequest
คําขอสําหรับ UpdateNode
ช่อง | |
---|---|
node |
ต้องระบุ ค่าใหม่สําหรับ |
update_mask |
ช่องที่จะอัปเดต |
อัปเดตคําขอ SignedDevice
คําขอสําหรับ UpdateSignedDevice
ช่อง | |
---|---|
name |
ต้องระบุ ชื่อของอุปกรณ์ที่จะอัปเดต |
encoded_device |
ต้องระบุ โทเค็นเว็บ JSON ที่รับรองโดยใช้คีย์ส่วนตัว CPI เพย์โหลดต้องเป็นการเข้ารหัส JSON ของ |
installer_id |
ต้องระบุ รหัสโปรแกรมติดตั้งที่ไม่ซ้ํา (รหัส CPI) จากฐานข้อมูลโปรแกรมติดตั้งที่ได้รับการรับรอง |
ตรวจสอบคําขอติดตั้ง
คําขอสําหรับ ValidateInstaller
ช่อง | |
---|---|
installer_id |
ต้องระบุ รหัสโปรแกรมติดตั้งที่ไม่ซ้ํา (รหัส CPI) จากฐานข้อมูลโปรแกรมติดตั้งที่ได้รับการรับรอง |
secret |
ต้องระบุ ข้อมูลลับที่แสดงผลโดย |
encoded_secret |
ต้องระบุ โทเค็นเว็บ JSON ที่รับรองโดยใช้คีย์ส่วนตัว CPI เปย์โหลดต้องมี "secret" การอ้างสิทธิ์ที่มีค่าเป็นความลับ |
โปรแกรมตรวจสอบ InstallInstaller
คําตอบสําหรับ ValidateInstaller