Package google.cloud.resourcesettings.v1alpha1

ดัชนี

บริการการตั้งค่าทรัพยากร

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

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

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

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

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

rpc CreateSettingValue(CreateSettingValueRequest) returns (SettingValue)

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

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

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

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

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

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

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

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

rpc GetSettingValue(GetSettingValueRequest) returns (SettingValue)

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

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

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

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

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

โปรดดูข้อมูลเพิ่มเติมที่ภาพรวมการตรวจสอบสิทธิ์
การตั้งค่ารายการ

rpc ListSettings(ListSettingsRequest) returns (ListSettingsResponse)

แสดงการตั้งค่าทั้งหมดที่มีในทรัพยากรระบบคลาวด์ parent

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

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

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

โปรดดูข้อมูลเพิ่มเติมที่ภาพรวมการตรวจสอบสิทธิ์
ค่าการตั้งค่าการค้นหา

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

โปรดดูข้อมูลเพิ่มเติมที่ภาพรวมการตรวจสอบสิทธิ์
การตั้งค่าการค้นหา

rpc SearchSettingValues(SearchSettingValuesRequest) returns (SearchSettingValuesResponse)

ค้นหาค่าการตั้งค่าทั้งหมดที่มีอยู่ในทรัพยากร parent ค่าการตั้งค่าไม่ได้จํากัดอยู่แค่การตั้งค่าใดค่าหนึ่ง

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

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

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

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

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

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

สร้างค่าคําขอ

คําขอ CreateSettingsValue

ช่อง
setting_value

SettingValue

ค่าการตั้งค่าที่จะสร้าง โปรดดู SettingValue สําหรับข้อกําหนดเกี่ยวกับช่อง

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

  • resourcesettings.settingvalues.create

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

คําขอ DeleteSettingsValue

ช่อง
name

string

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

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

  • resourcesettings.settingvalues.delete
ignore_read_only

bool

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

รับ GetSettingsValue

คําขอ GetSettingsValue

ช่อง
name

string

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

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

  • resourcesettings.settingvalues.get

คําขอการตั้งค่ารายการ

คําขอการตั้งค่ารายการ

ช่อง
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

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

การตอบกลับการตั้งค่ารายการ

คําตอบจาก ListSettings

ช่อง
settings[]

Setting

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

string

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

การตั้งค่าการค้นหาอย่างมีประสิทธิภาพ

คําขอ LookupEffectiveSettingsValue

ช่อง
parent

string

การตั้งค่าที่จะประเมินค่าที่มีประสิทธิภาพ โปรดดูข้อกําหนดการตั้งชื่อใน Setting

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

  • resourcesettings.settingvalues.get

ค่าการค้นหาการตั้งค่า

คําขอ SearchSettingsValues

ช่อง
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

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

การตั้งค่าการค้นหาค่า

คําตอบจาก SearchSettingsValues

ช่อง
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 ได้รับหากไม่ได้ตั้งค่าไว้อย่างชัดเจน

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

ประเภทข้อมูล

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

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

การตั้งค่า

สร้างอินสแตนซ์ของการตั้งค่า ค่าการตั้งค่าแต่ละค่านั้นมีการตั้งค่าที่ตรงกัน

ช่อง
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

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

อัปเดตSettingsValueRequest

คําขอสําหรับอัปเดตการตั้งค่า

ช่อง
setting_value

SettingValue

ค่าที่ต้องการอัปเดต โปรดดู SettingValue สําหรับข้อกําหนดเกี่ยวกับช่อง

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

  • resourcesettings.settingvalues.update

ค่า

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

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

bool

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

string

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

StringSet

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

ชุดสตริง

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

ช่อง
values[]

string

สตริงในชุด