Package spectrum.sas.portal.v1alpha1

فهرست مطالب

مشتریان

خدمات مدیریت مشتریان SAS.

دریافت مشتری

rpc GetCustomer( GetCustomerRequest ) returns ( Customer )

customer درخواستی را برمی گرداند.

محدوده مجوز

به محدوده OAuth زیر نیاز دارد:

  • https://www.googleapis.com/auth/userinfo.email
لیست مشتریان

rpc ListCustomers( ListCustomersRequest ) returns ( ListCustomersResponse )

لیستی از customers درخواست شده را برمی گرداند.

محدوده مجوز

به محدوده OAuth زیر نیاز دارد:

  • https://www.googleapis.com/auth/userinfo.email
به روز رسانی مشتری

rpc UpdateCustomer( UpdateCustomerRequest ) returns ( Customer )

یک customer موجود را به روز می کند.

محدوده مجوز

به محدوده OAuth زیر نیاز دارد:

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

مدیریت دستگاه

خدمات مدیریت دستگاه های خدمات رادیویی باند پهن شهروندان.

CreateDeployment

rpc CreateDeployment( CreateDeploymentRequest ) returns ( Deployment )

یک deployment جدید ایجاد می کند.

محدوده مجوز

به محدوده OAuth زیر نیاز دارد:

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

rpc CreateDevice( CreateDeviceRequest ) returns ( Device )

device تحت یک node یا customer ایجاد می کند.

محدوده مجوز

به محدوده OAuth زیر نیاز دارد:

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

rpc CreateNode( CreateNodeRequest ) returns ( Node )

یک node جدید ایجاد می کند.

محدوده مجوز

به محدوده OAuth زیر نیاز دارد:

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

rpc CreateSignedDevice( CreateSignedDeviceRequest ) returns ( Device )

یک device امضا شده در زیر یک node یا customer ایجاد می کند.

محدوده مجوز

به محدوده OAuth زیر نیاز دارد:

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

rpc DeleteDeployment( DeleteDeploymentRequest ) returns ( Empty )

یک deployment را حذف می کند.

محدوده مجوز

به محدوده OAuth زیر نیاز دارد:

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

rpc DeleteDevice( DeleteDeviceRequest ) returns ( Empty )

یک device را حذف می کند.

محدوده مجوز

به محدوده OAuth زیر نیاز دارد:

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

rpc DeleteNode( DeleteNodeRequest ) returns ( Empty )

یک node را حذف می کند.

محدوده مجوز

به محدوده OAuth زیر نیاز دارد:

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

rpc GenerateSecret( GenerateSecretRequest ) returns ( GenerateSecretResponse )

یک راز برای استفاده با ValidateInstaller ایجاد می کند.

محدوده مجوز

به محدوده OAuth زیر نیاز دارد:

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

rpc GetDeployment( GetDeploymentRequest ) returns ( Deployment )

deployment درخواستی را برمی گرداند.

محدوده مجوز

به محدوده OAuth زیر نیاز دارد:

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

rpc GetDevice( GetDeviceRequest ) returns ( Device )

جزئیات یک device دریافت می کند.

محدوده مجوز

به محدوده OAuth زیر نیاز دارد:

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

rpc GetNode( GetNodeRequest ) returns ( Node )

یک node درخواستی را برمی گرداند.

محدوده مجوز

به محدوده OAuth زیر نیاز دارد:

  • https://www.googleapis.com/auth/userinfo.email
لیست استقرارها

rpc ListDeployments( ListDeploymentsRequest ) returns ( ListDeploymentsResponse )

deployments را فهرست می کند.

محدوده مجوز

به محدوده OAuth زیر نیاز دارد:

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

rpc ListDevices( ListDevicesRequest ) returns ( ListDevicesResponse )

devices ها را تحت یک node یا customer فهرست می کند.

محدوده مجوز

به محدوده OAuth زیر نیاز دارد:

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

rpc ListNodes( ListNodesRequest ) returns ( ListNodesResponse )

nodes را فهرست می کند.

محدوده مجوز

به محدوده OAuth زیر نیاز دارد:

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

rpc MoveDeployment( MoveDeploymentRequest ) returns ( Operation )

یک deployment را به node یا customer دیگری منتقل می کند.

محدوده مجوز

به محدوده OAuth زیر نیاز دارد:

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

rpc MoveDevice( MoveDeviceRequest ) returns ( Operation )

یک device به node یا customer دیگری منتقل می کند.

محدوده مجوز

به محدوده OAuth زیر نیاز دارد:

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

rpc MoveNode( MoveNodeRequest ) returns ( Operation )

یک node را به زیر node یا customer دیگر منتقل می کند.

محدوده مجوز

به محدوده OAuth زیر نیاز دارد:

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

rpc SignDevice( SignDeviceRequest ) returns ( Empty )

device امضا می کند.

محدوده مجوز

به محدوده OAuth زیر نیاز دارد:

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

rpc UpdateDeployment( UpdateDeploymentRequest ) returns ( Deployment )

یک deployment موجود را به روز می کند.

محدوده مجوز

به محدوده OAuth زیر نیاز دارد:

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

rpc UpdateDevice( UpdateDeviceRequest ) returns ( Device )

یک device به روز می کند.

محدوده مجوز

به محدوده OAuth زیر نیاز دارد:

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

rpc UpdateNode( UpdateNodeRequest ) returns ( Node )

یک node موجود را به روز می کند.

محدوده مجوز

به محدوده OAuth زیر نیاز دارد:

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

rpc UpdateSignedDevice( UpdateSignedDeviceRequest ) returns ( Device )

device امضا شده را به روز می کند.

محدوده مجوز

به محدوده OAuth زیر نیاز دارد:

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

rpc ValidateInstaller( ValidateInstallerRequest ) returns ( ValidateInstallerResponse )

هویت یک نصب کننده حرفه ای معتبر (CPI) را تأیید می کند.

محدوده مجوز

به محدوده OAuth زیر نیاز دارد:

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

Policy Service

سرویس کنترل دسترسی به مدیر منابع طیف.

GetPolicy

rpc GetPolicy( GetPolicyRequest ) returns ( Policy )

خط مشی کنترل دسترسی یک منبع را دریافت می کند. اگر منبع وجود داشته باشد و مجموعه ای از خط مشی نداشته باشد، یک خط مشی خالی را برمی گرداند.

محدوده مجوز

به محدوده OAuth زیر نیاز دارد:

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

rpc SetPolicy( SetPolicyRequest ) returns ( Policy )

خط مشی کنترل دسترسی را روی منبع مشخص شده تنظیم می کند. هر خط مشی موجود را جایگزین می کند.

محدوده مجوز

به محدوده OAuth زیر نیاز دارد:

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

rpc TestPermissions( TestPermissionsRequest ) returns ( TestPermissionsResponse )

مجوزهایی را که تماس گیرنده در منبع مشخص شده دارد، برمی گرداند.

محدوده مجوز

به محدوده OAuth زیر نیاز دارد:

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

وظیفه

members با یک role می کند.

زمینه های
role

string

ضروری. نقشی که به members می شود.

members[]

string

هویت هایی که نقش به آنها اختصاص داده شده است. می تواند مقادیر زیر را داشته باشد:

  • {user_email} : آدرس ایمیلی که نمایانگر یک حساب Google خاص است. به عنوان مثال: alice@gmail.com .

  • {group_email} : یک آدرس ایمیل که نشان دهنده یک گروه Google است. به عنوان مثال، viewers@gmail.com .

حالت صورتحساب

حالت صورتحساب یک CBSD

Enums
BILLING_MODE_UNSPECIFIED حالت صورتحساب مشخص نشده است.
MOBILE قیمت بر اساس دسته CBSD است: رده A، رده B ثبت شده در SAS.
FIXED_WIRELESS قیمت بر اساس نوع CBSD است: ایستگاه پایه یا CPE.

نوع کانال

Enums
CHANNEL_TYPE_UNSPECIFIED
CHANNEL_TYPE_GAA
CHANNEL_TYPE_PAL

CreateDeploymentRequest

درخواست CreateDeployment .

زمینه های
parent

string

ضروری. نام منبع والد که در آن استقرار قرار است ایجاد شود.

deployment

Deployment

ضروری. جزئیات استقرار name باید خالی باشد. توسط سرور تولید می شود. Deployment display_name باید تنظیم شود.

CreateDeviceRequest

درخواست CreateDevice .

زمینه های
parent

string

ضروری. نام منبع والد.

device

Device

جزئیات ثبت device name باید خالی باشد. توسط سرور تولید می شود. فیلدهای device fcc_id و serial_number باید تنظیم شوند. فیلد user_id باید تنظیم شود.

CreateNodeRequest

درخواست CreateNode .

زمینه های
parent

string

ضروری. نام منبع والد که در آن گره قرار است ایجاد شود.

node

Node

جزئیات گره name باید خالی باشد. توسط سرور تولید می شود. گره display_name باید تنظیم شود.

CreateSignedDeviceRequest

درخواست CreateSignedDevice .

زمینه های
parent

string

ضروری. نام منبع والد.

encoded_device

bytes

ضروری. JSON Web Token با استفاده از کلید خصوصی CPI امضا شد. Payload باید رمزگذاری JSON device باشد. فیلد user_id باید تنظیم شود.

installer_id

string

ضروری. شناسه نصب‌کننده منحصر به فرد (CPI ID) از پایگاه‌داده Certified Professional Installers.

مشتری

نهادی که نماینده یک مشتری SAS است.

زمینه های
name

string

فقط خروجی نام منبع مشتری

display_name

string

ضروری. نام سازمانی که نهاد مشتری نماینده آن است.

sas_user_ids[]

string

شناسه های کاربری استفاده شده توسط دستگاه های متعلق به این مشتری.

DeleteDeploymentRequest

درخواست DeleteDeployment .

زمینه های
name

string

ضروری. نام deployment .

DeleteDeviceRequest

درخواست DeleteDevice .

زمینه های
name

string

ضروری. نام دستگاه.

DeleteNodeRequest

درخواست DeleteNode .

زمینه های
name

string

ضروری. نام node .

گسترش

استقرار.

زمینه های
name

string

فقط خروجی نام منبع.

display_name

string

نام نمایشی استقرار

sas_user_ids[]

string

شناسه کاربری استفاده شده توسط دستگاه های متعلق به این استقرار. هر استقرار باید با یک شناسه کاربری منحصر به فرد مرتبط باشد.

default_billing_mode

BillingMode

حالت صورت‌حساب پیش‌فرض برای استقرار و دستگاه‌های تحت آن.

allowed_billing_modes[]

BillingMode

حالت‌های صورت‌حساب مجاز تحت این استقرار.

دستگاه

زمینه های
name

string

فقط خروجی نام مسیر منبع

fcc_id

string

شناسه FCC دستگاه.

serial_number

string

شماره سریالی که توسط سازنده دستگاه به دستگاه اختصاص داده شده است.

preloaded_config

DeviceConfig

پیکربندی دستگاه، همانطور که از طریق SAS Portal API مشخص شده است.

active_config

DeviceConfig

فقط خروجی پیکربندی فعلی دستگاه همانطور که در SAS ثبت شده است.

state

State

فقط خروجی وضعیت دستگاه

grants[]

DeviceGrant

فقط خروجی کمک های مالی که توسط دستگاه نگهداری می شود.

display_name

string

نام نمایشی دستگاه

device_metadata

DeviceMetadata

پارامترهای دستگاهی که می‌توانند با درخواست‌های ثبت نام SAS و پورتال SAS لغو شوند.

دولت

وضعیت دستگاه

Enums
DEVICE_STATE_UNSPECIFIED وضعیت نامشخص
RESERVED با این حال، دستگاه ایجاد شده در پورتال SAS هنوز در SAS ثبت نشده است.
REGISTERED دستگاه ثبت شده در SAS.
DEREGISTERED دستگاه با SAS لغو ثبت شد.

DeviceAirInterface

اطلاعاتی در مورد رابط هوای دستگاه.

زمینه های
radio_technology

RadioTechnology

مشروط این فیلد فناوری دسترسی رادیویی مورد استفاده برای CBSD را مشخص می کند.

supported_spec

string

اختیاری. این زمینه به radioTechnology مربوط می شود و مشخصات رابط هوایی را ارائه می دهد که CBSD در زمان ثبت با آن مطابقت دارد.

رادیوتکنولوژی

انواع تایید شده فناوری دسترسی رادیویی

Enums
RADIO_TECHNOLOGY_UNSPECIFIED
E_UTRA
CAMBIUM_NETWORKS
FOUR_G_BBW_SAA_1
NR
DOODLE_CBRS
CW
REDLINE
TARANA_WIRELESS

دسته دستگاه

دسته FCC دستگاه، همانطور که در قسمت 96 تعریف شده است.

Enums
DEVICE_CATEGORY_UNSPECIFIED دسته دستگاه نامشخص
DEVICE_CATEGORY_A دسته A.
DEVICE_CATEGORY_B دسته B.

DeviceConfig

اطلاعات مربوط به پیکربندی دستگاه

زمینه های
category

DeviceCategory

دسته FCC دستگاه.

model

DeviceModel

اطلاعاتی در مورد این مدل دستگاه

air_interface

DeviceAirInterface

اطلاعاتی در مورد رابط هوایی این دستگاه.

installation_params

InstallationParams

پارامترهای نصب برای دستگاه

measurement_capabilities[]

MeasurementCapability

قابلیت های گزارش اندازه گیری دستگاه.

user_id

StringValue

شناسه یک کاربر دستگاه.

call_sign

string

علامت تماس اپراتور دستگاه.

state

State

وضعیت پیکربندی

is_signed

BoolValue

فقط خروجی آیا پیکربندی توسط یک CPI امضا شده است یا خیر.

update_time

Timestamp

فقط خروجی آخرین باری که پیکربندی دستگاه ویرایش شد.

دولت

وضعیت پیکربندی دستگاه فقط تنظیمات در حالت DEVICE_CONFIG_STATE_FINAL را می توان در طول ثبت نام CBSD استفاده کرد.

Enums
DEVICE_CONFIG_STATE_UNSPECIFIED
DRAFT
FINAL

DeviceGrant

کمک هزینه دستگاه این مجوزی است که توسط «سیستم دسترسی طیف» به دستگاهی برای انتقال با استفاده از پارامترهای عملیاتی مشخص شده پس از ضربان قلب موفقیت‌آمیز دستگاه ارائه می‌شود.

زمینه های
max_eirp

DoubleValue

حداکثر توان تابشی معادل همسانگردی (EIRP) که توسط کمک هزینه مجاز است. حداکثر EIRP بر حسب واحد dBm/MHz است. مقدار maxEirp نشان دهنده میانگین (RMS) EIRP است که با روش تعریف شده در FCC قسمت 96.41(e)(3) اندازه گیری می شود.

frequency_range

FrequencyRange

محدوده فرکانس انتقال

state

GrantState

وضعیت کمک هزینه

channel_type

ChannelType

نوع کانال استفاده شده

move_list[]

DpaMoveList

جابجایی DPA لیست هایی را که این کمک مالی در آنها نشان داده می شود.

expire_time

Timestamp

زمان انقضای کمک هزینه.

suspension_reason[]

string

اگر کمک مالی به حالت تعلیق درآمد، دلیل یا دلایل تعلیق.

grant_id

string

شناسه اعطا

Metadata دستگاه

داده های دستگاه قابل رد شدن توسط SAS Portal و درخواست های ثبت نام است.

مدل دستگاه

اطلاعاتی در مورد مدل دستگاه

زمینه های
vendor

string

نام فروشنده دستگاه

name

string

نام مدل دستگاه

software_version

string

نسخه نرم افزاری دستگاه.

hardware_version

string

نسخه سخت افزاری دستگاه

firmware_version

string

نسخه سیستم عامل دستگاه.

DpaMoveList

یک ورودی در لیست حرکت DPA.

زمینه های
dpa_id

StringValue

شناسه DPA

frequency_range

FrequencyRange

محدوده فرکانسی که لیست حرکت بر آن تأثیر می گذارد.

محدوده فرکانس

محدوده فرکانس از low_frequency تا high_frequency .

زمینه های
low_frequency_mhz

DoubleValue

کمترین فرکانس محدوده فرکانس بر حسب مگاهرتز.

high_frequency_mhz

DoubleValue

بالاترین فرکانس محدوده فرکانس بر حسب مگاهرتز.

GenerateSecretRequest

درخواست GenerateSecret .

GenerateSecretResponse

پاسخ برای GenerateSecret .

زمینه های
secret

string

راز ایجاد شده توسط رشته و استفاده شده توسط ValidateInstaller .

GetCustomerRequest

درخواست GetCustomer .

زمینه های
name

string

ضروری. نام customer .

GetDeploymentRequest

درخواست GetDeployment .

زمینه های
name

string

ضروری. نام deployment .

GetDeviceRequest

درخواست GetDevice .

زمینه های
name

string

ضروری. نام دستگاه.

GetNodeRequest

درخواست GetNode .

زمینه های
name

string

ضروری. نام node .

GetPolicyRequest

درخواست پیام برای روش GetPolicy .

زمینه های
resource

string

ضروری. منبعی که سیاست برای آن درخواست شده است.

Grant State

وضعیت کمک هزینه.

Enums
GRANT_STATE_UNSPECIFIED
GRANT_STATE_GRANTED کمک مالی داده شده است اما دستگاه روی آن ضربان ندارد.
GRANT_STATE_TERMINATED کمک مالی توسط SAS فسخ شده است.
GRANT_STATE_SUSPENDED کمک مالی توسط SAS به حالت تعلیق درآمده است.
GRANT_STATE_AUTHORIZED دستگاه در حال حاضر در حال انتقال است.
GRANT_STATE_EXPIRED کمک هزینه به پایان رسیده است.

نوع ارتفاع

نحوه اندازه گیری ارتفاع را مشخص می کند.

Enums
HEIGHT_TYPE_UNSPECIFIED نوع ارتفاع نامشخص
HEIGHT_TYPE_AGL ارتفاع AGL نسبت به سطح زمین اندازه گیری می شود.
HEIGHT_TYPE_AMSL ارتفاع AMSL نسبت به سطح متوسط ​​دریا اندازه گیری می شود.

نصب پارامز

اطلاعات مربوط به پارامترهای نصب دستگاه

زمینه های
latitude

DoubleValue

عرض جغرافیایی محل آنتن دستگاه بر حسب درجه نسبت به داده WGS 84. محدوده مجاز از -90.000000 تا +90.000000 است. مقادیر مثبت نشان دهنده عرض های جغرافیایی شمال استوا است. مقادیر منفی در جنوب خط استوا

longitude

DoubleValue

طول جغرافیایی محل آنتن دستگاه بر حسب درجه نسبت به داده WGS 84. محدوده مجاز از -180.000000 تا +180.000000 است. مقادیر مثبت نشان دهنده طول های شرقی از نصف النهار اول است. مقادیر منفی در غرب نصف النهار اول.

height

DoubleValue

ارتفاع آنتن دستگاه بر حسب متر هنگامی که مقدار پارامتر heightType "AGL" است، ارتفاع آنتن باید نسبت به سطح زمین داده شود. هنگامی که مقدار پارامتر heightType "AMSL" است، با توجه به داده WGS84 داده می شود.

height_type

HeightType

نحوه اندازه گیری ارتفاع را مشخص می کند.

horizontal_accuracy

DoubleValue

عدد مثبت بر حسب متر برای نشان دادن دقت موقعیت افقی آنتن دستگاه. این پارامتر اختیاری تنها در صورتی باید وجود داشته باشد که مقدار آن کمتر از 50 متر مورد نیاز FCC باشد.

vertical_accuracy

DoubleValue

عدد مثبت بر حسب متر برای نشان دادن دقت موقعیت عمودی آنتن دستگاه. این پارامتر اختیاری فقط در صورتی باید وجود داشته باشد که مقدار آن کمتر از FCC مورد نیاز 3 متر باشد.

indoor_deployment

BoolValue

آیا آنتن دستگاه در محیط داخلی است یا نه. true : سرپوشیده false : در فضای باز.

antenna_azimuth

Int32Value

جهت دید باریکه صفحه افقی آنتن بر حسب درجه شمال واقعی. مقدار این پارامتر یک عدد صحیح با مقداری بین 0 تا 359 می باشد. مقدار 0 درجه به معنای شمال واقعی است. مقدار 90 درجه به معنای شرق است. این پارامتر برای دستگاه های رده A اختیاری و برای دستگاه های رده B مشروط است.

antenna_downtilt

Int32Value

رو به پایین آنتن بر حسب درجه و یک عدد صحیح با مقدار بین 90- و 90+ است. یک مقدار منفی به این معنی است که آنتن به سمت بالا متمایل شده است (بالای افقی). این پارامتر برای دستگاه های رده A اختیاری و برای دستگاه های رده B مشروط است.

antenna_gain

Int32Value

حداکثر افزایش آنتن در dBi. این پارامتر یک عدد صحیح با مقداری بین -127 و +128 (dBi) است.

eirp_capability

Int32Value

این پارامتر حداکثر EIRP دستگاه در واحدهای dBm/10MHz است و یک عدد صحیح با مقدار بین -127 و +47 (dBm/10 MHz) شامل می باشد. اگر شامل نباشد، SAS آن را به عنوان حداکثر مجاز EIRP در واحدهای dBm/10MHz برای دسته دستگاه تفسیر می کند.

antenna_beamwidth

Int32Value

3-dB عرض پرتو آنتن آنتن در صفحه افقی بر حسب درجه. این پارامتر یک عدد صحیح بدون علامت است که دارای مقداری بین 0 تا 360 (درجه) می باشد. برای دستگاه های رده A اختیاری و برای دستگاه های رده B مشروط است.

antenna_model

string

در صورت استفاده از آنتن خارجی، مدل آنتن به صورت اختیاری در این زمینه ارائه می شود. حداکثر طول این رشته 128 اکتت است.

cpe_cbsd_indication

BoolValue

در صورت وجود، این پارامتر مشخص می کند که آیا CBSD یک CPE-CBSD است یا خیر.

لیست مشتریان درخواست

درخواست ListCustomers

زمینه های
page_size

int32

حداکثر تعداد customers برای بازگشت در پاسخ.

page_token

string

یک نشانه صفحه‌بندی که از تماس قبلی با ListCustomers است که نشان می‌دهد این فهرست باید از کجا ادامه یابد.

ListCustomers Response

پاسخ برای ListCustomers .

زمینه های
customers[]

Customer

لیست customers که با درخواست مطابقت دارند.

next_page_token

string

یک نشانه صفحه‌بندی که از تماس قبلی با ListCustomers است که نشان می‌دهد فهرست از کجا باید ادامه یابد. اگر فیلد مفقود یا خالی باشد، به این معنی است که مشتری دیگری وجود ندارد.

ListDeploymentsRequest

درخواست برای ListDeployments .

زمینه های
parent

string

ضروری. نام منبع والد، به عنوان مثال، "nodes/1"، customer/1/nodes/2.

page_size

int32

حداکثر تعداد استقرار برای بازگشت در پاسخ.

page_token

string

یک نشانه صفحه‌بندی که از تماس قبلی به ListDeployments است که نشان می‌دهد این فهرست باید از کجا ادامه یابد.

filter

string

عبارت فیلتر. فیلتر باید فرمت زیر را داشته باشد: "DIRECT_CHILDREN" یا قالب: "direct_children". فیلتر به حروف بزرگ و کوچک حساس است. اگر خالی باشد، هیچ استقراری فیلتر نمی شود.

ListDeploymentsResponse

پاسخ برای ListDeployments .

زمینه های
deployments[]

Deployment

deployments که با درخواست مطابقت دارند.

next_page_token

string

یک نشانه صفحه‌بندی که از تماس قبلی به ListDeployments است که نشان می‌دهد فهرست از کجا باید ادامه یابد. اگر فیلد مفقود یا خالی باشد، به این معنی است که دیگر استقرار وجود ندارد.

ListDevicesRequest

درخواست ListDevices .

زمینه های
parent

string

ضروری. نام منبع والد.

page_size

int32

حداکثر تعداد دستگاه هایی که در پاسخ باید برگردند. اگر خالی یا صفر باشد، همه دستگاه‌ها فهرست می‌شوند. باید در محدوده [0، 1000] باشد.

page_token

string

یک نشانه صفحه‌بندی که از تماس قبلی با ListDevices است که نشان می‌دهد این فهرست باید از کجا ادامه یابد.

filter

string

عبارت فیلتر. فیلتر باید یکی از قالب های زیر را داشته باشد: "sn=123454" یا "display_name=MyDevice". sn مربوط به شماره سریال دستگاه است. فیلتر به حروف بزرگ و کوچک حساس است.

ListDevicesResponse

پاسخ برای ListDevices .

زمینه های
devices[]

Device

devices هایی که با درخواست مطابقت دارند.

next_page_token

string

یک نشانه صفحه‌بندی که از تماس قبلی با ListDevices است که نشان می‌دهد فهرست از کجا باید ادامه یابد. اگر فیلد مفقود یا خالی باشد، به این معنی است که دستگاه دیگری وجود ندارد.

ListNodesRequest

درخواست ListNodes .

زمینه های
parent

string

ضروری. نام منبع والد، به عنوان مثال، "nodes/1".

page_size

int32

حداکثر تعداد گره هایی که باید در پاسخ برگردند.

page_token

string

یک نشانه صفحه‌بندی که از تماس قبلی به ListNodes است که نشان می‌دهد این فهرست باید از کجا ادامه یابد.

filter

string

عبارت فیلتر. فیلتر باید فرمت زیر را داشته باشد: "DIRECT_CHILDREN" یا قالب: "direct_children". فیلتر به حروف بزرگ و کوچک حساس است. اگر خالی باشد، هیچ گره ای فیلتر نمی شود.

ListNodesResponse

پاسخ برای ListNodes .

زمینه های
nodes[]

Node

nodes هایی که با درخواست مطابقت دارند.

next_page_token

string

یک نشانه صفحه‌بندی که از تماس قبلی به ListNodes است که نشان می‌دهد فهرست از کجا باید ادامه یابد. اگر فیلد مفقود یا خالی باشد، به این معنی است که گره دیگری وجود ندارد.

قابلیت اندازه گیری

قابلیت اندازه گیری دستگاه مقادیر توسط WINNF-SSC-0002 تعریف شده اند.

Enums
MEASUREMENT_CAPABILITY_UNSPECIFIED
MEASUREMENT_CAPABILITY_RECEIVED_POWER_WITH_GRANT
MEASUREMENT_CAPABILITY_RECEIVED_POWER_WITHOUT_GRANT

MoveDeploymentRequest

درخواست برای MoveDeployment .

زمینه های
name

string

ضروری. نام deployment برای حرکت.

destination

string

ضروری. نام node یا customer منبع والد جدید که استقرار را تحت آن بازنگری می کند.

MoveDeviceRequest

درخواست MoveDevice .

زمینه های
name

string

ضروری. نام دستگاه برای جابجایی.

destination

string

ضروری. نام node منبع والد جدید یا customer که دستگاه را تحت آن مجدداً آماده می کند.

MoveNodeRequest

درخواست برای MoveNode .

زمینه های
name

string

ضروری. نام node برای حرکت.

destination

string

ضروری. نام node منبع والد جدید یا customer برای بازپرداخت گره زیر.

گره

گره.

زمینه های
name

string

فقط خروجی نام منبع.

display_name

string

نام نمایش گره

sas_user_ids[]

string

شناسه های کاربری که توسط دستگاه های متعلق به این گره استفاده می شود.

خط مشی

یک خط مشی کنترل دسترسی به منابع را تعریف می کند.

زمینه های
assignments[]

Assignment

لیست assignments

etag

bytes

این تگ برای کنترل همزمانی خوشبینانه به عنوان راهی برای کمک به جلوگیری از به‌روزرسانی همزمان یک خط‌مشی از بازنویسی یکدیگر استفاده می‌شود. قویاً پیشنهاد می‌شود که سیستم‌ها از تگ در چرخه خواندن-تغییر-نوشتن برای انجام به‌روزرسانی خط‌مشی استفاده کنند تا از شرایط مسابقه اجتناب کنند: یک برچسب در پاسخ به GetPolicy و انتظار می‌رود سیستم‌ها آن تگ را در از SetPolicy درخواست کنید تا اطمینان حاصل شود که تغییر آنها در همان نسخه خط مشی اعمال خواهد شد.

اگر هیچ برچسبی در تماس با GetPolicy ارائه نشده باشد، خط‌مشی موجود کورکورانه بازنویسی می‌شود.

SetPolicyRequest

درخواست پیام برای روش SetPolicy .

زمینه های
resource

string

ضروری. منبعی که خط مشی برای آن مشخص شده است. این سیاست جایگزین هر خط مشی موجود می شود.

policy

Policy

ضروری. سیاستی که باید در مورد resource اعمال شود.

SignDeviceRequest

درخواست SignDevice .

زمینه های
device

Device

ضروری. device برای امضا. name فیلدهای device ، fcc_id و serial_number باید تنظیم شوند. فیلد user_id باید تنظیم شود.

TestPermissionsRequest

درخواست پیام برای روش TestPermissions .

زمینه های
resource

string

ضروری. منبعی که مجوزها برای آن درخواست شده است.

permissions[]

string

مجموعه ای از مجوزها برای بررسی resource .

TestPermissionsResponse

پیام پاسخ برای روش TestPermissions .

زمینه های
permissions[]

string

مجموعه ای از مجوزهایی که تماس گیرنده مجاز است.

UpdateCustomerRequest

درخواست UpdateCustomer .

زمینه های
customer

Customer

ضروری. ارزش های جدید برای customer مشتری باید name و display_name را داشته باشد.

update_mask

FieldMask

فیلدهایی که باید به روز شوند.

UpdateDeploymentRequest

درخواست UpdateDeployment .

زمینه های
deployment

Deployment

ضروری. مقادیر جدید برای deployment name و display_name باید تنظیم شوند.

update_mask

FieldMask

فیلدهایی که باید به روز شوند.

UpdateDeviceRequest

درخواست UpdateDevice .

زمینه های
device

Device

ضروری. device برای به روز رسانی. name فیلدهای device ، fcc_id و serial_number باید تنظیم شوند. فیلد user_id باید تنظیم شود.

update_mask

FieldMask

فیلدهایی که باید به روز شوند.

UpdateNodeRequest

درخواست UpdateNode .

زمینه های
node

Node

ضروری. مقادیر جدید برای node . name و display_name باید تنظیم شوند.

update_mask

FieldMask

فیلدهایی که باید به روز شوند.

UpdateSignedDeviceRequest

درخواست UpdateSignedDevice .

زمینه های
name

string

ضروری. نام دستگاه برای به روز رسانی.

encoded_device

bytes

ضروری. JSON Web Token با استفاده از کلید خصوصی CPI امضا شد. Payload باید رمزگذاری JSON device باشد. فیلد user_id باید تنظیم شود.

installer_id

string

ضروری. شناسه نصب‌کننده منحصر به فرد (CPI ID) از پایگاه‌داده نصب‌کنندگان حرفه‌ای خبره.

ValidateInstallerRequest

درخواست ValidateInstaller .

زمینه های
installer_id

string

ضروری. شناسه نصب‌کننده منحصر به فرد (CPI ID) از پایگاه‌داده Certified Professional Installers.

secret

string

ضروری. راز بازگردانده شده توسط GenerateSecret .

encoded_secret

string

ضروری. JSON Web Token با استفاده از کلید خصوصی CPI امضا شد. محموله باید شامل یک ادعای "محرمانه" باشد که ارزش آن راز است.

ValidateInstallerResponse

پاسخ برای ValidateInstaller .