ดัชนี
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
| GetCustomer | |
|---|---|
|
แสดงผล
|
|
| ListCustomers | |
|---|---|
|
แสดงรายการ
|
|
| UpdateCustomer | |
|---|---|
|
อัปเดต
|
|
DeviceManager
บริการจัดการอุปกรณ์ Citizens Broadband Radio Service
| CreateDeployment | |
|---|---|
|
สร้าง
|
|
| CreateDevice | |
|---|---|
|
สร้าง
|
|
| CreateNode | |
|---|---|
|
สร้าง
|
|
| CreateSignedDevice | |
|---|---|
|
สร้าง
|
|
| DeleteDeployment | |
|---|---|
|
ลบ
|
|
| DeleteDevice | |
|---|---|
|
ลบ
|
|
| DeleteNode | |
|---|---|
|
ลบ
|
|
| GenerateSecret | |
|---|---|
|
สร้างข้อมูลลับที่จะใช้กับ
|
|
| GetDeployment | |
|---|---|
|
แสดงผล
|
|
| GetDevice | |
|---|---|
|
ดูรายละเอียดเกี่ยวกับ
|
|
| GetNode | |
|---|---|
|
แสดงผล
|
|
| ListDeployments | |
|---|---|
|
รายการ
|
|
| ListDevices | |
|---|---|
|
รายการ
|
|
| ListNodes | |
|---|---|
|
รายการ
|
|
| MoveDeployment | |
|---|---|
|
ย้าย
|
|
| MoveDevice | |
|---|---|
|
ย้าย
|
|
| MoveNode | |
|---|---|
|
ย้าย
|
|
| SignDevice | |
|---|---|
|
ลงนามใน
|
|
| UpdateDeployment | |
|---|---|
|
อัปเดต
|
|
| UpdateDevice | |
|---|---|
|
อัปเดต
|
|
| UpdateNode | |
|---|---|
|
อัปเดต
|
|
| UpdateSignedDevice | |
|---|---|
|
อัปเดต
|
|
| ValidateInstaller | |
|---|---|
|
ตรวจสอบตัวตนของผู้ติดตั้งมืออาชีพที่ได้รับการรับรอง (CPI)
|
|
PolicyService
บริการควบคุมการเข้าถึงไปยังเครื่องมือจัดการทรัพยากรสเปกตรัม
| GetPolicy | |
|---|---|
|
รับนโยบายการควบคุมการเข้าถึงสำหรับทรัพยากร แสดงผลนโยบายว่างหากมีทรัพยากรอยู่และไม่ได้ตั้งค่านโยบาย
|
|
| SetPolicy | |
|---|---|
|
กำหนดนโยบายการควบคุมการเข้าถึงในทรัพยากรที่ระบุ แทนที่นโยบายที่มีอยู่
|
|
| TestPermissions | |
|---|---|
|
แสดงสิทธิ์ที่ผู้เรียกใช้มีในทรัพยากรที่ระบุ
|
|
การมอบหมาย
เชื่อมโยง members กับ role
| ช่อง | |
|---|---|
role |
ต้องระบุ บทบาทที่มอบหมายให้ |
members[] |
ข้อมูลประจำตัวที่กำหนดบทบาทให้ โดยอาจมีค่าดังต่อไปนี้
|
BillingMode
โหมดการเรียกเก็บเงินของ CBSD
| Enum | |
|---|---|
BILLING_MODE_UNSPECIFIED |
ไม่ได้ระบุโหมดการเรียกเก็บเงิน |
MOBILE |
ราคาจะขึ้นอยู่กับหมวดหมู่ของ CBSD ได้แก่ หมวดหมู่ A และหมวดหมู่ B ที่ลงทะเบียนกับ SAS |
FIXED_WIRELESS |
ราคาจะขึ้นอยู่กับประเภท CBSD ได้แก่ สถานีฐานหรือ CPE |
ChannelType
| Enum | |
|---|---|
CHANNEL_TYPE_UNSPECIFIED |
|
CHANNEL_TYPE_GAA |
|
CHANNEL_TYPE_PAL |
|
CreateDeploymentRequest
คำขอสำหรับ CreateDeployment
| ช่อง | |
|---|---|
parent |
ต้องระบุ ชื่อทรัพยากรระดับบนสุดที่จะสร้างการทำให้ใช้งานได้ |
deployment |
ต้องระบุ รายละเอียดการติดตั้งใช้งาน |
CreateDeviceRequest
คำขอสำหรับ CreateDevice
| ช่อง | |
|---|---|
parent |
ต้องระบุ ชื่อของทรัพยากรหลัก |
device |
รายละเอียดการจดทะเบียน |
CreateNodeRequest
คำขอสำหรับ CreateNode
| ช่อง | |
|---|---|
parent |
ต้องระบุ ชื่อทรัพยากรหลักที่จะสร้างโหนด |
node |
รายละเอียดโหนด |
CreateSignedDeviceRequest
คำขอสำหรับ CreateSignedDevice
| ช่อง | |
|---|---|
parent |
ต้องระบุ ชื่อของทรัพยากรหลัก |
encoded_device |
ต้องระบุ โทเค็นเว็บ JSON ที่ลงชื่อโดยใช้คีย์ส่วนตัวของ CPI เพย์โหลดต้องเป็นการเข้ารหัส JSON ของ |
installer_id |
ต้องระบุ รหัสโปรแกรมติดตั้งที่ไม่ซ้ำกัน (รหัส CPI) จากฐานข้อมูลผู้ติดตั้งมืออาชีพที่ได้รับการรับรอง |
ลูกค้า
เอนทิตีที่แสดงลูกค้า SAS
| ช่อง | |
|---|---|
name |
เอาต์พุตเท่านั้น ชื่อทรัพยากรของลูกค้า |
display_name |
ต้องระบุ ชื่อองค์กรที่เอนทิตีลูกค้าเป็นตัวแทน |
sas_user_ids[] |
รหัสผู้ใช้ที่อุปกรณ์ของลูกค้ารายนี้ใช้ |
DeleteDeploymentRequest
คำขอสำหรับ DeleteDeployment
| ช่อง | |
|---|---|
name |
ต้องระบุ ชื่อของ |
DeleteDeviceRequest
คำขอสำหรับ DeleteDevice
| ช่อง | |
|---|---|
name |
ต้องระบุ ชื่อของอุปกรณ์ |
DeleteNodeRequest
คำขอสำหรับ DeleteNode
| ช่อง | |
|---|---|
name |
ต้องระบุ ชื่อของ |
การทำให้ใช้งานได้
การติดตั้งใช้งาน
| ช่อง | |
|---|---|
name |
เอาต์พุตเท่านั้น ชื่อทรัพยากร |
display_name |
ชื่อที่แสดงของการติดตั้งใช้งาน |
sas_user_ids[] |
รหัสผู้ใช้ที่อุปกรณ์ในการติดตั้งใช้งานนี้ใช้ การติดตั้งใช้งานแต่ละครั้งควรเชื่อมโยงกับรหัสผู้ใช้ที่ไม่ซ้ำกัน 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 Portal และคำขอลงทะเบียน SAS สามารถลบล้างได้ |
รัฐ
สถานะของอุปกรณ์
| Enum | |
|---|---|
DEVICE_STATE_UNSPECIFIED |
สถานะที่ไม่ได้ระบุ |
RESERVED |
อุปกรณ์ที่สร้างใน SAS Portal แต่ยังไม่ได้ลงทะเบียนกับ SAS |
REGISTERED |
อุปกรณ์ลงทะเบียนกับ SAS แล้ว |
DEREGISTERED |
ยกเลิกการลงทะเบียนอุปกรณ์กับ SAS แล้ว |
DeviceAirInterface
ข้อมูลเกี่ยวกับอินเทอร์เฟซทางอากาศของอุปกรณ์
| ช่อง | |
|---|---|
radio_technology |
มีเงื่อนไข ฟิลด์นี้ระบุเทคโนโลยีการเข้าถึงวิทยุที่ใช้สำหรับ CBSD |
supported_spec |
ไม่บังคับ ฟิลด์นี้เกี่ยวข้องกับ |
RadioTechnology
เทคโนโลยีการเข้าถึงวิทยุประเภทที่ได้รับอนุมัติ
| Enum | |
|---|---|
RADIO_TECHNOLOGY_UNSPECIFIED |
|
E_UTRA |
|
CAMBIUM_NETWORKS |
|
FOUR_G_BBW_SAA_1 |
|
NR |
|
DOODLE_CBRS |
|
CW |
|
REDLINE |
|
TARANA_WIRELESS |
|
DeviceCategory
หมวดหมู่ FCC ของอุปกรณ์ตามที่กำหนดไว้ในส่วนที่ 96
| Enum | |
|---|---|
DEVICE_CATEGORY_UNSPECIFIED |
หมวดหมู่อุปกรณ์ที่ไม่ได้ระบุ |
DEVICE_CATEGORY_A |
หมวดหมู่ ก. |
DEVICE_CATEGORY_B |
หมวดหมู่ B |
DeviceConfig
ข้อมูลเกี่ยวกับการกำหนดค่าอุปกรณ์
| ช่อง | |
|---|---|
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 |
|
DeviceGrant
การให้สิทธิ์เข้าถึงอุปกรณ์ โดยเป็นสิทธิ์ที่ระบบการเข้าถึงคลื่นความถี่ (Spectrum Access System) มอบให้แก่อุปกรณ์เพื่อส่งสัญญาณโดยใช้พารามิเตอร์การทำงานที่ระบุหลังจากที่อุปกรณ์ส่งสัญญาณ Heartbeat สำเร็จ
| ช่อง | |
|---|---|
max_eirp |
กำลังส่งออกอากาศสมมูลแบบไอโซทรอปิก (EIRP) สูงสุดที่ได้รับอนุญาตจากใบอนุญาต EIRP สูงสุดอยู่ในหน่วย dBm/MHz ค่าของ |
frequency_range |
ช่วงความถี่ในการส่ง |
state |
สถานะของการให้สิทธิ์ |
channel_type |
ประเภทของช่องที่ใช้ |
move_list[] |
รายการ DPA ที่มีการย้ายซึ่งมีการให้สิทธิ์นี้ |
expire_time |
เวลาหมดอายุของการให้สิทธิ์ |
suspension_reason[] |
หากมีการระงับเงินช่วยเหลือ เหตุผลของการระงับ |
grant_id |
รหัสการให้สิทธิ์ |
DeviceMetadata
ข้อมูลอุปกรณ์ที่ทั้ง SAS Portal และคำขอลงทะเบียนสามารถลบล้างได้
DeviceModel
ข้อมูลเกี่ยวกับรุ่นของอุปกรณ์
| ช่อง | |
|---|---|
vendor |
ชื่อของผู้จำหน่ายอุปกรณ์ |
name |
ชื่อรุ่นของอุปกรณ์ |
software_version |
เวอร์ชันซอฟต์แวร์ของอุปกรณ์ |
hardware_version |
เวอร์ชันฮาร์ดแวร์ของอุปกรณ์ |
firmware_version |
เวอร์ชันเฟิร์มแวร์ของอุปกรณ์ |
DpaMoveList
รายการในรายการย้ายของ DPA
| ช่อง | |
|---|---|
dpa_id |
รหัสของ DPA |
frequency_range |
ช่วงความถี่ที่รายการย้ายมีผล |
FrequencyRange
ช่วงความถี่ตั้งแต่ low_frequency ถึง high_frequency
| ช่อง | |
|---|---|
low_frequency_mhz |
ความถี่ต่ำสุดของช่วงความถี่ในหน่วย MHz |
high_frequency_mhz |
ความถี่สูงสุดของช่วงความถี่ในหน่วย MHz |
GenerateSecretRequest
คำขอสำหรับ GenerateSecret
GenerateSecretResponse
คำตอบสำหรับ GenerateSecret
| ช่อง | |
|---|---|
secret |
ข้อมูลลับที่สร้างขึ้นโดยสตริงและใช้โดย |
GetCustomerRequest
คำขอสำหรับ GetCustomer
| ช่อง | |
|---|---|
name |
ต้องระบุ ชื่อของ |
GetDeploymentRequest
คำขอสำหรับ GetDeployment
| ช่อง | |
|---|---|
name |
ต้องระบุ ชื่อของ |
GetDeviceRequest
คำขอสำหรับ GetDevice
| ช่อง | |
|---|---|
name |
ต้องระบุ ชื่อของอุปกรณ์ |
GetNodeRequest
คำขอสำหรับ GetNode
| ช่อง | |
|---|---|
name |
ต้องระบุ ชื่อของ |
GetPolicyRequest
ข้อความคำขอสำหรับเมธอด GetPolicy
| ช่อง | |
|---|---|
resource |
ต้องระบุ แหล่งข้อมูลที่ขอใช้นโยบาย |
GrantState
สถานะของการให้สิทธิ์
| Enum | |
|---|---|
GRANT_STATE_UNSPECIFIED |
|
GRANT_STATE_GRANTED |
ได้รับสิทธิ์แล้ว แต่อุปกรณ์ไม่ได้ส่งสัญญาณชีพจรในสิทธิ์นั้น |
GRANT_STATE_TERMINATED |
SAS ได้สิ้นสุดการให้สิทธิ์แล้ว |
GRANT_STATE_SUSPENDED |
SAS ได้ระงับการให้เงินช่วยเหลือ |
GRANT_STATE_AUTHORIZED |
ขณะนี้อุปกรณ์กำลังส่งข้อมูล |
GRANT_STATE_EXPIRED |
สิทธิ์หมดอายุแล้ว |
HeightType
ระบุวิธีวัดความสูง
| Enum | |
|---|---|
HEIGHT_TYPE_UNSPECIFIED |
ประเภทความสูงที่ไม่ได้ระบุ |
HEIGHT_TYPE_AGL |
ความสูง AGL จะวัดเทียบกับระดับพื้นดิน |
HEIGHT_TYPE_AMSL |
ความสูง AMSL จะวัดเทียบกับระดับน้ำทะเลเฉลี่ย |
InstallationParams
ข้อมูลเกี่ยวกับพารามิเตอร์การติดตั้งอุปกรณ์
| ช่อง | |
|---|---|
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 |
ทิศทาง Boresight ของระนาบแนวนอนของเสาอากาศเป็นองศาเมื่อเทียบกับทิศเหนือจริง ค่าของพารามิเตอร์นี้เป็นจำนวนเต็มที่มีค่าระหว่าง 0 ถึง 359 ค่า 0 องศาหมายถึงทิศเหนือจริง ส่วนค่า 90 องศาหมายถึงทิศตะวันออก พารามิเตอร์นี้จะใส่หรือไม่ใส่ก็ได้สำหรับอุปกรณ์หมวดหมู่ ก. และต้องใส่สำหรับอุปกรณ์หมวดหมู่ ข. |
antenna_downtilt |
การก้มเสาอากาศเป็นองศาและเป็นจำนวนเต็มที่มีค่าระหว่าง -90 ถึง +90 รวมอยู่ด้วย ค่าลบหมายความว่าเสาอากาศเอียงขึ้น (เหนือแนวนอน) พารามิเตอร์นี้จะใส่หรือไม่ใส่ก็ได้สำหรับอุปกรณ์หมวดหมู่ ก. และต้องใส่สำหรับอุปกรณ์หมวดหมู่ ข. |
antenna_gain |
อัตราขยายสูงสุดของเสาอากาศในหน่วย dBi พารามิเตอร์นี้เป็นจำนวนเต็มที่มีค่าระหว่าง -127 ถึง +128 (dBi) |
eirp_capability |
พารามิเตอร์นี้คือ EIRP สูงสุดของอุปกรณ์ในหน่วย dBm/10MHz และเป็นจำนวนเต็มที่มีค่าระหว่าง -127 ถึง +47 (dBm/10 MHz) หากไม่ได้ระบุ SAS จะตีความว่าเป็น EIRP สูงสุดที่อนุญาตในหน่วย dBm/10MHz สำหรับหมวดหมู่อุปกรณ์ |
antenna_beamwidth |
ความกว้างของลำแสงเสาอากาศ 3 dB ของเสาอากาศในระนาบแนวนอน หน่วยเป็นองศา พารามิเตอร์นี้เป็นจำนวนเต็มที่ไม่มีเครื่องหมายซึ่งมีค่าระหว่าง 0 ถึง 360 (องศา) รวมอยู่ด้วย โดยเป็นพารามิเตอร์ที่ไม่บังคับสำหรับอุปกรณ์หมวดหมู่ ก. และเป็นพารามิเตอร์แบบมีเงื่อนไขสำหรับอุปกรณ์หมวดหมู่ ข. |
antenna_model |
หากใช้เสาอากาศภายนอก คุณจะระบุรุ่นเสาอากาศในช่องนี้หรือไม่ก็ได้ สตริงมีความยาวของอักขระได้สูงสุด 128 ตัว |
cpe_cbsd_indication |
หากมี พารามิเตอร์นี้จะระบุว่า CBSD เป็น CPE-CBSD หรือไม่ |
ListCustomersRequest
คำขอสำหรับ ListCustomers
| ช่อง | |
|---|---|
page_size |
จำนวนสูงสุดของ |
page_token |
โทเค็นการแบ่งหน้าซึ่งได้จากการเรียกใช้ |
ListCustomersResponse
คำตอบสำหรับ ListCustomers
| ช่อง | |
|---|---|
customers[] |
รายการ |
next_page_token |
โทเค็นการแบ่งหน้าซึ่งส่งคืนจากการเรียกใช้ |
ListDeploymentsRequest
คำขอสำหรับ ListDeployments
| ช่อง | |
|---|---|
parent |
ต้องระบุ ชื่อทรัพยากรหลัก เช่น "nodes/1", customer/1/nodes/2 |
page_size |
จำนวนการติดตั้งใช้งานสูงสุดที่จะแสดงในคำตอบ |
page_token |
โทเค็นการแบ่งหน้าซึ่งได้จากการเรียกใช้ |
filter |
นิพจน์ตัวกรอง ตัวกรองควรมีรูปแบบ "DIRECT_CHILDREN" หรือ "direct_children" ตัวกรองจะไม่คำนึงถึงตัวพิมพ์เล็กและตัวพิมพ์ใหญ่ หากเว้นว่างไว้ ระบบจะไม่กรองการติดตั้งใช้งาน |
ListDeploymentsResponse
คำตอบสำหรับ ListDeployments
| ช่อง | |
|---|---|
deployments[] |
|
next_page_token |
โทเค็นการแบ่งหน้าซึ่งส่งคืนจากการเรียกใช้ |
ListDevicesRequest
คำขอสำหรับ ListDevices
| ช่อง | |
|---|---|
parent |
ต้องระบุ ชื่อของทรัพยากรหลัก |
page_size |
จำนวนอุปกรณ์สูงสุดที่จะแสดงในคำตอบ หากไม่มีข้อมูลหรือเป็น 0 ระบบจะแสดงอุปกรณ์ทั้งหมด ต้องอยู่ในช่วง [0, 1000] |
page_token |
โทเค็นการแบ่งหน้าซึ่งได้จากการเรียกใช้ |
filter |
นิพจน์ตัวกรอง ฟิลเตอร์ควรมีรูปแบบใดรูปแบบหนึ่งต่อไปนี้ "sn=123454" หรือ "display_name=MyDevice" โดย sn จะสอดคล้องกับหมายเลขซีเรียลของอุปกรณ์ ตัวกรองจะไม่คำนึงถึงตัวพิมพ์เล็กและตัวพิมพ์ใหญ่ |
ListDevicesResponse
คำตอบสำหรับ ListDevices
| ช่อง | |
|---|---|
devices[] |
|
next_page_token |
โทเค็นการแบ่งหน้าซึ่งส่งคืนจากการเรียกใช้ |
ListNodesRequest
คำขอสำหรับ ListNodes
| ช่อง | |
|---|---|
parent |
ต้องระบุ ชื่อทรัพยากรระดับบน เช่น "nodes/1" |
page_size |
จำนวนโหนดสูงสุดที่จะแสดงในการตอบกลับ |
page_token |
โทเค็นการแบ่งหน้าซึ่งได้จากการเรียกใช้ |
filter |
นิพจน์ตัวกรอง ตัวกรองควรมีรูปแบบ "DIRECT_CHILDREN" หรือ "direct_children" ตัวกรองจะไม่คำนึงถึงตัวพิมพ์เล็กและตัวพิมพ์ใหญ่ หากเว้นว่างไว้ ระบบจะไม่กรองโหนด |
ListNodesResponse
คำตอบสำหรับ ListNodes
| ช่อง | |
|---|---|
nodes[] |
|
next_page_token |
โทเค็นการแบ่งหน้าซึ่งส่งคืนจากการเรียกใช้ |
MeasurementCapability
ความสามารถในการวัดผลของอุปกรณ์ ค่าเหล่านี้กำหนดโดย WINNF-SSC-0002
| Enum | |
|---|---|
MEASUREMENT_CAPABILITY_UNSPECIFIED |
|
MEASUREMENT_CAPABILITY_RECEIVED_POWER_WITH_GRANT |
|
MEASUREMENT_CAPABILITY_RECEIVED_POWER_WITHOUT_GRANT |
|
MoveDeploymentRequest
คำขอสำหรับ MoveDeployment
| ช่อง | |
|---|---|
name |
ต้องระบุ ชื่อของ |
destination |
ต้องระบุ ชื่อของทรัพยากรหลักใหม่ |
MoveDeviceRequest
คำขอสำหรับ MoveDevice
| ช่อง | |
|---|---|
name |
ต้องระบุ ชื่อของอุปกรณ์ที่จะย้าย |
destination |
ต้องระบุ ชื่อของทรัพยากรหลักใหม่ |
MoveNodeRequest
คำขอสำหรับ MoveNode
| ช่อง | |
|---|---|
name |
ต้องระบุ ชื่อของ |
destination |
ต้องระบุ ชื่อของทรัพยากรหลักใหม่ |
โหนด
โหนด
| ช่อง | |
|---|---|
name |
เอาต์พุตเท่านั้น ชื่อทรัพยากร |
display_name |
ชื่อที่แสดงของโหนด |
sas_user_ids[] |
รหัสผู้ใช้ที่อุปกรณ์ในโหนดนี้ใช้ |
นโยบาย
กำหนดนโยบายควบคุมการเข้าถึงทรัพยากร
| ช่อง | |
|---|---|
assignments[] |
รายการ |
etag |
ระบบใช้ ETag สำหรับการควบคุมการทำงานพร้อมกันแบบมองโลกในแง่ดีเพื่อช่วยป้องกันไม่ให้การอัปเดตนโยบายพร้อมกันเขียนทับกัน เราขอแนะนำอย่างยิ่งให้ระบบใช้ etag ในวงจรการอ่าน-แก้ไข-เขียนเพื่ออัปเดตนโยบายเพื่อหลีกเลี่ยงการแข่งขัน: ระบบจะส่งคืน etag ในการตอบกลับไปยัง หากไม่ได้ระบุ ETag ในการเรียกใช้ |
SetPolicyRequest
ข้อความคำขอสำหรับเมธอด SetPolicy
| ช่อง | |
|---|---|
resource |
ต้องระบุ ทรัพยากรที่กำลังระบุนโยบาย นโยบายนี้จะแทนที่นโยบายที่มีอยู่ |
policy |
ต้องระบุ นโยบายที่จะนำไปใช้กับ |
SignDeviceRequest
คำขอสำหรับ SignDevice
| ช่อง | |
|---|---|
device |
ต้องระบุ |
TestPermissionsRequest
ข้อความคำขอสำหรับเมธอด TestPermissions
| ช่อง | |
|---|---|
resource |
ต้องระบุ ทรัพยากรที่ขอสิทธิ์ |
permissions[] |
ชุดสิทธิ์ที่จะตรวจสอบสำหรับ |
TestPermissionsResponse
ข้อความตอบกลับสำหรับเมธอด TestPermissions
| ช่อง | |
|---|---|
permissions[] |
ชุดสิทธิ์ที่ผู้โทรได้รับอนุญาต |
UpdateCustomerRequest
คำขอสำหรับ UpdateCustomer
| ช่อง | |
|---|---|
customer |
ต้องระบุ ค่าใหม่สำหรับ |
update_mask |
ฟิลด์ที่จะอัปเดต |
UpdateDeploymentRequest
คำขอสำหรับ UpdateDeployment
| ช่อง | |
|---|---|
deployment |
ต้องระบุ ค่าใหม่สำหรับ |
update_mask |
ฟิลด์ที่จะอัปเดต |
UpdateDeviceRequest
คำขอสำหรับ UpdateDevice
| ช่อง | |
|---|---|
device |
ต้องระบุ |
update_mask |
ฟิลด์ที่จะอัปเดต |
UpdateNodeRequest
คำขอสำหรับ UpdateNode
| ช่อง | |
|---|---|
node |
ต้องระบุ ค่าใหม่สำหรับ |
update_mask |
ฟิลด์ที่จะอัปเดต |
UpdateSignedDeviceRequest
คำขอสำหรับ UpdateSignedDevice
| ช่อง | |
|---|---|
name |
ต้องระบุ ชื่อของอุปกรณ์ที่จะอัปเดต |
encoded_device |
ต้องระบุ โทเค็นเว็บ JSON ที่ลงนามโดยใช้คีย์ส่วนตัวของ CPI เพย์โหลดต้องเป็นการเข้ารหัส JSON ของ |
installer_id |
ต้องระบุ รหัสโปรแกรมติดตั้งที่ไม่ซ้ำกัน (รหัส CPI) จากฐานข้อมูลผู้ติดตั้งมืออาชีพที่ได้รับการรับรอง |
ValidateInstallerRequest
คำขอสำหรับ ValidateInstaller
| ช่อง | |
|---|---|
installer_id |
ต้องระบุ รหัสโปรแกรมติดตั้งที่ไม่ซ้ำกัน (รหัส CPI) จากฐานข้อมูลผู้ติดตั้งมืออาชีพที่ได้รับการรับรอง |
secret |
ต้องระบุ ข้อมูลลับที่ |
encoded_secret |
ต้องระบุ โทเค็นเว็บ JSON ที่ลงชื่อโดยใช้คีย์ส่วนตัวของ CPI เพย์โหลดต้องมีอ้างสิทธิ์ "secret" ที่มีค่าเป็นข้อมูลลับ |
ValidateInstallerResponse
คำตอบสำหรับ ValidateInstaller