Package google.cloud.resourcesettings.v1alpha1

ดัชนี

ResourceSettingsService

อินเทอร์เฟซสำหรับโต้ตอบกับการตั้งค่าทรัพยากรและค่าการตั้งค่าตลอดทั้งลำดับชั้นของทรัพยากร

บริการอาจแสดงการตั้งค่าหลายอย่างเพื่อให้ผู้ใช้ควบคุมลักษณะการทำงานของทรัพยากร ระบบจะประเมินการตั้งค่าที่ใช้กับทรัพยากร Cloud ที่ระบุตามลำดับชั้น และทรัพยากรทั้งหมดที่สืบทอดมาจากทรัพยากรนั้นจะได้รับการตั้งค่าดังกล่าว

สำหรับคำขอทั้งหมด จะแสดงผล google.rpc.Status พร้อม google.rpc.Code.PERMISSION_DENIED หากการตรวจสอบ IAM ไม่สำเร็จหรือทรัพยากร parent ไม่ได้อยู่ใน Cloud Organization สำหรับคำขอทั้งหมด จะแสดงผล google.rpc.Status พร้อม google.rpc.Code.INVALID_ARGUMENT หากคำขอมีรูปแบบไม่ถูกต้อง

หมายเหตุ: สำหรับการตั้งค่าทั้งหมดในระยะอัลฟ่า การตั้งค่าจะไม่อยู่ในทรัพยากรใดๆ ในองค์กร Cloud ที่ไม่ได้อยู่ในอัลฟ่า

CreateSettingValue

rpc CreateSettingValue(CreateSettingValueRequest) returns (SettingValue)

สร้างค่าการตั้งค่า

แสดงผล google.rpc.Status พร้อม google.rpc.Code.NOT_FOUND หากไม่มีการตั้งค่า แสดงผล google.rpc.Status ที่มี google.rpc.Code.ALREADY_EXISTS หากค่าการตั้งค่ามีอยู่ในทรัพยากร Cloud ที่ระบุอยู่แล้ว แสดงผล google.rpc.Status ที่มี google.rpc.Code.FAILED_PRECONDITION หากมีการแจ้งว่าการตั้งค่าเป็นแบบอ่านอย่างเดียว

ขอบเขตการให้สิทธิ์

ต้องใช้ขอบเขต OAuth ต่อไปนี้

  • https://www.googleapis.com/auth/cloud-platform

ดูข้อมูลเพิ่มเติมได้ที่ภาพรวมการตรวจสอบสิทธิ์
DeleteSettingValue

rpc DeleteSettingValue(DeleteSettingValueRequest) returns (Empty)

ลบค่าการตั้งค่า หากไม่มีค่าการตั้งค่า การดำเนินการจะไม่ดำเนินการใดๆ

แสดงผล google.rpc.Status ที่มี google.rpc.Code.NOT_FOUND หากไม่มีการตั้งค่าหรือค่าการตั้งค่า ค่าการตั้งค่าจะไม่มีอยู่หากการเรียก DeleteSetting ก่อนหน้าสำหรับค่าการตั้งค่าส่งคืนรหัสความสำเร็จแล้ว แสดงผล google.rpc.Status ที่มี google.rpc.Code.FAILED_PRECONDITION หากมีการแจ้งว่าการตั้งค่าเป็นแบบอ่านอย่างเดียว

ขอบเขตการให้สิทธิ์

ต้องใช้ขอบเขต OAuth ต่อไปนี้

  • https://www.googleapis.com/auth/cloud-platform

ดูข้อมูลเพิ่มเติมได้ที่ภาพรวมการตรวจสอบสิทธิ์
GetSettingValue

rpc GetSettingValue(GetSettingValueRequest) returns (SettingValue)

รับค่าการตั้งค่า

แสดงผล google.rpc.Status ที่มี google.rpc.Code.NOT_FOUND หากไม่มีค่าการตั้งค่า

ขอบเขตการให้สิทธิ์

ต้องใช้ขอบเขต OAuth ต่อไปนี้

  • https://www.googleapis.com/auth/cloud-platform

ดูข้อมูลเพิ่มเติมได้ที่ภาพรวมการตรวจสอบสิทธิ์
ListSettings

rpc ListSettings(ListSettingsRequest) returns (ListSettingsResponse)

แสดงการตั้งค่าทั้งหมดที่มีในทรัพยากร Cloud parent

ขอบเขตการให้สิทธิ์

ต้องใช้ขอบเขต OAuth ต่อไปนี้

  • https://www.googleapis.com/auth/cloud-platform

ดูข้อมูลเพิ่มเติมได้ที่ภาพรวมการตรวจสอบสิทธิ์
LookupEffectiveSettingValue

rpc LookupEffectiveSettingValue(LookupEffectiveSettingValueRequest) returns (SettingValue)

คำนวณค่าการตั้งค่าที่มีผลของการตั้งค่าในทรัพยากรระบบคลาวด์ parent ค่าการตั้งค่าที่มีผลคือค่าการตั้งค่าที่คำนวณแล้วในทรัพยากรระบบคลาวด์ และจะประเมินเป็นตัวเลือกใดตัวเลือกหนึ่งต่อไปนี้ตามลำดับที่ระบุ (ระบบจะใช้ตัวเลือกถัดไปหากไม่มีตัวเลือกก่อนหน้า)

  1. ค่าการตั้งค่าในทรัพยากรที่ระบุ
  2. ค่าการตั้งค่าในบรรพบุรุษที่ใกล้ที่สุดของทรัพยากรที่ระบุ
  3. ค่าเริ่มต้นของการตั้งค่า
  4. ค่าการตั้งค่าว่าง ซึ่งกำหนดเป็น SettingValue ที่ไม่ได้ตั้งค่าช่องทั้งหมด

แสดงผล google.rpc.Status พร้อม google.rpc.Code.NOT_FOUND หากไม่มีการตั้งค่า

ขอบเขตการให้สิทธิ์

ต้องใช้ขอบเขต OAuth ต่อไปนี้

  • https://www.googleapis.com/auth/cloud-platform

ดูข้อมูลเพิ่มเติมได้ที่ภาพรวมการตรวจสอบสิทธิ์
SearchSettingValues

rpc SearchSettingValues(SearchSettingValuesRequest) returns (SearchSettingValuesResponse)

ค้นหาค่าการตั้งค่าทั้งหมดที่มีอยู่ในทรัพยากร parent ค่าการตั้งค่าไม่ได้จำกัดอยู่เฉพาะค่าของการตั้งค่าใดการตั้งค่าหนึ่ง

ขอบเขตการให้สิทธิ์

ต้องใช้ขอบเขต OAuth ต่อไปนี้

  • https://www.googleapis.com/auth/cloud-platform

ดูข้อมูลเพิ่มเติมได้ที่ภาพรวมการตรวจสอบสิทธิ์
UpdateSettingValue

rpc UpdateSettingValue(UpdateSettingValueRequest) returns (SettingValue)

อัปเดตค่าการตั้งค่า

แสดงผล google.rpc.Status ที่มี google.rpc.Code.NOT_FOUND หากไม่มีการตั้งค่าหรือค่าการตั้งค่า แสดงผล google.rpc.Status ที่มี google.rpc.Code.FAILED_PRECONDITION หากมีการแจ้งว่าการตั้งค่าเป็นแบบอ่านอย่างเดียว แสดงผล google.rpc.Status พร้อม google.rpc.Code.ABORTED หาก ETag ที่ระบุในคำขอไม่ตรงกับ ETag ที่บันทึกไว้ของค่าการตั้งค่า

หมายเหตุ: ค่าการตั้งค่าที่ระบุจะเขียนทับฟิลด์ทั้งหมดอย่างสมบูรณ์

ขอบเขตการให้สิทธิ์

ต้องใช้ขอบเขต OAuth ต่อไปนี้

  • https://www.googleapis.com/auth/cloud-platform

ดูข้อมูลเพิ่มเติมได้ที่ภาพรวมการตรวจสอบสิทธิ์

CreateSettingValueRequest

คำขอสำหรับ CreateSettingValue

ช่อง
setting_value

SettingValue

ค่าการตั้งค่าที่จะสร้าง ดูSettingValueสำหรับข้อกำหนดของฟิลด์

การให้สิทธิ์ต้องใช้สิทธิ์ IAM ต่อไปนี้ในทรัพยากรที่ระบุ settingValue

  • resourcesettings.settingvalues.create

DeleteSettingValueRequest

คำขอสำหรับ DeleteSettingValue

ช่อง
name

string

ชื่อของค่าการตั้งค่าที่จะลบ ดูข้อกำหนดในการตั้งชื่อได้ที่ SettingValue

การให้สิทธิ์ต้องใช้สิทธิ์ IAM ต่อไปนี้ในทรัพยากรที่ระบุ name

  • resourcesettings.settingvalues.delete
ignore_read_only

bool

ค่าสถานะที่อนุญาตให้ลบค่าของread_onlyการตั้งค่า คำเตือน: โปรดใช้โดยยอมรับความเสี่ยงเอง การลบค่าของการตั้งค่าแบบอ่านอย่างเดียวเป็นการดำเนินการที่ยกเลิกไม่ได้ (กล่าวคือ สร้างอีกครั้งไม่ได้)

GetSettingValueRequest

คำขอสำหรับ GetSettingValue

ช่อง
name

string

ชื่อของค่าการตั้งค่าที่จะได้รับ ดูข้อกำหนดในการตั้งชื่อได้ที่ SettingValue

การให้สิทธิ์ต้องใช้สิทธิ์ IAM ต่อไปนี้ในทรัพยากรที่ระบุ name

  • resourcesettings.settingvalues.get

ListSettingsRequest

คำขอสำหรับ ListSettings

ช่อง
parent

string

ทรัพยากรระบบคลาวด์ที่เป็นระดับบนสุดของการตั้งค่า ต้องอยู่ในรูปแบบใดรูปแบบหนึ่งต่อไปนี้

  • projects/{project_number}
  • projects/{project_id}
  • folders/{folder_id}
  • organizations/{organization_id}

การให้สิทธิ์ต้องใช้สิทธิ์ IAM ต่อไปนี้ในทรัพยากรที่ระบุ parent

  • resourcesettings.settings.list
page_size

int32

ไม่ได้ใช้ ขนาดของหน้าที่จะแสดงผล
page_token

string

ไม่ได้ใช้ โทเค็นหน้าเว็บที่ใช้เพื่อดึงข้อมูลหน้าถัดไป

ListSettingsResponse

การตอบกลับจาก ListSettings

ช่อง
settings[]

Setting

รายการการตั้งค่าที่พร้อมใช้งานในทรัพยากร Cloud ที่ระบุ
next_page_token

string

ไม่ได้ใช้ โทเค็นหน้าเว็บที่ใช้เพื่อดึงข้อมูลหน้าถัดไป

LookupEffectiveSettingValueRequest

คำขอสำหรับ LookupEffectiveSettingValue

ช่อง
parent

string

การตั้งค่าที่จะประเมินค่าที่มีผล ดูข้อกำหนดในการตั้งชื่อได้ที่ Setting

การให้สิทธิ์ต้องใช้สิทธิ์ IAM ต่อไปนี้ในทรัพยากรที่ระบุ parent

  • resourcesettings.settingvalues.get

SearchSettingValuesRequest

คำขอสำหรับ SearchSettingValues

ช่อง
parent

string

ทรัพยากรระบบคลาวด์ที่เป็นระดับบนสุดของการตั้งค่า ต้องอยู่ในรูปแบบใดรูปแบบหนึ่งต่อไปนี้

  • projects/{project_number}
  • projects/{project_id}
  • folders/{folder_id}
  • organizations/{organization_id}

การให้สิทธิ์ต้องใช้สิทธิ์ IAM ต่อไปนี้ในทรัพยากรที่ระบุ parent

  • resourcesettings.settingvalues.list
page_size

int32

ไม่ได้ใช้ ขนาดของหน้าที่จะแสดงผล
page_token

string

ไม่ได้ใช้ โทเค็นหน้าเว็บที่ใช้เพื่อดึงข้อมูลหน้าถัดไป

SearchSettingValuesResponse

การตอบกลับจาก SearchSettingValues

ช่อง
setting_values[]

SettingValue

ค่าการตั้งค่าทั้งหมดที่มีอยู่ในทรัพยากรระบบคลาวด์ที่ระบุ
next_page_token

string

ไม่ได้ใช้ โทเค็นหน้าเว็บที่ใช้เพื่อดึงข้อมูลหน้าถัดไป

การตั้งค่า

สคีมาสำหรับการตั้งค่า ในการตั้งค่าทรัพยากรระบบคลาวด์ที่กำหนด การตั้งค่าสามารถเป็นค่าของการตั้งค่าได้สูงสุด 1 ค่า

ช่อง
name

string

ชื่อทรัพยากรของการตั้งค่า ต้องอยู่ในรูปแบบใดรูปแบบหนึ่งต่อไปนี้

  • projects/{project_number}/settings/{setting_name}
  • folders/{folder_id}/settings/{setting_name}
  • organizations/{organization_id}/settings/{setting_name}

เช่น "/projects/123/settings/gcp-enableMyFeature"
display_name

string

ชื่อที่มนุษย์อ่านได้สำหรับการตั้งค่านี้
description

string

คำอธิบายโดยละเอียดว่าการตั้งค่านี้ทำอะไร
read_only

bool

ค่าสถานะที่บ่งชี้ว่าค่าของการตั้งค่านี้ไม่สามารถแก้ไขได้ (ดูเอกสารประกอบของการตั้งค่าที่เฉพาะเจาะจงสำหรับการอัปเดตและเหตุผล) อย่างไรก็ตาม อาจลบได้โดยใช้ DeleteSettingValue หากตั้งค่า DeleteSettingValueRequest.ignore_read_only เป็นจริง การใช้แฟล็กนี้ถือเป็นการรับทราบว่าไม่สามารถสร้างค่าการตั้งค่าขึ้นใหม่ได้ ดูรายละเอียดเพิ่มเติมได้ที่ DeleteSettingValueRequest.ignore_read_only
data_type

DataType

ประเภทข้อมูลสำหรับการตั้งค่านี้
default_value

Value

ค่าที่ได้รับจาก LookupEffectiveSettingValue หากไม่ได้ตั้งค่าอย่างชัดเจน

หมายเหตุ: การตั้งค่าบางอย่างไม่มีค่าเริ่มต้น

DataType

ประเภทข้อมูลสำหรับการตั้งค่าของการตั้งค่านี้ ดูรายละเอียดเพิ่มเติมเกี่ยวกับประเภทข้อมูลที่ใช้ได้ที่ Value

Enum
DATA_TYPE_UNSPECIFIED ประเภทข้อมูลที่ไม่ได้ระบุ
BOOLEAN การตั้งค่าบูลีน
STRING การตั้งค่าสตริง
STRING_SET การตั้งค่าชุดสตริง

SettingValue

การสร้างอินสแตนซ์ของการตั้งค่า ค่าการตั้งค่าทุกค่าจะเชื่อมโยงกับการตั้งค่าที่เกี่ยวข้อง

ช่อง
name

string

ชื่อทรัพยากรของค่าการตั้งค่า ต้องอยู่ในรูปแบบใดรูปแบบหนึ่งต่อไปนี้

  • projects/{project_number}/settings/{setting_name}/value
  • folders/{folder_id}/settings/{setting_name}/value
  • organizations/{organization_id}/settings/{setting_name}/value

เช่น "/projects/123/settings/gcp-enableMyFeature/value"
value

Value

ค่าของการตั้งค่า ประเภทข้อมูลของ Value ต้องสอดคล้องกับประเภทข้อมูลที่กำหนดโดยการตั้งค่าระดับบนเสมอ
etag

string

ลายนิ้วมือที่ใช้สำหรับการทำงานพร้อมกันแบบอิงตามการคาดการณ์ ดูรายละเอียดเพิ่มเติมได้ที่ UpdateSettingValue
read_only

bool

เอาต์พุตเท่านั้น แฟล็กที่ระบุว่าแก้ไขค่าการตั้งค่านี้ไม่ได้ แต่ลบได้โดยใช้ DeleteSettingValue หากตั้งค่า DeleteSettingValueRequest.ignore_read_only เป็นจริง การใช้แฟล็กนี้ถือเป็นการรับทราบว่าไม่สามารถสร้างค่าการตั้งค่าขึ้นใหม่ได้ โดยค่าสถานะนี้จะรับช่วงมาจากการตั้งค่าระดับบนสุดและมีไว้เพื่อความสะดวก ดูรายละเอียดเพิ่มเติมได้ที่ Setting.read_only
update_time

Timestamp

เอาต์พุตเท่านั้น การประทับเวลาที่ระบุเวลาที่อัปเดตค่าการตั้งค่าครั้งล่าสุด

UpdateSettingValueRequest

คำขอสำหรับ UpdateSettingValue

ช่อง
setting_value

SettingValue

ค่าการตั้งค่าที่จะอัปเดต ดูSettingValueสำหรับข้อกำหนดของฟิลด์

การให้สิทธิ์ต้องใช้สิทธิ์ IAM ต่อไปนี้ในทรัพยากรที่ระบุ settingValue

  • resourcesettings.settingvalues.update

ค่า

ข้อมูลในค่าการตั้งค่า

ช่อง
ฟิลด์ Union value เลือกประเภทข้อมูลและค่าที่เกี่ยวข้อง value ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้เท่านั้น
boolean_value

bool

กำหนดค่านี้เป็นค่าบูลีน
string_value

string

กำหนดค่านี้เป็นค่าสตริง
string_set_value

StringSet

กำหนดค่านี้เป็น StringSet

StringSet

ค่าชุดสตริงที่สามารถเก็บชุดสตริงได้ สตริงแต่ละรายการมีความยาวได้สูงสุด 60 อักขระ และมีสตริงได้สูงสุด 50 รายการในชุดสตริง

ช่อง
values[]

string

สตริงในชุด