Package spectrum.sas.portal.v1alpha1

Chỉ mục

Khách hàng

Dịch vụ quản lý khách hàng SAS.

GetCustomer

rpc GetCustomer(GetCustomerRequest) returns (Customer)

Trả về một customer được yêu cầu.

Phạm vi cấp phép

Yêu cầu phạm vi OAuth sau:

  • https://www.googleapis.com/auth/userinfo.email
ListCustomers

rpc ListCustomers(ListCustomersRequest) returns (ListCustomersResponse)

Trả về danh sách customers được yêu cầu.

Phạm vi cấp phép

Yêu cầu phạm vi OAuth sau:

  • https://www.googleapis.com/auth/userinfo.email
UpdateCustomer

rpc UpdateCustomer(UpdateCustomerRequest) returns (Customer)

Cập nhật customer hiện có.

Phạm vi cấp phép

Yêu cầu phạm vi OAuth sau:

  • https://www.googleapis.com/auth/userinfo.email

DeviceManager

Dịch vụ quản lý Thiết bị dịch vụ vô tuyến băng tần công dân.

CreateDeployment

rpc CreateDeployment(CreateDeploymentRequest) returns (Deployment)

Tạo deployment mới.

Phạm vi cấp phép

Yêu cầu phạm vi OAuth sau:

  • https://www.googleapis.com/auth/userinfo.email
CreateDevice

rpc CreateDevice(CreateDeviceRequest) returns (Device)

Tạo một device trong node hoặc customer.

Phạm vi cấp phép

Yêu cầu phạm vi OAuth sau:

  • https://www.googleapis.com/auth/userinfo.email
CreateNode

rpc CreateNode(CreateNodeRequest) returns (Node)

Tạo node mới.

Phạm vi cấp phép

Yêu cầu phạm vi OAuth sau:

  • https://www.googleapis.com/auth/userinfo.email
CreateSignedDevice

rpc CreateSignedDevice(CreateSignedDeviceRequest) returns (Device)

Tạo một device đã ký trong node hoặc customer.

Phạm vi cấp phép

Yêu cầu phạm vi OAuth sau:

  • https://www.googleapis.com/auth/userinfo.email
DeleteDeployment

rpc DeleteDeployment(DeleteDeploymentRequest) returns (Empty)

Xoá một deployment.

Phạm vi cấp phép

Yêu cầu phạm vi OAuth sau:

  • https://www.googleapis.com/auth/userinfo.email
DeleteDevice

rpc DeleteDevice(DeleteDeviceRequest) returns (Empty)

Xoá một device.

Phạm vi cấp phép

Yêu cầu phạm vi OAuth sau:

  • https://www.googleapis.com/auth/userinfo.email
DeleteNode

rpc DeleteNode(DeleteNodeRequest) returns (Empty)

Xoá một node.

Phạm vi cấp phép

Yêu cầu phạm vi OAuth sau:

  • https://www.googleapis.com/auth/userinfo.email
GenerateSecret

rpc GenerateSecret(GenerateSecretRequest) returns (GenerateSecretResponse)

Tạo một bí mật để dùng với ValidateInstaller.

Phạm vi cấp phép

Yêu cầu phạm vi OAuth sau:

  • https://www.googleapis.com/auth/userinfo.email
GetDeployment

rpc GetDeployment(GetDeploymentRequest) returns (Deployment)

Trả về một deployment được yêu cầu.

Phạm vi cấp phép

Yêu cầu phạm vi OAuth sau:

  • https://www.googleapis.com/auth/userinfo.email
GetDevice

rpc GetDevice(GetDeviceRequest) returns (Device)

Lấy thông tin chi tiết về một device.

Phạm vi cấp phép

Yêu cầu phạm vi OAuth sau:

  • https://www.googleapis.com/auth/userinfo.email
GetNode

rpc GetNode(GetNodeRequest) returns (Node)

Trả về một node được yêu cầu.

Phạm vi cấp phép

Yêu cầu phạm vi OAuth sau:

  • https://www.googleapis.com/auth/userinfo.email
ListDeployments

rpc ListDeployments(ListDeploymentsRequest) returns (ListDeploymentsResponse)

Danh sách deployments.

Phạm vi cấp phép

Yêu cầu phạm vi OAuth sau:

  • https://www.googleapis.com/auth/userinfo.email
ListDevices

rpc ListDevices(ListDevicesRequest) returns (ListDevicesResponse)

Liệt kê devices trong node hoặc customer.

Phạm vi cấp phép

Yêu cầu phạm vi OAuth sau:

  • https://www.googleapis.com/auth/userinfo.email
ListNodes

rpc ListNodes(ListNodesRequest) returns (ListNodesResponse)

Danh sách nodes.

Phạm vi cấp phép

Yêu cầu phạm vi OAuth sau:

  • https://www.googleapis.com/auth/userinfo.email
MoveDeployment

rpc MoveDeployment(MoveDeploymentRequest) returns (Operation)

Di chuyển một deployment xuống dưới một node hoặc customer khác.

Phạm vi cấp phép

Yêu cầu phạm vi OAuth sau:

  • https://www.googleapis.com/auth/userinfo.email
MoveDevice

rpc MoveDevice(MoveDeviceRequest) returns (Operation)

Di chuyển một device xuống dưới một node hoặc customer khác.

Phạm vi cấp phép

Yêu cầu phạm vi OAuth sau:

  • https://www.googleapis.com/auth/userinfo.email
MoveNode

rpc MoveNode(MoveNodeRequest) returns (Operation)

Di chuyển một node xuống dưới một node hoặc customer khác.

Phạm vi cấp phép

Yêu cầu phạm vi OAuth sau:

  • https://www.googleapis.com/auth/userinfo.email
SignDevice

rpc SignDevice(SignDeviceRequest) returns (Empty)

Ký một device.

Phạm vi cấp phép

Yêu cầu phạm vi OAuth sau:

  • https://www.googleapis.com/auth/userinfo.email
UpdateDeployment

rpc UpdateDeployment(UpdateDeploymentRequest) returns (Deployment)

Cập nhật deployment hiện có.

Phạm vi cấp phép

Yêu cầu phạm vi OAuth sau:

  • https://www.googleapis.com/auth/userinfo.email
UpdateDevice

rpc UpdateDevice(UpdateDeviceRequest) returns (Device)

Cập nhật một device.

Phạm vi cấp phép

Yêu cầu phạm vi OAuth sau:

  • https://www.googleapis.com/auth/userinfo.email
UpdateNode

rpc UpdateNode(UpdateNodeRequest) returns (Node)

Cập nhật node hiện có.

Phạm vi cấp phép

Yêu cầu phạm vi OAuth sau:

  • https://www.googleapis.com/auth/userinfo.email
UpdateSignedDevice

rpc UpdateSignedDevice(UpdateSignedDeviceRequest) returns (Device)

Cập nhật một device đã ký.

Phạm vi cấp phép

Yêu cầu phạm vi OAuth sau:

  • https://www.googleapis.com/auth/userinfo.email
ValidateInstaller

rpc ValidateInstaller(ValidateInstallerRequest) returns (ValidateInstallerResponse)

Xác thực danh tính của Chuyên gia lắp đặt được chứng nhận (CPI).

Phạm vi cấp phép

Yêu cầu phạm vi OAuth sau:

  • https://www.googleapis.com/auth/userinfo.email

PolicyService

Dịch vụ kiểm soát quyền truy cập vào Spectrum Resource Manager.

GetPolicy

rpc GetPolicy(GetPolicyRequest) returns (Policy)

Lấy chính sách kiểm soát quyền truy cập cho một tài nguyên. Trả về một chính sách trống nếu tài nguyên tồn tại và không có chính sách nào được đặt.

Phạm vi cấp phép

Yêu cầu phạm vi OAuth sau:

  • https://www.googleapis.com/auth/userinfo.email
SetPolicy

rpc SetPolicy(SetPolicyRequest) returns (Policy)

Đặt chính sách kiểm soát quyền truy cập cho tài nguyên được chỉ định. Thay thế mọi chính sách hiện có.

Phạm vi cấp phép

Yêu cầu phạm vi OAuth sau:

  • https://www.googleapis.com/auth/userinfo.email
TestPermissions

rpc TestPermissions(TestPermissionsRequest) returns (TestPermissionsResponse)

Trả về các quyền mà người gọi có đối với tài nguyên được chỉ định.

Phạm vi cấp phép

Yêu cầu phạm vi OAuth sau:

  • https://www.googleapis.com/auth/userinfo.email

Assignment

Liên kết members với một role.

Trường
role

string

Bắt buộc. Vai trò được chỉ định cho members.
members[]

string

Danh tính được chỉ định vai trò. Thuộc tính này có thể có các giá trị sau:

  • {user_email}: Địa chỉ email đại diện cho một Tài khoản Google cụ thể. Ví dụ: alice@gmail.com.

  • {group_email}: Địa chỉ email đại diện cho một nhóm trên Google. Ví dụ: viewers@gmail.com.

BillingMode

Chế độ thanh toán của CBSD

Enum
BILLING_MODE_UNSPECIFIED Bạn chưa chỉ định chế độ thanh toán.
MOBILE Giá dựa trên danh mục CBSD: Danh mục A, Danh mục B đã đăng ký với SAS.
FIXED_WIRELESS Giá dựa trên loại CBSD: Trạm gốc hoặc CPE.

ChannelType

Enum
CHANNEL_TYPE_UNSPECIFIED
CHANNEL_TYPE_GAA
CHANNEL_TYPE_PAL

CreateDeploymentRequest

Yêu cầu đối với CreateDeployment.

Trường
parent

string

Bắt buộc. Tên tài nguyên mẹ nơi cần tạo hoạt động triển khai.
deployment

Deployment

Bắt buộc. Thông tin chi tiết về việc triển khai. name phải trống. Mã này do máy chủ tạo. Bạn phải đặt display_name triển khai.

CreateDeviceRequest

Yêu cầu đối với CreateDevice.

Trường
parent

string

Bắt buộc. Tên của tài nguyên gốc.
device

Device

Thông tin đăng ký device. name phải trống. Mã này do máy chủ tạo. Bạn phải đặt các trường device fcc_id và serial_number. Bạn phải đặt trường user_id.

CreateNodeRequest

Yêu cầu đối với CreateNode.

Trường
parent

string

Bắt buộc. Tên tài nguyên gốc nơi nút sẽ được tạo.
node

Node

Thông tin chi tiết về nút. name phải trống. Mã này do máy chủ tạo. Bạn phải đặt nút display_name.

CreateSignedDeviceRequest

Yêu cầu đối với CreateSignedDevice.

Trường
parent

string

Bắt buộc. Tên của tài nguyên gốc.
encoded_device

bytes

Bắt buộc. Mã thông báo Web JSON được ký bằng khoá riêng tư CPI. Tải trọng phải là mã hoá JSON của device. Bạn phải đặt trường user_id.
installer_id

string

Bắt buộc. Mã nhận dạng duy nhất của người cài đặt (CPI ID) trong cơ sở dữ liệu của Certified Professional Installers.

Khách hàng

Thực thể đại diện cho một khách hàng SAS.

Trường
name

string

Chỉ có đầu ra. Tên tài nguyên của khách hàng.
display_name

string

Bắt buộc. Tên của tổ chức mà pháp nhân khách hàng đại diện.
sas_user_ids[]

string

Mã nhận dạng người dùng mà các thiết bị thuộc về khách hàng này sử dụng.

DeleteDeploymentRequest

Yêu cầu đối với DeleteDeployment.

Trường
name

string

Bắt buộc. Tên của deployment.

DeleteDeviceRequest

Yêu cầu đối với DeleteDevice.

Trường
name

string

Bắt buộc. Tên của thiết bị.

DeleteNodeRequest

Yêu cầu đối với DeleteNode.

Trường
name

string

Bắt buộc. Tên của node.

Triển khai

The Deployment.

Trường
name

string

Chỉ có đầu ra. Tên tài nguyên.
display_name

string

Tên hiển thị của quá trình triển khai.
sas_user_ids[]

string

Mã nhận dạng người dùng mà các thiết bị thuộc hoạt động triển khai này sử dụng. Mỗi lượt triển khai phải được liên kết với một mã nhận dạng người dùng duy nhất.
default_billing_mode

BillingMode

Chế độ thanh toán mặc định cho việc triển khai và các thiết bị thuộc chế độ đó.
allowed_billing_modes[]

BillingMode

Các chế độ thanh toán được phép trong quá trình triển khai này.

Thiết bị

Trường
name

string

Chỉ có đầu ra. Tên đường dẫn tài nguyên.
fcc_id

string

Mã nhận dạng FCC của thiết bị.
serial_number

string

Số sê-ri do nhà sản xuất thiết bị chỉ định cho thiết bị.
preloaded_config

DeviceConfig

Cấu hình của thiết bị, như được chỉ định thông qua SAS Portal API.
active_config

DeviceConfig

Chỉ có đầu ra. Cấu hình hiện tại của thiết bị khi được đăng ký với SAS.
state

State

Chỉ có đầu ra. Trạng thái thiết bị.
grants[]

DeviceGrant

Chỉ có đầu ra. Các quyền mà thiết bị có.
display_name

string

Tên hiển thị của thiết bị.
device_metadata

DeviceMetadata

Các thông số thiết bị mà cả Cổng SAS và yêu cầu đăng ký SAS đều có thể ghi đè.

Tiểu bang

Trạng thái của thiết bị.

Enum
DEVICE_STATE_UNSPECIFIED Trạng thái chưa xác định.
RESERVED Thiết bị được tạo trong SAS Portal nhưng chưa được đăng ký với SAS.
REGISTERED Thiết bị đã được đăng ký với SAS.
DEREGISTERED Thiết bị đã huỷ đăng ký với SAS.

DeviceAirInterface

Thông tin về giao diện vô tuyến của thiết bị.

Trường
radio_technology

RadioTechnology

Có điều kiện. Trường này chỉ định công nghệ truy cập vô tuyến được dùng cho CBSD.
supported_spec

string

Không bắt buộc. Trường này liên quan đến radioTechnology và cung cấp quy cách giao diện vô tuyến mà CBSD tuân thủ tại thời điểm đăng ký.

RadioTechnology

Các loại công nghệ truy cập vô tuyến được phê duyệt.

Enum
RADIO_TECHNOLOGY_UNSPECIFIED
E_UTRA
CAMBIUM_NETWORKS
FOUR_G_BBW_SAA_1
NR
DOODLE_CBRS
CW
REDLINE
TARANA_WIRELESS

DeviceCategory

Danh mục FCC của thiết bị, theo quy định tại Phần 96.

Enum
DEVICE_CATEGORY_UNSPECIFIED Danh mục thiết bị không xác định.
DEVICE_CATEGORY_A Danh mục A.
DEVICE_CATEGORY_B Danh mục B.

DeviceConfig

Thông tin về cấu hình thiết bị.

Trường
category

DeviceCategory

Danh mục FCC của thiết bị.
model

DeviceModel

Thông tin về kiểu thiết bị này.
air_interface

DeviceAirInterface

Thông tin về giao diện vô tuyến của thiết bị này.
installation_params

InstallationParams

Các thông số cài đặt cho thiết bị.
measurement_capabilities[]

MeasurementCapability

Khả năng báo cáo đo lường của thiết bị.
user_id

StringValue

Giá trị nhận dạng của người dùng thiết bị.
call_sign

string

Mã nhận dạng của người vận hành thiết bị.
state

State

Trạng thái của cấu hình.
is_signed

BoolValue

Chỉ có đầu ra. Liệu cấu hình đã được CPI ký hay chưa.
update_time

Timestamp

Chỉ có đầu ra. Lần gần đây nhất chỉnh sửa cấu hình thiết bị.

Tiểu bang

Trạng thái của cấu hình thiết bị. Bạn chỉ có thể sử dụng các cấu hình ở trạng thái DEVICE_CONFIG_STATE_FINAL trong quá trình Đăng ký CBSD.

Enum
DEVICE_CONFIG_STATE_UNSPECIFIED
DRAFT
FINAL

DeviceGrant

Cấp quyền cho thiết bị. Đây là một cơ chế uỷ quyền do Hệ thống truy cập phổ tần cung cấp cho một thiết bị để truyền dữ liệu bằng các thông số hoạt động được chỉ định sau khi thiết bị gửi tín hiệu nhịp tim thành công.

Trường
max_eirp

DoubleValue

Công suất bức xạ đẳng hướng tương đương (EIRP) tối đa được phép theo giấy phép. EIRP tối đa có đơn vị là dBm/MHz. Giá trị của maxEirp biểu thị EIRP trung bình (RMS) sẽ được đo bằng quy trình được xác định trong phần 96.41(e)(3) của FCC.
frequency_range

FrequencyRange

Phạm vi tần số truyền.
state

GrantState

Trạng thái của việc cấp quyền.
channel_type

ChannelType

Loại kênh được sử dụng.
move_list[]

DpaMoveList

Danh sách di chuyển của DPA mà khoản trợ cấp này xuất hiện.
expire_time

Timestamp

Thời gian hết hạn của quyền truy cập.
suspension_reason[]

string

Nếu khoản tài trợ bị tạm ngưng, (các) lý do tạm ngưng.
grant_id

string

Mã cấp quyền.

DeviceMetadata

Cả SAS Portal và các yêu cầu đăng ký đều có thể ghi đè dữ liệu thiết bị.

DeviceModel

Thông tin về kiểu máy của thiết bị.

Trường
vendor

string

Tên của nhà cung cấp thiết bị.
name

string

Tên của mẫu thiết bị.
software_version

string

Phiên bản phần mềm của thiết bị.
hardware_version

string

Phiên bản phần cứng của thiết bị.
firmware_version

string

Phiên bản chương trình cơ sở của thiết bị.

DpaMoveList

Một mục trong danh sách di chuyển của DPA.

Trường
dpa_id

StringValue

Mã nhận dạng của quảng cáo dựa trên kho hàng tại địa phương.
frequency_range

FrequencyRange

Phạm vi tần suất mà danh sách di chuyển ảnh hưởng.

FrequencyRange

Dải tần số từ low_frequency đến high_frequency.

Trường
low_frequency_mhz

DoubleValue

Tần số thấp nhất của dải tần số tính bằng MHz.
high_frequency_mhz

DoubleValue

Tần số cao nhất của dải tần số tính bằng MHz.

GenerateSecretRequest

Yêu cầu đối với GenerateSecret.

GenerateSecretResponse

Câu trả lời cho GenerateSecret.

Trường
secret

string

Khoá bí mật do chuỗi tạo và được ValidateInstaller sử dụng.

GetCustomerRequest

Yêu cầu đối với GetCustomer .

Trường
name

string

Bắt buộc. Tên của customer.

GetDeploymentRequest

Yêu cầu đối với GetDeployment.

Trường
name

string

Bắt buộc. Tên của deployment.

GetDeviceRequest

Yêu cầu đối với GetDevice.

Trường
name

string

Bắt buộc. Tên của thiết bị.

GetNodeRequest

Yêu cầu đối với GetNode.

Trường
name

string

Bắt buộc. Tên của node.

GetPolicyRequest

Thông báo yêu cầu cho phương thức GetPolicy.

Trường
resource

string

Bắt buộc. Tài nguyên mà bạn đang yêu cầu áp dụng chính sách.

GrantState

Trạng thái của việc cấp quyền.

Enum
GRANT_STATE_UNSPECIFIED
GRANT_STATE_GRANTED Quyền truy cập đã được cấp nhưng thiết bị không gửi tín hiệu nhịp tim trên quyền truy cập đó.
GRANT_STATE_TERMINATED SAS đã chấm dứt việc cấp quyền.
GRANT_STATE_SUSPENDED SAS đã tạm ngưng khoản tài trợ này.
GRANT_STATE_AUTHORIZED Thiết bị hiện đang truyền dữ liệu.
GRANT_STATE_EXPIRED Khoản trợ cấp đã hết hạn.

HeightType

Chỉ định cách đo chiều cao.

Enum
HEIGHT_TYPE_UNSPECIFIED Loại chiều cao chưa được chỉ định.
HEIGHT_TYPE_AGL Chiều cao AGL được đo so với mặt đất.
HEIGHT_TYPE_AMSL Chiều cao AMSL được đo so với mực nước biển trung bình.

InstallationParams

Thông tin về các thông số cài đặt thiết bị.

Trường
latitude

DoubleValue

Vĩ độ của vị trí ăng-ten thiết bị theo độ so với hệ quy chiếu WGS 84. Phạm vi cho phép là từ -90.000000 đến +90.000000. Giá trị dương biểu thị vĩ độ ở phía bắc đường xích đạo; giá trị âm biểu thị vĩ độ ở phía nam đường xích đạo.
longitude

DoubleValue

Kinh độ của vị trí ăng-ten thiết bị theo độ so với hệ quy chiếu WGS 84. Phạm vi cho phép là từ -180.000000 đến +180.000000. Giá trị dương biểu thị kinh độ ở phía đông kinh tuyến gốc; giá trị âm biểu thị kinh độ ở phía tây kinh tuyến gốc.
height

DoubleValue

Chiều cao anten của thiết bị tính bằng mét. Khi giá trị tham số heightType là "AGL", bạn phải cung cấp chiều cao ăng-ten so với mặt đất. Khi giá trị tham số heightType là "AMSL", giá trị này được đưa ra liên quan đến hệ quy chiếu WGS84.
height_type

HeightType

Chỉ định cách đo chiều cao.
horizontal_accuracy

DoubleValue

Một số dương tính bằng mét để cho biết độ chính xác của vị trí ngang của ăng-ten thiết bị. Tham số không bắt buộc này chỉ xuất hiện nếu giá trị của tham số này nhỏ hơn yêu cầu của FCC là 50 mét.
vertical_accuracy

DoubleValue

Một số dương tính bằng mét để cho biết độ chính xác của vị trí dọc của ăng-ten thiết bị. Tham số không bắt buộc này chỉ xuất hiện nếu giá trị của tham số này nhỏ hơn yêu cầu của FCC là 3 mét.
indoor_deployment

BoolValue

Ăng-ten của thiết bị có ở trong nhà hay không. true: trong nhà. false: ngoài trời.
antenna_azimuth

Int32Value

Hướng trục ngắm của mặt phẳng ngang của ăng ten theo độ so với hướng chính bắc. Giá trị của tham số này là một số nguyên có giá trị từ 0 đến 359. Giá trị 0 độ có nghĩa là hướng bắc thực; giá trị 90 độ có nghĩa là hướng đông. Tham số này là không bắt buộc đối với thiết bị Danh mục A và có điều kiện đối với thiết bị Danh mục B.
antenna_downtilt

Int32Value

Độ nghiêng xuống của ăng-ten tính bằng độ và là một số nguyên có giá trị từ -90 đến +90 (bao gồm cả 2 giá trị đó); giá trị âm có nghĩa là ăng-ten nghiêng lên (trên phương ngang). Tham số này là không bắt buộc đối với thiết bị Danh mục A và có điều kiện đối với thiết bị Danh mục B.
antenna_gain

Int32Value

Độ lợi đỉnh của ăng-ten tính bằng dBi. Tham số này là một số nguyên có giá trị từ -127 đến +128 (dBi).
eirp_capability

Int32Value

Tham số này là EIRP tối đa của thiết bị, có đơn vị là dBm/10 MHz và là một số nguyên có giá trị từ -127 đến +47 (dBm/10 MHz). Nếu không có thông tin này, SAS sẽ hiểu đó là EIRP tối đa được phép tính bằng dBm/10MHz cho danh mục thiết bị.
antenna_beamwidth

Int32Value

Độ rộng chùm ăng ten 3 dB của ăng ten trong mặt phẳng ngang tính bằng độ. Tham số này là một số nguyên không dấu có giá trị từ 0 đến 360 (độ); đây là tham số không bắt buộc đối với thiết bị Loại A và có điều kiện đối với thiết bị Loại B.
antenna_model

string

Nếu bạn sử dụng ăng-ten ngoài, thì bạn có thể cung cấp mô hình ăng-ten trong trường này. Chuỗi này có độ dài tối đa là 128 octet.
cpe_cbsd_indication

BoolValue

Nếu có, tham số này chỉ định xem CBSD có phải là CPE-CBSD hay không.

ListCustomersRequest

Yêu cầu đối với ListCustomers.

Trường
page_size

int32

Số lượng customers tối đa cần trả về trong phản hồi.
page_token

string

Mã thông báo phân trang được trả về từ một lệnh gọi trước đó đến ListCustomers, cho biết vị trí mà danh sách này sẽ tiếp tục.

ListCustomersResponse

Câu trả lời cho ListCustomers.

Trường
customers[]

Customer

Danh sách customers khớp với yêu cầu.
next_page_token

string

Mã thông báo phân trang được trả về từ một lệnh gọi trước đó đến ListCustomers, cho biết vị trí mà danh sách sẽ tiếp tục. Nếu trường này bị thiếu hoặc trống, tức là không còn khách hàng nào nữa.

ListDeploymentsRequest

Yêu cầu đối với ListDeployments.

Trường
parent

string

Bắt buộc. Tên tài nguyên gốc, ví dụ: "nodes/1", customer/1/nodes/2.
page_size

int32

Số lượng bản triển khai tối đa cần trả về trong phản hồi.
page_token

string

Mã thông báo phân trang được trả về từ một lệnh gọi trước đó đến ListDeployments, cho biết vị trí mà danh sách này sẽ tiếp tục.
filter

string

Biểu thức bộ lọc. Bộ lọc phải có định dạng sau: "DIRECT_CHILDREN" hoặc định dạng: "direct_children". Bộ lọc này không phân biệt chữ hoa chữ thường. Nếu trống, thì không có lượt triển khai nào được lọc.

ListDeploymentsResponse

Câu trả lời cho ListDeployments.

Trường
deployments[]

Deployment

deployments phù hợp với yêu cầu.
next_page_token

string

Mã thông báo phân trang được trả về từ một lệnh gọi trước đó đến ListDeployments, cho biết vị trí mà danh sách sẽ tiếp tục. Nếu trường này bị thiếu hoặc trống, tức là không còn lượt triển khai nào nữa.

ListDevicesRequest

Yêu cầu đối với ListDevices.

Trường
parent

string

Bắt buộc. Tên của tài nguyên gốc.
page_size

int32

Số lượng thiết bị tối đa cần trả về trong phản hồi. Nếu bạn để trống hoặc đặt giá trị bằng 0, thì tất cả thiết bị sẽ xuất hiện trong danh sách. Phải nằm trong phạm vi [0, 1000].
page_token

string

Mã thông báo phân trang được trả về từ một lệnh gọi trước đó đến ListDevices, cho biết vị trí mà danh sách này sẽ tiếp tục.
filter

string

Biểu thức bộ lọc. Bộ lọc phải có một trong các định dạng sau: "sn=123454" hoặc "display_name=MyDevice". sn tương ứng với số sê-ri của thiết bị. Bộ lọc này không phân biệt chữ hoa chữ thường.

ListDevicesResponse

Câu trả lời cho ListDevices.

Trường
devices[]

Device

devices phù hợp với yêu cầu.
next_page_token

string

Mã thông báo phân trang được trả về từ một lệnh gọi trước đó đến ListDevices, cho biết vị trí mà danh sách sẽ tiếp tục. Nếu trường này bị thiếu hoặc trống, tức là không còn thiết bị nào nữa.

ListNodesRequest

Yêu cầu đối với ListNodes.

Trường
parent

string

Bắt buộc. Tên tài nguyên mẹ, ví dụ: "nodes/1".
page_size

int32

Số lượng nút tối đa cần trả về trong phản hồi.
page_token

string

Mã thông báo phân trang được trả về từ một lệnh gọi trước đó đến ListNodes, cho biết vị trí mà danh sách này sẽ tiếp tục.
filter

string

Biểu thức bộ lọc. Bộ lọc phải có định dạng sau: "DIRECT_CHILDREN" hoặc định dạng: "direct_children". Bộ lọc này không phân biệt chữ hoa chữ thường. Nếu trống, thì không có nút nào được lọc.

ListNodesResponse

Câu trả lời cho ListNodes.

Trường
nodes[]

Node

nodes phù hợp với yêu cầu.
next_page_token

string

Mã thông báo phân trang được trả về từ một lệnh gọi trước đó đến ListNodes, cho biết vị trí mà danh sách sẽ tiếp tục. Nếu trường này bị thiếu hoặc trống, tức là không còn nút nào nữa.

MeasurementCapability

Khả năng đo lường trên thiết bị. Các giá trị được xác định theo WINNF-SSC-0002.

Enum
MEASUREMENT_CAPABILITY_UNSPECIFIED
MEASUREMENT_CAPABILITY_RECEIVED_POWER_WITH_GRANT
MEASUREMENT_CAPABILITY_RECEIVED_POWER_WITHOUT_GRANT

MoveDeploymentRequest

Yêu cầu đối với MoveDeployment.

Trường
name

string

Bắt buộc. Tên của deployment cần di chuyển.
destination

string

Bắt buộc. Tên của tài nguyên mẹ mới node hoặc customer để đổi tài nguyên mẹ của hoạt động triển khai.

MoveDeviceRequest

Yêu cầu đối với MoveDevice.

Trường
name

string

Bắt buộc. Tên của thiết bị cần di chuyển.
destination

string

Bắt buộc. Tên của tài nguyên mẹ mới node hoặc customer để đổi mối quan hệ mẹ con của thiết bị.

MoveNodeRequest

Yêu cầu đối với MoveNode.

Trường
name

string

Bắt buộc. Tên của node cần di chuyển.
destination

string

Bắt buộc. Tên của tài nguyên mẹ mới node hoặc customer để đổi tài nguyên mẹ cho nút.

Nút

The Node.

Trường
name

string

Chỉ có đầu ra. Tên tài nguyên.
display_name

string

Tên hiển thị của nút.
sas_user_ids[]

string

Mã người dùng mà các thiết bị thuộc nút này sử dụng.

Chính sách

Xác định một chính sách kiểm soát quyền truy cập vào các tài nguyên.

Trường
assignments[]

Assignment

Danh sách assignments
etag

bytes

etag được dùng để kiểm soát tính đồng thời lạc quan như một cách giúp ngăn chặn các bản cập nhật đồng thời của một chính sách ghi đè lẫn nhau. Các hệ thống nên sử dụng etag trong chu kỳ đọc-sửa đổi-ghi để thực hiện các bản cập nhật chính sách nhằm tránh tình trạng xung đột: Etag được trả về trong phản hồi cho GetPolicy và các hệ thống dự kiến sẽ đặt etag đó trong yêu cầu đối với SetPolicy để đảm bảo rằng thay đổi của chúng sẽ được áp dụng cho cùng một phiên bản của chính sách.

Nếu không có etag nào được cung cấp trong lệnh gọi đến GetPolicy, thì chính sách hiện có sẽ bị ghi đè một cách mù quáng.

SetPolicyRequest

Thông báo yêu cầu cho phương thức SetPolicy.

Trường
resource

string

Bắt buộc. Tài nguyên mà chính sách đang được chỉ định. Chính sách này sẽ thay thế mọi chính sách hiện có.
policy

Policy

Bắt buộc. Chính sách sẽ được áp dụng cho resource.

SignDeviceRequest

Yêu cầu đối với SignDevice.

Trường
device

Device

Bắt buộc. device cần ký. Bạn phải đặt các trường device name, fcc_id và serial_number. Bạn phải đặt trường user_id.

TestPermissionsRequest

Thông báo yêu cầu cho phương thức TestPermissions.

Trường
resource

string

Bắt buộc. Tài nguyên mà bạn đang yêu cầu cấp quyền.
permissions[]

string

Tập hợp các quyền cần kiểm tra đối với resource.

TestPermissionsResponse

Thông báo phản hồi cho phương thức TestPermissions.

Trường
permissions[]

string

Một tập hợp các quyền mà phương thức gọi được phép.

UpdateCustomerRequest

Yêu cầu đối với UpdateCustomer.

Trường
customer

Customer

Bắt buộc. Giá trị mới cho customer. Khách hàng phải đặt name và display_name.
update_mask

FieldMask

Các trường cần cập nhật.

UpdateDeploymentRequest

Yêu cầu đối với UpdateDeployment.

Trường
deployment

Deployment

Bắt buộc. Giá trị mới cho deployment. Bạn phải đặt name và display_name.
update_mask

FieldMask

Các trường cần cập nhật.

UpdateDeviceRequest

Yêu cầu đối với UpdateDevice.

Trường
device

Device

Bắt buộc. device để cập nhật. Bạn phải đặt các trường device name, fcc_id và serial_number. Bạn phải đặt trường user_id.
update_mask

FieldMask

Các trường cần cập nhật.

UpdateNodeRequest

Yêu cầu đối với UpdateNode.

Trường
node

Node

Bắt buộc. Giá trị mới cho node. Bạn phải đặt name và display_name.
update_mask

FieldMask

Các trường cần cập nhật.

UpdateSignedDeviceRequest

Yêu cầu đối với UpdateSignedDevice.

Trường
name

string

Bắt buộc. Tên của thiết bị cần cập nhật.
encoded_device

bytes

Bắt buộc. Mã thông báo Web JSON được ký bằng khoá riêng tư CPI. Tải trọng phải là mã hoá JSON của device. Bạn phải đặt trường user_id.
installer_id

string

Bắt buộc. Mã nhận dạng duy nhất của người lắp đặt (CPI ID) trong cơ sở dữ liệu của Certified Professional Installers.

ValidateInstallerRequest

Yêu cầu đối với ValidateInstaller.

Trường
installer_id

string

Bắt buộc. Mã nhận dạng duy nhất của người cài đặt (CPI ID) trong cơ sở dữ liệu của Certified Professional Installers.
secret

string

Bắt buộc. Khoá bí mật do GenerateSecret trả về.
encoded_secret

string

Bắt buộc. Mã thông báo Web JSON được ký bằng khoá riêng tư CPI. Tải trọng phải bao gồm một khai báo "secret" có giá trị là khoá bí mật.

ValidateInstallerResponse

Câu trả lời cho ValidateInstaller.