Package spectrum.sas.portal.v1alpha1

Chỉ mục

Khách hàng

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

Nhận khách hàng

rpc GetCustomer(GetCustomerRequest) returns (Customer)

Trả về 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
Danh sách khách hàng

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
Cập nhật khách hàng

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

Trình quản lý thiết bị

Dịch vụ quản lý các thiết bị dịch vụ vô tuyến băng thông của công dân.

Triển khai

rpc CreateDeployment(CreateDeploymentRequest) returns (Deployment)

Tạo một 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
Tạo thiết bị

rpc CreateDevice(CreateDeviceRequest) returns (Device)

Tạo 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 một 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
Tạo thiết bị đã ký

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
Xóa triển khai

rpc DeleteDeployment(DeleteDeploymentRequest) returns (Empty)

Xoá deployment.

Phạm vi cấp phép

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

  • https://www.googleapis.com/auth/userinfo.email
Xóa thiết bị

rpc DeleteDevice(DeleteDeviceRequest) returns (Empty)

Xoá device.

Phạm vi cấp phép

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

  • https://www.googleapis.com/auth/userinfo.email
Xóa nút

rpc DeleteNode(DeleteNodeRequest) returns (Empty)

Xoá node.

Phạm vi cấp phép

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

  • https://www.googleapis.com/auth/userinfo.email
Tạo mật khẩu

rpc GenerateSecret(GenerateSecretRequest) returns (GenerateSecretResponse)

Tạo một mã thông báo 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
Triển khai

rpc GetDeployment(GetDeploymentRequest) returns (Deployment)

Trả về 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
Tải thiết bị

rpc GetDevice(GetDeviceRequest) returns (Device)

Nhận thông tin chi tiết về device.

Phạm vi cấp phép

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

  • https://www.googleapis.com/auth/userinfo.email
Nhận nút

rpc GetNode(GetNodeRequest) returns (Node)

Trả về 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
Triển khai List

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
Danh sách thiết bị

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
Triển khai di chuyển

rpc MoveDeployment(MoveDeploymentRequest) returns (Operation)

Di chuyển deployment dưới 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
Di chuyển thiết bị

rpc MoveDevice(MoveDeviceRequest) returns (Operation)

Di chuyển device dưới 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
Nút Di chuyển

rpc MoveNode(MoveNodeRequest) returns (Operation)

Di chuyển node dưới 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
Thiết bị ký hiệu

rpc SignDevice(SignDeviceRequest) returns (Empty)

Ký device.

Phạm vi cấp phép

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

  • https://www.googleapis.com/auth/userinfo.email
Triển khai

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
Cập nhật thiết bị

rpc UpdateDevice(UpdateDeviceRequest) returns (Device)

Cập nhậ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
Cập nhật thiết bị đã ký

rpc UpdateSignedDevice(UpdateSignedDeviceRequest) returns (Device)

Cập nhậ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
Xác thực trình cài đặt

rpc ValidateInstaller(ValidateInstallerRequest) returns (ValidateInstallerResponse)

Xác thực danh tính của một Người cài đặt chuyên nghiệp đượ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

Dịch vụ chính sách

Truy cập Dịch vụ kiểm soát vào Trình quản lý tài nguyên phổ.

Nhận chính sách

rpc GetPolicy(GetPolicyRequest) returns (Policy)

Nhận chính sách kiểm soát quyền truy cập cho một tài nguyên. Trả về chính sách trống nếu tài nguyên tồn tại và chưa đặt chính sách.

Phạm vi cấp phép

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

  • https://www.googleapis.com/auth/userinfo.email
Chính sách đã đặt

rpc SetPolicy(SetPolicyRequest) returns (Policy)

Đặt chính sách kiểm soát quyền truy cập vào tài nguyên đã 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
Quyền kiểm thử

rpc TestPermissions(TestPermissionsRequest) returns (TestPermissionsResponse)

Trả về các quyền mà một phương thức gọi có trên tài nguyên đã 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

Bài tập

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

Các trường
role

string

Bắt buộc. Vai trò được gán cho members.
members[]

string

Danh tính được chỉ định cho vai trò này. 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.

Chế độ thanh toán

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

Enum
BILLING_MODE_UNSPECIFIED Bạn chưa chỉ định phương thức thanh toán.
MOBILE Giá dựa trên danh mục của CBSD: Danh mục A, Danh mục B được đăng ký với SAS.
FIXED_WIRELESS Giá dựa trên loại CBSD: Trạm cơ sở hoặc CPE.

Loại kênh

Enum
CHANNEL_TYPE_UNSPECIFIED
CHANNEL_TYPE_GAA
CHANNEL_TYPE_PAL

CreateDeploymentRequest

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

Các trường
parent

string

Bắt buộc. Tên tài nguyên gốc dùng để tạo quá trình triển khai.
deployment

Deployment

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

Tạo thiết bị

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

Các trường
parent

string

Bắt buộc. Tên của tài nguyên mẹ.
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 cho fcc_id và serial_number. Trường user_id phải được đặt.

Tạo nút yêu cầu

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

Các trường
parent

string

Bắt buộc. Tên tài nguyên mẹ tạo nút.
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.

Tạo thiết bị đã ký

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

Các trường
parent

string

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

bytes

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

string

Bắt buộc. Id trình cài đặt duy nhất (CPI ID) từ cơ sở dữ liệu Trình cài đặt chuyên nghiệp được chứng nhận.

Khách hàng

Pháp nhân đại diện cho một khách hàng SAS.

Các trường
name

string

Chỉ đầ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 khách hàng mà các thiết bị của khách hàng này sử dụng.

Delete tiênRequest

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

Các trường
name

string

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

Xóa thiết bị yêu cầu

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

Các trường
name

string

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

Xóa nút yêu cầu

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

Các trường
name

string

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

Triển khai

Triển khai.

Các trường
name

string

Chỉ đầ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 khách hàng mà các thiết bị thuộc phạm vi triển khai này sử dụng. Mỗi hoạt động triển khai phải được liên kết với một mã nhận dạng người dùng riêng biệt.
default_billing_mode

BillingMode

Chế độ thanh toán mặc định cho quá trình triển khai và các thiết bị trong phương thức đó.
allowed_billing_modes[]

BillingMode

Các chế độ thanh toán được phép trong phương thức triển khai này.

Thiết bị

Các trường
name

string

Chỉ đầ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 được nhà sản xuất thiết bị gán cho thiết bị.
preloaded_config

DeviceConfig

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

DeviceConfig

Chỉ đầ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ỉ đầu ra. Trạng thái thiết bị.
grants[]

DeviceGrant

Chỉ đầu ra. Số tiền mà thiết bị giữ lại.
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ả Yêu cầu đăng ký SAS và yêu cầu đăng ký SAS 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 chỉ định.
RESERVED Tuy nhiên, thiết bị được tạo trong Cổng SAS nhưng chưa đăng ký với SAS.
REGISTERED Thiết bị đã đăng ký với SAS.
DEREGISTERED Đã hủy đăng ký thiết bị bằng SAS.

DeviceAirInterface

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

Các trường
radio_technology

RadioTechnology

Điều kiện. Trường này chỉ định công nghệ truy cập sóng vô tuyến 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 thông số kỹ thuật của giao diện hàng không mà CBSD tuân thủ tại thời điểm đăng ký.

Công nghệ bức xạ

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

Danh mục thiết bị

Danh mục FCC của thiết bị, theo định nghĩa trong Phần 96.

Enum
DEVICE_CATEGORY_UNSPECIFIED Danh mục thiết bị chưa được chỉ định.
DEVICE_CATEGORY_A Danh mục A.
DEVICE_CATEGORY_B Loại B.

Cấu hình thiết bị

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

Các trường
category

DeviceCategory

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

DeviceModel

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

DeviceAirInterface

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

InstallationParams

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

Dấu hiệu gọi của toán tử thiết bị.
state

State

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

BoolValue

Chỉ đầu ra. Liệu cấu hình có được ký bằng CPI hay không.
update_time

Timestamp

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

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à sự uỷ quyền do Hệ thống truy cập phổ tần cấp cho thiết bị truyền bằng cách sử dụng các tham số hoạt động được chỉ định sau khi thiết bị đã nhận được nhịp tim.

Các trường
max_eirp

DoubleValue

Công suất bức xạ tương đương tối đa (EIRP) tương đương được phép theo phạm vi cấp. EIRP tối đa tính bằng đơn vị dBm/MHz. Giá trị của maxEirp thể hiện 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

Dải tần số truyền.
state

GrantState

Trạng thái của khoản tài trợ.
channel_type

ChannelType

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

DpaMoveList

Di chuyển DPA sẽ liệt kê danh sách cấp này.
expire_time

Timestamp

Thời gian hết hạn của khoản tài trợ.
suspension_reason[]

string

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

string

Mã tài trợ.

Siêu dữ liệu của thiết bị

Dữ liệu thiết bị có thể ghi đè bằng cả Cổng thông tin SAS và yêu cầu đăng ký.

Mẫu thiết bị

Thông tin về kiểu thiết bị.

Các trường
vendor

string

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

string

Tên 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ị.

Danh sách DpaMove

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

Các trường
dpa_id

StringValue

Mã của Cơ quan bảo vệ dữ liệu.
frequency_range

FrequencyRange

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

Tần số

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

Các trường
low_frequency_mhz

DoubleValue

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

DoubleValue

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

Tạo yêu cầu mật khẩu

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

CreatePhản hồi

Câu trả lời cho GenerateSecret.

Các trường
secret

string

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

Nhận khách hàng yêu cầu

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

Các trường
name

string

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

Triển khai GetRequest

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

Các trường
name

string

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

Nhận thiết bị

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

Các trường
name

string

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

Nhận nút yêu cầu

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

Các trường
name

string

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

Nhận chính sách

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

Các trường
resource

string

Bắt buộc. Tài nguyên mà chính sách đang được yêu cầu.

Trạng thái Grant

Trạng thái của khoản tài trợ.

Enum
GRANT_STATE_UNSPECIFIED
GRANT_STATE_GRANTED Đã cấp quyền nhưng thiết bị không tạo nhịp.
GRANT_STATE_TERMINATED SAS đã chấm dứt khoản tài trợ này.
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.
GRANT_STATE_EXPIRED Ưu đãi này đã hết hạn.

Loại chiều cao

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

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

Thông số cài đặt

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

Các trường
latitude

DoubleValue

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

DoubleValue

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

DoubleValue

Chiều cao ăng ten thiết bị tính theo mét. Khi giá trị thông số heightType là "AGL", chiều cao của ăng ten phải được cung cấp tương ứng với mặt đất. Khi giá trị tham số heightType là "AMSL", thì giá trị đó được cung cấp tương ứng với dữ liệu WGS84.
height_type

HeightType

Xác đị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 trên ăng-ten của thiết bị. Bạn chỉ được hiển thị thông số không bắt buộc này nếu giá trị của thông số này thấp hơn yêu cầu về 50 mét của FCC.
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ị. Thông số tùy chọn này chỉ nên hiển thị nếu giá trị của thông số này thấp 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 nhìn ra mặt phẳng của ăng-ten ngang theo độ theo hướng Bắc thực tế. 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à đúng về phía Bắc; giá trị 90 độ có nghĩa là phía đông. Bạn không bắt buộc phải sử dụng thông số này cho thiết bị Danh mục A và điều kiện cho các thiết bị Danh mục B.
antenna_downtilt

Int32Value

Ăng-ten quay sang độ theo độ và là một số nguyên có giá trị từ -90 đến +90; giá trị âm có nghĩa là ăng-ten bị nghiêng (lên trên chiều ngang). Bạn không bắt buộc phải sử dụng thông số này cho thiết bị Danh mục A và điều kiện cho các thiết bị Danh mục B.
antenna_gain

Int32Value

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

Int32Value

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

Int32Value

Chiều rộng ăng-ten 3 dB của ăng-ten theo mặt phẳng ngang theo độ. Tham số này là một số nguyên không dấu có giá trị từ 0 đến 360 (độ). Thông số này 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_model

string

Nếu bạn sử dụng ăng-ten bên ngoài, thì tùy chọn trường ăng-ten này được cung cấp 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ó, thông số này sẽ chỉ định CBSD có phải là CPE-CBSD hay không.

ListCustomerRequest

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

Các trường
page_size

int32

Số 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ừ lệnh gọi trước đó đến ListCustomers cho biết vị trí tiếp tục của trang thông tin này.

ListCustomerResponse

Câu trả lời cho ListCustomers.

Các trường
customers[]

Customer

Danh sách customers 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ừ lệnh gọi trước đó đến ListCustomers cho biết vị trí tiếp tục trang thông tin. Nếu trường bị thiếu hoặc để trống thì có nghĩa là không có khách hàng nào khác.

ListDeploymentsRequest

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

Các trường
parent

string

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

int32

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

string

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

string

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

ListDeploymentsResponse

Câu trả lời cho ListDeployments.

Các 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ừ lệnh gọi trước đó đến ListDeployments cho biết vị trí tiếp tục trang thông tin. Nếu trường bị thiếu hoặc để trống, thì có nghĩa là bạn không cần triển khai thêm nữa.

ListDevicesRequest

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

Các trường
parent

string

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

int32

Số thiết bị tối đa được trả về trong phản hồi. Nếu trống hoặc không có, tất cả các thiết bị sẽ được liệt kê. 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ừ lệnh gọi trước đó đến ListDevices cho biết vị trí tiếp tục của trang thông tin này.
filter

string

Biểu thức 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 không phân biệt chữ hoa chữ thường.

ListDevicesResponse

Câu trả lời cho ListDevices.

Các 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ừ lệnh gọi trước đó đến ListDevices cho biết vị trí tiếp tục trang thông tin. Nếu trường bị thiếu hoặc bị trống, có nghĩa là không có thiết bị nào khác.

ListNodesRequest

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

Các trường
parent

string

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

int32

Số 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ừ lệnh gọi trước đó đến ListNodes cho biết vị trí tiếp tục của trang thông tin này.
filter

string

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

ListNodesResponse

Câu trả lời cho ListNodes.

Các 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ừ lệnh gọi trước đó đến ListNodes cho biết vị trí tiếp tục trang thông tin. Nếu trường bị thiếu hoặc để trống, có nghĩa là không có nút nào khác.

Khả năng đo lường

Khả năng đo lường thiết bị. Các giá trị được xác định bởi 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.

Các 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 gốc mới node hoặc customer để đặt lại thư mục triển khai này.

Yêu cầu chuyển thiết bị

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

Các 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 gốc mới node hoặc customer để đặt lại tên thiết bị ở bên dưới.

Di chuyển nútRequest

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

Các 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 để đặt lại nút này thành nút gốc.

Nút

Nút.

Các trường
name

string

Chỉ đầ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ã nhận dạng khách hàng mà các thiết bị thuộc về nút này sử dụng.

Chính sách

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

Các trường
assignments[]

Assignment

Danh sách assignments
etag

bytes

Enum được sử dụng để kiểm soát đồ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 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ập nhật chính sách để tránh các tình huống tương tranh: E bị trả về trong phản hồi GetPolicy và các hệ thống dự kiến sẽ đặt etag đó vào 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 chính sách.

Nếu không có etag nào được cung cấp trong lệnh gọi GetPolicy, thì chính sách hiện tại 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.

Các 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 thay thế mọi chính sách hiện có.
policy

Policy

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

Yêu cầu thiết bị ký

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

Các 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. Trường user_id phải được đặt.

TestPermissionsRequest

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

Các trường
resource

string

Bắt buộc. Tài nguyên mà các quyền đang được yêu cầu.
permissions[]

string

Tập hợp các quyền để kiểm tra resource.

Phản hồi quyền

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

Các trường
permissions[]

string

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

Cập nhật yêu cầu khách hàng

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

Các 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.

Các 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.

Cập nhật thiết bị yêu cầu

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

Các trường
device

Device

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

FieldMask

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

UpdateNodeRequest

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

Các 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.

Các 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 khóa cá nhân CPI. Dung lượng phải là mã hoá JSON của device. Trường user_id phải được đặt.
installer_id

string

Bắt buộc. Mã trình cài đặt duy nhất (CPI ID) từ cơ sở dữ liệu Trình cài đặt chuyên nghiệp được chứng nhận.

Xác thực trình cài đặt

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

Các trường
installer_id

string

Bắt buộc. Id trình cài đặt duy nhất (CPI ID) từ cơ sở dữ liệu Trình cài đặt chuyên nghiệp được chứng nhận.
secret

string

Bắt buộc. GenerateSecret đã trả về khóa bí mật.
encoded_secret

string

Bắt buộc. Mã thông báo Web JSON được ký bằng khóa riêng tư CPI. Trọng tải phải bao gồm "bí mật" xác nhận quyền sở hữu có giá trị là bí mật.

ValidationInstallerResponse

Câu trả lời cho ValidateInstaller.