Package spectrum.sas.portal.v1alpha1

الفهرس

Customers (العملاء)

خدمة إدارة عملاء SAS

الحصول على عميل

rpc GetCustomer(GetCustomerRequest) returns (Customer)

عرض customer المطلوب.

نطاقات الأذونات

يجب توفير نطاق OAuth التالي:

  • https://www.googleapis.com/auth/userinfo.email
عملاء List

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

مدير الأجهزة

خدمة إدارة أجهزة راديو النطاق الترددي الواسع للمواطنين

إنشاء عملية نشر

rpc CreateDeployment(CreateDeploymentRequest) returns (Deployment)

تنشئ deployment جديدة.

نطاقات الأذونات

يجب توفير نطاق OAuth التالي:

  • https://www.googleapis.com/auth/userinfo.email
إنشاء جهاز

rpc CreateDevice(CreateDeviceRequest) returns (Device)

تنشئ device ضمن node أو customer.

نطاقات الأذونات

يجب توفير نطاق OAuth التالي:

  • https://www.googleapis.com/auth/userinfo.email
إنشاء عقدة

rpc CreateNode(CreateNodeRequest) returns (Node)

تنشئ node جديدة.

نطاقات الأذونات

يجب توفير نطاق OAuth التالي:

  • https://www.googleapis.com/auth/userinfo.email
إنشاء جهاز موقَّع

rpc CreateSignedDevice(CreateSignedDeviceRequest) returns (Device)

تنشئ علامة device موقّعة ضمن node أو customer.

نطاقات الأذونات

يجب توفير نطاق OAuth التالي:

  • https://www.googleapis.com/auth/userinfo.email
حذف النشر

rpc DeleteDeployment(DeleteDeploymentRequest) returns (Empty)

حذف deployment

نطاقات الأذونات

يجب توفير نطاق OAuth التالي:

  • https://www.googleapis.com/auth/userinfo.email
حذف الجهاز

rpc DeleteDevice(DeleteDeviceRequest) returns (Empty)

حذف device

نطاقات الأذونات

يجب توفير نطاق OAuth التالي:

  • https://www.googleapis.com/auth/userinfo.email
حذف عقدة

rpc DeleteNode(DeleteNodeRequest) returns (Empty)

حذف node

نطاقات الأذونات

يجب توفير نطاق OAuth التالي:

  • https://www.googleapis.com/auth/userinfo.email
إنشاء سر

rpc GenerateSecret(GenerateSecretRequest) returns (GenerateSecretResponse)

إنشاء سر لاستخدامه في ValidateInstaller.

نطاقات الأذونات

يجب توفير نطاق OAuth التالي:

  • https://www.googleapis.com/auth/userinfo.email
الحصول على أذونات النشر

rpc GetDeployment(GetDeploymentRequest) returns (Deployment)

عرض deployment المطلوب.

نطاقات الأذونات

يجب توفير نطاق OAuth التالي:

  • https://www.googleapis.com/auth/userinfo.email
الحصول على الجهاز

rpc GetDevice(GetDeviceRequest) returns (Device)

الحصول على تفاصيل عن device

نطاقات الأذونات

يجب توفير نطاق OAuth التالي:

  • https://www.googleapis.com/auth/userinfo.email
الحصول على عقدة

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
أجهزة القائمة

rpc ListDevices(ListDevicesRequest) returns (ListDevicesResponse)

تسرد devices ضمن node أو customer.

نطاقات الأذونات

يجب توفير نطاق OAuth التالي:

  • https://www.googleapis.com/auth/userinfo.email
عقدة القائمة

rpc ListNodes(ListNodesRequest) returns (ListNodesResponse)

تسرد nodes.

نطاقات الأذونات

يجب توفير نطاق OAuth التالي:

  • https://www.googleapis.com/auth/userinfo.email
نقل النشر

rpc MoveDeployment(MoveDeploymentRequest) returns (Operation)

نقل deployment ضمن node أخرى أو customer أخرى

نطاقات الأذونات

يجب توفير نطاق OAuth التالي:

  • https://www.googleapis.com/auth/userinfo.email
نقل الجهاز

rpc MoveDevice(MoveDeviceRequest) returns (Operation)

نقل device ضمن node أخرى أو customer أخرى

نطاقات الأذونات

يجب توفير نطاق OAuth التالي:

  • https://www.googleapis.com/auth/userinfo.email
نقل عقدة

rpc MoveNode(MoveNodeRequest) returns (Operation)

نقل node ضمن node أخرى أو customer أخرى

نطاقات الأذونات

يجب توفير نطاق OAuth التالي:

  • https://www.googleapis.com/auth/userinfo.email
جهاز التوقيع

rpc SignDevice(SignDeviceRequest) returns (Empty)

توقيع device.

نطاقات الأذونات

يجب توفير نطاق OAuth التالي:

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

rpc UpdateDeployment(UpdateDeploymentRequest) returns (Deployment)

تعديل deployment الحالية.

نطاقات الأذونات

يجب توفير نطاق OAuth التالي:

  • https://www.googleapis.com/auth/userinfo.email
تحديث الجهاز

rpc UpdateDevice(UpdateDeviceRequest) returns (Device)

يتم تعديل device.

نطاقات الأذونات

يجب توفير نطاق OAuth التالي:

  • https://www.googleapis.com/auth/userinfo.email
عقدة التحديث

rpc UpdateNode(UpdateNodeRequest) returns (Node)

تعديل node الحالية.

نطاقات الأذونات

يجب توفير نطاق OAuth التالي:

  • https://www.googleapis.com/auth/userinfo.email
تحديث جهاز الموقَّع

rpc UpdateSignedDevice(UpdateSignedDeviceRequest) returns (Device)

يتم تعديل device الموقّعة.

نطاقات الأذونات

يجب توفير نطاق OAuth التالي:

  • https://www.googleapis.com/auth/userinfo.email
أداة التحقق من صحة التثبيت

rpc ValidateInstaller(ValidateInstallerRequest) returns (ValidateInstallerResponse)

يتحقّق من هوية مستخدم مثبّت محترف معتمد (CPA).

نطاقات الأذونات

يجب توفير نطاق OAuth التالي:

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

خدمة السياسة

الوصول إلى خدمة التحكم في Spectrum Resource Manager

الحصول على السياسة

rpc GetPolicy(GetPolicyRequest) returns (Policy)

الحصول على سياسة التحكم في الوصول للمورد. عرض سياسة فارغة إذا كان المورد موجودًا ولم يتم تحديد سياسة.

نطاقات الأذونات

يجب توفير نطاق OAuth التالي:

  • https://www.googleapis.com/auth/userinfo.email
وضع السياسة

rpc SetPolicy(SetPolicyRequest) returns (Policy)

تعمل هذه السياسة على ضبط سياسة التحكّم بالوصول على المورد المحدّد. استبدال أي سياسة حالية.

نطاقات الأذونات

يجب توفير نطاق OAuth التالي:

  • https://www.googleapis.com/auth/userinfo.email
أذونات الاختبار

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

عمليات التعداد
BILLING_MODE_UNSPECIFIED لم يتم تحديد وضع الفوترة.
MOBILE يستند السعر إلى فئة CBSD: الفئة "أ"، الفئة "ب" المسجّلة لدى شركة SAS.
FIXED_WIRELESS يستند السعر إلى نوع شبكة CBSD: المحطة الأساسية أو تكلفة المشاركة.

نوع القناة

عمليات التعداد
CHANNEL_TYPE_UNSPECIFIED
CHANNEL_TYPE_GAA
CHANNEL_TYPE_PAL

إنشاء طلب نشر

طلب الحصول على مبلغ CreateDeployment.

الحقول
parent

string

مطلوبة. اسم المورد الرئيسي الذي سيتم إنشاء النشر فيه.
deployment

Deployment

مطلوبة. تفاصيل النشر. يجب أن تكون قيمة name فارغة. ينشئه الخادم. يجب إعداد عملية النشر display_name.

إنشاء طلب جهاز

طلب الحصول على مبلغ CreateDevice.

الحقول
parent

string

مطلوبة. هو اسم المورد الرئيسي.
device

Device

تفاصيل تسجيل device. يجب أن تكون قيمة name فارغة. ينشئه الخادم. يجب ضبط الحقلين device وfcc_id وserial_number. يجب إعداد الحقل user_id.

إنشاء عقدة طلب

طلب الحصول على مبلغ CreateNode.

الحقول
parent

string

مطلوبة. هو اسم المورد الرئيسي الذي يتم إنشاء العقدة فيه.
node

Node

تفاصيل العقدة يجب أن تكون قيمة name فارغة. ينشئه الخادم. يجب إعداد العقدة display_name.

إنشاء طلب تسجيل الدخول

طلب الحصول على مبلغ CreateSignedDevice.

الحقول
parent

string

مطلوبة. هو اسم المورد الرئيسي.
encoded_device

bytes

مطلوبة. تم توقيع رمز JSON المميّز للويب باستخدام مفتاح خاص للتكلفة لكل تثبيت. يجب أن تكون الحمولة ترميز JSON للسمة device. يجب إعداد الحقل user_id.
installer_id

string

مطلوبة. رقم تعريف أداة التثبيت الفريد (رقم تعريف التكلفة لكل تثبيت) من قاعدة بيانات أخصائيي التثبيت المعتمدين.

العميل

الكيان الذي يمثّل عميل SAS

الحقول
name

string

الناتج فقط. اسم المورد للعميل.
display_name

string

مطلوبة. اسم المؤسسة التي يمثّلها كيان العميل.
sas_user_ids[]

string

أرقام تعريف المستخدمين التي تستخدمها الأجهزة التي ينتمي إليها هذا العميل.

حذف عملية النشر

طلب الحصول على مبلغ DeleteDeployment.

الحقول
name

string

مطلوبة. اسم deployment.

حذف الجهاز

طلب الحصول على مبلغ DeleteDevice.

الحقول
name

string

مطلوبة. اسم الجهاز.

حذف عقدة

طلب الحصول على مبلغ 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.
active_config

DeviceConfig

الناتج فقط. عملية الإعداد الحالية للجهاز كما هو مسجَّل في قوائم التحقّق من الأمان (SAS).
state

State

الناتج فقط. حالة الجهاز
grants[]

DeviceGrant

الناتج فقط. المِنح التي يحملها الجهاز
display_name

string

الاسم المعروض للجهاز.
device_metadata

DeviceMetadata

معلّمات الجهاز التي يمكن إلغاؤها من خلال طلبات تسجيل SAS Portal وSAS.

الولاية

حالة الجهاز

عمليات التعداد
DEVICE_STATE_UNSPECIFIED حالة غير محدّدة
RESERVED ومع ذلك، لم يتم تسجيل الجهاز الذي تم إنشاؤه في بوابة SAS بعد في SAS.
REGISTERED الجهاز مسجّل باستخدام SAS.
DEREGISTERED تم إلغاء تسجيل الجهاز مع SAS.

واجهة الجهاز

معلومات عن واجهة الهواء على الجهاز

الحقول
radio_technology

RadioTechnology

الجملة الشرطية. يحدّد هذا الحقل تقنية الوصول إلى الراديو المستخدمة من أجل CBSD.
supported_spec

string

اختياريّ. يرتبط هذا الحقل بـ radioTechnology ويوفر مواصفات واجهة الهواء التي تتوافق مع سياسة CBSD عند وقت التسجيل.

التكنولوجيا الإشعاعية

الأنواع المعتمدة من تكنولوجيا الوصول إلى الراديو

عمليات التعداد
RADIO_TECHNOLOGY_UNSPECIFIED
E_UTRA
CAMBIUM_NETWORKS
FOUR_G_BBW_SAA_1
NR
DOODLE_CBRS
CW
REDLINE
TARANA_WIRELESS

فئة الجهاز

فئة FCC للجهاز، على النحو المحدد في الجزء 96.

عمليات التعداد
DEVICE_CATEGORY_UNSPECIFIED فئة الجهاز غير محدّدة.
DEVICE_CATEGORY_A الفئة (أ)
DEVICE_CATEGORY_B الفئة "ب"

إعداد الجهاز

معلومات عن إعدادات الجهاز

الحقول
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

الناتج فقط. ما إذا كان قد تم توقيع الإعداد من خلال تكلفة لكل تثبيت.
update_time

Timestamp

الناتج فقط. آخر مرة تمّ فيها تعديل إعدادات الجهاز.

الولاية

حالة ضبط الجهاز. لا يمكن استخدام سوى الإعدادات في الحالة DEVICE_CONFIG_STATE_FINAL أثناء تسجيل CBSD.

عمليات التعداد
DEVICE_CONFIG_STATE_UNSPECIFIED
DRAFT
FINAL

منح الجهاز

مِنح الجهاز. وهو تفويض يوفّره "نظام الوصول إلى Spectrum Access" على الجهاز لنقله باستخدام معلَمات تشغيل محدّدة بعد الإشارة الناجحة إلى الجهاز.

الحقول
max_eirp

DoubleValue

الحد الأقصى للطاقة المشعاعية المكافئة (EIRP) الذي يسمح به المنح. يبلغ الحد الأقصى لقيم EIRP بوحدات ديسيبل ملي واط/ميغاهرتز. وتمثّل قيمة maxEirp متوسط EIRP الذي سيتم قياسه من خلال الإجراء المحدّد في الجزء 96.41 (e)(3) من هيئة الاتصالات الفيدرالية (FCC).
frequency_range

FrequencyRange

نطاق تردد النقل
state

GrantState

حالة المنح
channel_type

ChannelType

نوع القناة المستخدَمة.
move_list[]

DpaMoveList

قوائم نقل "هيئة حماية البيانات" التي تظهر عليها هذه المنح
expire_time

Timestamp

تمثّل هذه السمة وقت انتهاء صلاحية المنح.
suspension_reason[]

string

في حال تعليق المِنح، يجب توضيح أسباب التعليق.
grant_id

string

رقم تعريف منح الإذن.

البيانات الوصفية للجهاز

يمكن إلغاء بيانات الجهاز من خلال كل من بوابة SAS وطلبات التسجيل.

طراز الجهاز

معلومات عن طراز الجهاز.

الحقول
vendor

string

اسم مورّد الجهاز.
name

string

اسم طراز الجهاز.
software_version

string

إصدار البرنامج من الجهاز
hardware_version

string

إصدار الجهاز.
firmware_version

string

إصدار الجهاز الثابت.

قائمة التشغيل (DpamoveList)

إدخال في قائمة عمليات نقل البيانات (DPA)

الحقول
dpa_id

StringValue

رقم تعريف هيئة حماية البيانات
frequency_range

FrequencyRange

نطاق التردد الذي تؤثر فيه قائمة النقل.

نطاق التكرار

يتراوح معدل التكرار من low_frequency إلى high_frequency.

الحقول
low_frequency_mhz

DoubleValue

أدنى تردد لنطاق التردد بالميغاهرتز.
high_frequency_mhz

DoubleValue

أعلى تردد لنطاق التردد بالميغاهرتز.

إنشاء طلب سري

طلب الحصول على مبلغ GenerateSecret.

إنشاء السر

رد GenerateSecret.

الحقول
secret

string

السر الذي يتم إنشاؤه من خلال السلسلة ويتم استخدامه بواسطة ValidateInstaller.

الحصول على عميل

طلب الحصول على مبلغ GetCustomer .

الحقول
name

string

مطلوبة. اسم customer.

طلب النشر

طلب الحصول على مبلغ GetDeployment.

الحقول
name

string

مطلوبة. اسم deployment.

الحصول على جهاز

طلب الحصول على مبلغ GetDevice.

الحقول
name

string

مطلوبة. اسم الجهاز.

طلب عقدة

طلب الحصول على مبلغ GetNode.

الحقول
name

string

مطلوبة. اسم node.

طلب السياسة

طُلب طلب طريقة GetPolicy.

الحقول
resource

string

مطلوبة. المورد الذي يتم طلب السياسة له.

غرانت ستيت

تمثّل هذه السمة حالة المنح.

عمليات التعداد
GRANT_STATE_UNSPECIFIED
GRANT_STATE_GRANTED تم منح المنح، لكن الجهاز لا ينبض به.
GRANT_STATE_TERMINATED تم إنهاء المنح من قِبل SAS.
GRANT_STATE_SUSPENDED تم تعليق المنح من قِبل شركة SAS.
GRANT_STATE_AUTHORIZED يجري نقل الجهاز حاليًا.
GRANT_STATE_EXPIRED انتهت صلاحية المنح.

نوع الارتفاع

تحدّد طريقة قياس الارتفاع.

عمليات التعداد
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&quot؛ يتم تقديمها في ما يتعلق بمرجع WGS84.
height_type

HeightType

تحدّد طريقة قياس الارتفاع.
horizontal_accuracy

DoubleValue

رقم موجب بالمتر يشير إلى دقة الموقع الجغرافي لهوائي الجهاز. يجب ألا تكون هذه المعلمة الاختيارية موجودة إلا إذا كانت قيمتها أقل من متطلبات لجنة الاتصالات الفيدرالية (FCC) التي تبلغ 50 مترًا.
vertical_accuracy

DoubleValue

رقم موجب بالمتر يشير إلى دقة الموقع الجغرافي لهوائي الجهاز. يجب ألا تكون هذه المعلمة الاختيارية موجودة إلا إذا كانت قيمتها أقل من متطلبات لجنة الاتصالات الفيدرالية (FCC) التي تبلغ 3 أمتار.
indoor_deployment

BoolValue

ما إذا كان هوائي الجهاز داخليًا أم لا. true: داخلي false: في الهواء الطلق.
antenna_azimuth

Int32Value

اتجاه حفر المستوى الهوائي الأفقي بالدرجات فيما يتعلق بالشمال الحقيقي. وقيمة هذه المعلّمة هي عدد صحيح بقيمة تتراوح بين 0 و359. وتعني القيمة 0 درجة صحيح الشمال، بينما تعني القيمة 90 درجة الشرق. هذه المعلّمة اختيارية للأجهزة من الفئة "أ" ومشروطة للأجهزة من الفئة "ب".
antenna_downtilt

Int32Value

يتم إمالة الهوائي بالدرجات وهو عدد صحيح يتراوح بين -90 و+90، بينما تشير القيمة السالبة إلى الهوائي مائل (أعلى من الأفقي). هذه المعلّمة اختيارية للأجهزة من الفئة "أ" ومشروطة للأجهزة من الفئة "ب".
antenna_gain

Int32Value

الارتفاع في هوائي الذروة بالديسيبل وهذه المعلّمة عبارة عن عدد صحيح بقيمة بين -127 و128 (dBi) شاملة.
eirp_capability

Int32Value

هذه المعلّمة هي الحد الأقصى EIRP للجهاز في وحدات dBm/10 ميغاهرتز وهي عدد صحيح تتراوح بين -127 و+47 (dBm/10 ميغاهرتز) شاملة. وفي حال عدم تضمين هذه السياسة، تفسِّر ميزة SAS ذلك على أنها الحد الأقصى المسموح به EIRP في وحدات ديسيبل ميلي واط/10 ميغاهرتز لفئة الجهاز.
antenna_beamwidth

Int32Value

عارضة هوائي 3 ديسيبل للهوائي في المستوى الأفقي بالدرجات. هذه المعلّمة هي عدد صحيح غير موقَّع تحتوي على قيمة تتراوح بين 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.

الحقول
customers[]

Customer

قائمة customers التي تتطابق مع الطلب.
next_page_token

string

تم عرض رمز مميّز للتقسيم على صفحات من مكالمة سابقة إلى ListCustomers يشير إلى المكان الذي يجب أن تستمر فيه البيانات. إذا كان الحقل غير متوفّر أو فارغًا، هذا يعني أنّه ما مِن عملاء آخرين.

سرد طلب النشر

طلب الحصول على مبلغ ListDeployments.

الحقول
parent

string

مطلوبة. اسم المورد الرئيسي، على سبيل المثال، "nodes/1"، customer/1/nodes/2.
page_size

int32

الحد الأقصى لعدد عمليات النشر التي يتم عرضها في الاستجابة.
page_token

string

تم إرجاع رمز مميّز للتقسيم على صفحات من مكالمة سابقة إلى ListDeployments يشير إلى الموضع الذي يجب أن تستمر منه هذه البيانات.
filter

string

تعبير الفلتر يجب أن يكون الفلتر بالتنسيق التالي: "direct;CHILDREN" أو التنسيق: "direct;children". الفلتر غير حساس لحالة الأحرف. وفي حال عدم ضبط هذا الإعداد، لن تتم فلترة أي عمليات نشر.

طريقة النشر في القائمة

رد ListDeployments.

الحقول
deployments[]

Deployment

deployments التي تتطابق مع الطلب.
next_page_token

string

تم عرض رمز مميّز للتقسيم على صفحات من مكالمة سابقة إلى ListDeployments يشير إلى المكان الذي يجب أن تستمر فيه البيانات. إذا كان الحقل مفقودًا أو فارغًا، يعني ذلك أنه لم يعد هناك أي عمليات نشر أخرى.

طلب الأجهزة

طلب الحصول على مبلغ ListDevices.

الحقول
parent

string

مطلوبة. هو اسم المورد الرئيسي.
page_size

int32

الحد الأقصى لعدد الأجهزة التي يمكن عرضها في الاستجابة. إذا كانت القيمة فارغة أو صفرًا، سيتم عرض جميع الأجهزة. يجب أن تكون ضمن النطاق [0, 1000].
page_token

string

تم إرجاع رمز مميّز للتقسيم على صفحات من مكالمة سابقة إلى ListDevices يشير إلى الموضع الذي يجب أن تستمر منه هذه البيانات.
filter

string

تعبير الفلتر يجب أن يكون الفلتر بأحد التنسيقات التالية: "sn=123454" أو "display_name=MyDevice". sn يقابل الرقم التسلسلي للجهاز. الفلتر غير حساس لحالة الأحرف.

سرد الأجهزة

رد ListDevices.

الحقول
devices[]

Device

devices التي تتطابق مع الطلب.
next_page_token

string

تم عرض رمز مميّز للتقسيم على صفحات من مكالمة سابقة إلى ListDevices يشير إلى المكان الذي يجب أن تستمر فيه البيانات. إذا كان الحقل غير متوفّر أو فارغًا، يعني ذلك أنّه ما مِن أجهزة أخرى.

طلب عقدة القائمة

طلب الحصول على مبلغ ListNodes.

الحقول
parent

string

مطلوبة. اسم المورد الرئيسي، على سبيل المثال، "no;/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.

عمليات التعداد
MEASUREMENT_CAPABILITY_UNSPECIFIED
MEASUREMENT_CAPABILITY_RECEIVED_POWER_WITH_GRANT
MEASUREMENT_CAPABILITY_RECEIVED_POWER_WITHOUT_GRANT

نقل طلب النشر

طلب الحصول على مبلغ MoveDeployment.

الحقول
name

string

مطلوبة. اسم deployment المراد نقله.
destination

string

مطلوبة. اسم المورد الرئيسي الجديد node أو customer لإعادة نشر عملية النشر ضمنها.

طلب جهاز

طلب الحصول على مبلغ MoveDevice.

الحقول
name

string

مطلوبة. اسم الجهاز المراد نقله.
destination

string

مطلوبة. اسم المورد الرئيسي الجديد node أو customer لإعادة إنشاء الجهاز ضمنه.

طلب عقدة النقل

طلب الحصول على مبلغ MoveNode.

الحقول
name

string

مطلوبة. اسم node المراد نقله.
destination

string

مطلوبة. اسم المورد الرئيسي الجديد node أو customer لإعادة إنشاء العقدة ضمنها.

العُقدة

العقدة.

الحقول
name

string

الناتج فقط. اسم المورد
display_name

string

الاسم المعروض للعقدة.
sas_user_ids[]

string

أرقام تعريف المستخدمين التي تستخدمها الأجهزة التي تنتمي إلى هذه العقدة.

السياسة

تحديد سياسة التحكُّم بالوصول إلى الموارد

الحقول
assignments[]

Assignment

تمثّل هذه السمة قائمة assignments.
etag

bytes

وتُستخدَم علامة etag للتحكّم المُبهِج في المزامنة، وذلك للمساعدة في منع التعديلات المتزامنة على إحدى السياسات من استبدال بعضها البعض. نقترح بشدة أن تستفيد الأنظمة من علامة etag في الدورة المعدّلة للقراءة والكتابة لإجراء تعديلات على السياسة بهدف تجنُّب شروط السباق: يتم عرض علامة etag في الاستجابة على GetPolicy، ومن المتوقّع أن تضع الأنظمة علامة etag في الطلب على SetPolicy لضمان أن يتم تطبيق التغيير على الإصدار نفسه من السياسة.

إذا لم يتم تقديم علامة etag في الطلب إلى GetPolicy، يتم استبدال السياسة الحالية بشكل مكتوب.

تحديد السياسة

طُلب طلب طريقة SetPolicy.

الحقول
resource

string

مطلوبة. المورد الذي يتم تحديد السياسة له. تحل هذه السياسة محل أيّ سياسة حالية.
policy

Policy

مطلوبة. السياسة التي سيتم تطبيقها على resource

طلب توقيع الجهاز

طلب الحصول على مبلغ SignDevice.

الحقول
device

Device

مطلوبة. device للتوقيع. يجب ضبط الحقول device name وfcc_id وserial_number. يجب إعداد الحقل user_id.

طلب أذونات

طُلب طلب طريقة TestPermissions.

الحقول
resource

string

مطلوبة. المورد الذي يتم طلب الأذونات له.
permissions[]

string

مجموعة الأذونات للتحقق من resource.

اختبار الأذونات

رسالة الاستجابة لطريقة TestPermissions.

الحقول
permissions[]

string

مجموعة من الأذونات التي يسمح بها المتصل.

تعديل طلب العميل

طلب الحصول على مبلغ UpdateCustomer.

الحقول
customer

Customer

مطلوبة. القيم الجديدة للسمة customer. يجب أن يتم ضبط name وdisplay_name على العميل.
update_mask

FieldMask

الحقول المطلوب تعديلها.

طلب النشر

طلب الحصول على مبلغ UpdateDeployment.

الحقول
deployment

Deployment

مطلوبة. القيم الجديدة للسمة deployment. يجب ضبط name وdisplay_name.
update_mask

FieldMask

الحقول المطلوب تعديلها.

طلب تحديث الجهاز

طلب الحصول على مبلغ UpdateDevice.

الحقول
device

Device

مطلوبة. device للتحديث. يجب ضبط الحقول device name وfcc_id وserial_number. يجب إعداد الحقل user_id.
update_mask

FieldMask

الحقول المطلوب تعديلها.

طلب عقدة التحديث

طلب الحصول على مبلغ UpdateNode.

الحقول
node

Node

مطلوبة. القيم الجديدة للسمة node. يجب ضبط name وdisplay_name.
update_mask

FieldMask

الحقول المطلوب تعديلها.

UpdateSignedDeviceRequest

طلب الحصول على مبلغ UpdateSignedDevice.

الحقول
name

string

مطلوبة. اسم الجهاز المطلوب تحديثه.
encoded_device

bytes

مطلوبة. تم توقيع رمز JSON المميّز للويب باستخدام مفتاح خاص للتكلفة لكل تثبيت. يجب أن تكون الحمولة ترميز JSON للسمة device. يجب إعداد الحقل user_id.
installer_id

string

مطلوبة. رقم تعريف أداة التثبيت الفريدة (رقم تعريف التكلفة لكل تثبيت) من قاعدة بيانات أخصائيي التثبيت المحترفين.

التحقق من صحة طلب التثبيت

طلب الحصول على مبلغ ValidateInstaller.

الحقول
installer_id

string

مطلوبة. رقم تعريف أداة التثبيت الفريد (رقم تعريف التكلفة لكل تثبيت) من قاعدة بيانات أخصائيي التثبيت المعتمدين.
secret

string

مطلوبة. تم إرجاع المفتاح السري من قِبَل GenerateSecret.
encoded_secret

string

مطلوبة. تم توقيع رمز JSON المميّز للويب باستخدام مفتاح خاص للتكلفة لكل تثبيت. يجب أن تتضمن الحمولة مطالبة "secret;quot;; والتي تكون قيمتها سرّية.

التحقق من التثبيت

رد ValidateInstaller.