Package google.cloud.resourcesettings.v1alpha1

Chỉ mục

ResourceSettingsService

Một giao diện để tương tác với các chế độ cài đặt tài nguyên và giá trị cài đặt trong toàn bộ hệ thống phân cấp tài nguyên.

Các dịch vụ có thể hiển thị một số chế độ cài đặt để người dùng kiểm soát cách hoạt động của tài nguyên. Các giá trị cài đặt được áp dụng cho một tài nguyên cụ thể trên đám mây sẽ được đánh giá theo hệ thống phân cấp và được tất cả các thành phần con của tài nguyên đó kế thừa.

Đối với tất cả các yêu cầu, hãy trả về google.rpc.Status có google.rpc.Code.PERMISSION_DENIED nếu quá trình kiểm tra IAM không thành công hoặc tài nguyên parent không nằm trong Tổ chức trên đám mây. Đối với tất cả các yêu cầu, hãy trả về google.rpc.Status có google.rpc.Code.INVALID_ARGUMENT nếu yêu cầu có định dạng không hợp lệ.

Lưu ý: Đối với tất cả các chế độ cài đặt ở giai đoạn alpha, Chế độ cài đặt không tồn tại trong bất kỳ tài nguyên nào trong Cloud Organizations không ở giai đoạn alpha.

CreateSettingValue

rpc CreateSettingValue(CreateSettingValueRequest) returns (SettingValue)

Tạo một giá trị cài đặt.

Trả về google.rpc.Status có google.rpc.Code.NOT_FOUND nếu chế độ cài đặt không tồn tại. Trả về một google.rpc.Status có google.rpc.Code.ALREADY_EXISTS nếu giá trị cài đặt đã tồn tại trên Tài nguyên đám mây đã cho. Trả về google.rpc.Status có google.rpc.Code.FAILED_PRECONDITION nếu chế độ cài đặt được gắn cờ là chỉ đọc.

Phạm vi cấp phép

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

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

Để biết thêm thông tin, hãy xem bài viết Tổng quan về quy trình xác thực.
DeleteSettingValue

rpc DeleteSettingValue(DeleteSettingValueRequest) returns (Empty)

Xoá một giá trị cài đặt. Nếu giá trị cài đặt không tồn tại, thì thao tác sẽ không hoạt động.

Trả về google.rpc.Status có google.rpc.Code.NOT_FOUND nếu chế độ cài đặt hoặc giá trị của chế độ cài đặt không tồn tại. Giá trị của chế độ cài đặt sẽ không tồn tại nếu một lệnh gọi trước đó đến DeleteSetting cho giá trị của chế độ cài đặt đã trả về mã thành công. Trả về google.rpc.Status có google.rpc.Code.FAILED_PRECONDITION nếu chế độ cài đặt được gắn cờ là chỉ đọc.

Phạm vi cấp phép

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

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

Để biết thêm thông tin, hãy xem bài viết Tổng quan về quy trình xác thực.
GetSettingValue

rpc GetSettingValue(GetSettingValueRequest) returns (SettingValue)

Lấy một giá trị cài đặt.

Trả về google.rpc.Status có google.rpc.Code.NOT_FOUND nếu giá trị của chế độ cài đặt không tồn tại.

Phạm vi cấp phép

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

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

Để biết thêm thông tin, hãy xem bài viết Tổng quan về quy trình xác thực.
ListSettings

rpc ListSettings(ListSettingsRequest) returns (ListSettingsResponse)

Liệt kê tất cả các chế độ cài đặt có trên tài nguyên parent trên đám mây.

Phạm vi cấp phép

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

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

Để biết thêm thông tin, hãy xem bài viết Tổng quan về quy trình xác thực.
LookupEffectiveSettingValue

rpc LookupEffectiveSettingValue(LookupEffectiveSettingValueRequest) returns (SettingValue)

Tính toán giá trị chế độ cài đặt có hiệu lực của một chế độ cài đặt tại tài nguyên trên Cloud parent. Giá trị chế độ cài đặt có hiệu lực là giá trị chế độ cài đặt được tính toán tại một tài nguyên trên đám mây và đánh giá thành một trong các lựa chọn sau theo thứ tự đã cho (lựa chọn tiếp theo sẽ được dùng nếu lựa chọn trước đó không tồn tại):

  1. giá trị của chế độ cài đặt trên tài nguyên đã cho
  2. giá trị của chế độ cài đặt trên tổ tiên gần nhất của tài nguyên đã cho
  3. giá trị mặc định của chế độ cài đặt
  4. một giá trị chế độ cài đặt trống, được xác định là một SettingValue với tất cả các trường chưa được đặt

Trả về google.rpc.Status có google.rpc.Code.NOT_FOUND nếu chế độ cài đặt không tồn tại.

Phạm vi cấp phép

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

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

Để biết thêm thông tin, hãy xem bài viết Tổng quan về quy trình xác thực.
SearchSettingValues

rpc SearchSettingValues(SearchSettingValuesRequest) returns (SearchSettingValuesResponse)

Tìm kiếm tất cả các giá trị cài đặt có trên tài nguyên parent. Các giá trị của chế độ cài đặt không bị giới hạn ở các giá trị của một chế độ cài đặt cụ thể.

Phạm vi cấp phép

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

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

Để biết thêm thông tin, hãy xem bài viết Tổng quan về quy trình xác thực.
UpdateSettingValue

rpc UpdateSettingValue(UpdateSettingValueRequest) returns (SettingValue)

Cập nhật giá trị của một chế độ cài đặt.

Trả về google.rpc.Status có google.rpc.Code.NOT_FOUND nếu chế độ cài đặt hoặc giá trị của chế độ cài đặt không tồn tại. Trả về google.rpc.Status có google.rpc.Code.FAILED_PRECONDITION nếu chế độ cài đặt được gắn cờ là chỉ đọc. Trả về google.rpc.Status có google.rpc.Code.ABORTED nếu etag được cung cấp trong yêu cầu không khớp với etag được duy trì của giá trị chế độ cài đặt.

Lưu ý: giá trị chế độ cài đặt được cung cấp sẽ ghi đè hoàn toàn tất cả các trường.

Phạm vi cấp phép

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

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

Để biết thêm thông tin, hãy xem bài viết Tổng quan về quy trình xác thực.

CreateSettingValueRequest

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

Trường
setting_value

SettingValue

Giá trị cài đặt cần tạo. Hãy xem SettingValue để biết các yêu cầu về trường.

Để uỷ quyền, bạn cần có quyền IAM sau đây trên tài nguyên settingValue được chỉ định:

  • resourcesettings.settingvalues.create

DeleteSettingValueRequest

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

Trường
name

string

Tên của giá trị chế độ cài đặt cần xoá. Hãy xem SettingValue để biết các yêu cầu về việc đặt tên.

Để uỷ quyền, bạn cần có quyền IAM sau đây trên tài nguyên name được chỉ định:

  • resourcesettings.settingvalues.delete
ignore_read_only

bool

Một cờ cho phép xoá giá trị của chế độ cài đặt read_only. CẢNH BÁO: bạn tự chịu rủi ro khi sử dụng. Xoá giá trị của chế độ cài đặt chỉ đọc là một thao tác không thể đảo ngược (tức là bạn không thể tạo lại).

GetSettingValueRequest

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

Trường
name

string

Tên của giá trị chế độ cài đặt cần lấy. Hãy xem SettingValue để biết các yêu cầu về việc đặt tên.

Để uỷ quyền, bạn cần có quyền IAM sau đây trên tài nguyên name được chỉ định:

  • resourcesettings.settingvalues.get

ListSettingsRequest

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

Trường
parent

string

Tài nguyên trên đám mây là tài nguyên mẹ của chế độ cài đặt. Phải có một trong các dạng sau:

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

Để uỷ quyền, bạn cần có quyền IAM sau đây trên tài nguyên parent được chỉ định:

  • resourcesettings.settings.list
page_size

int32

Không sử dụng. Kích thước của trang sẽ được trả về.
page_token

string

Không sử dụng. Mã thông báo trang dùng để truy xuất trang tiếp theo.

ListSettingsResponse

Phản hồi từ ListSettings.

Trường
settings[]

Setting

Danh sách các chế độ cài đặt có sẵn tại tài nguyên Cloud được chỉ định.
next_page_token

string

Không sử dụng. Mã thông báo trang dùng để truy xuất trang tiếp theo.

LookupEffectiveSettingValueRequest

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

Trường
parent

string

Chế độ cài đặt mà giá trị có hiệu lực sẽ được đánh giá. Hãy xem Setting để biết các yêu cầu về việc đặt tên.

Để uỷ quyền, bạn cần có quyền IAM sau đây trên tài nguyên parent được chỉ định:

  • resourcesettings.settingvalues.get

SearchSettingValuesRequest

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

Trường
parent

string

Tài nguyên trên đám mây là tài nguyên mẹ của chế độ cài đặt. Phải có một trong các dạng sau:

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

Để uỷ quyền, bạn cần có quyền IAM sau đây trên tài nguyên parent được chỉ định:

  • resourcesettings.settingvalues.list
page_size

int32

Không sử dụng. Kích thước của trang sẽ được trả về.
page_token

string

Không sử dụng. Mã thông báo trang dùng để truy xuất trang tiếp theo.

SearchSettingValuesResponse

Phản hồi từ SearchSettingValues.

Trường
setting_values[]

SettingValue

Tất cả các giá trị cài đặt có trên tài nguyên Đám mây được chỉ định.
next_page_token

string

Không sử dụng. Mã thông báo trang dùng để truy xuất trang tiếp theo.

Cài đặt

Giản đồ để đặt giá trị. Tại một tài nguyên Đám mây nhất định, một chế độ cài đặt có thể có tối đa một giá trị cài đặt gốc.

Trường
name

string

Tên tài nguyên của chế độ cài đặt. Phải có một trong các dạng sau:

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

Ví dụ: "/projects/123/settings/gcp-enableMyFeature"
display_name

string

Tên mà con người dễ đọc cho chế độ cài đặt này.
description

string

Nội dung mô tả chi tiết về chức năng của chế độ cài đặt này.
read_only

bool

Một cờ cho biết bạn không thể sửa đổi các giá trị của chế độ cài đặt này (xem tài liệu về chế độ cài đặt cụ thể để biết thông tin cập nhật và lý do); tuy nhiên, bạn có thể xoá chế độ cài đặt này bằng cách sử dụng DeleteSettingValue nếu DeleteSettingValueRequest.ignore_read_only được đặt thành true. Việc sử dụng cờ này được coi là một lời xác nhận rằng bạn không thể tạo lại giá trị của chế độ cài đặt. Hãy xem DeleteSettingValueRequest.ignore_read_only để biết thêm thông tin.
data_type

DataType

Loại dữ liệu cho chế độ cài đặt này.
default_value

Value

Giá trị mà LookupEffectiveSettingValue nhận được nếu bạn không đặt rõ ràng giá trị chế độ cài đặt.

Lưu ý: không phải chế độ cài đặt nào cũng có giá trị mặc định.

DataType

Loại dữ liệu để đặt giá trị của chế độ cài đặt này. Hãy xem Value để biết thêm thông tin chi tiết về các loại dữ liệu có sẵn.

Enum
DATA_TYPE_UNSPECIFIED Loại dữ liệu không xác định.
BOOLEAN Một chế độ cài đặt boolean.
STRING Chế độ cài đặt chuỗi.
STRING_SET Chế độ cài đặt bộ chuỗi.

SettingValue

Việc thực hiện một chế độ cài đặt. Mọi giá trị cài đặt đều được liên kết với chế độ cài đặt tương ứng.

Trường
name

string

Tên tài nguyên của giá trị chế độ cài đặt. Phải có một trong các dạng sau:

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

Ví dụ: "/projects/123/settings/gcp-enableMyFeature/value"
value

Value

Giá trị của chế độ cài đặt. Loại dữ liệu của Value phải luôn nhất quán với loại dữ liệu do chế độ cài đặt chính xác định.
etag

string

Dấu vân tay dùng cho tính năng đồng thời lạc quan. Hãy xem UpdateSettingValue để biết thêm chi tiết.
read_only

bool

Chỉ có đầu ra. Một cờ cho biết bạn không thể sửa đổi giá trị của chế độ cài đặt này; tuy nhiên, bạn có thể xoá giá trị này bằng cách sử dụng DeleteSettingValue nếu DeleteSettingValueRequest.ignore_read_only được đặt thành true. Việc sử dụng cờ này được coi là một lời xác nhận rằng bạn không thể tạo lại giá trị của chế độ cài đặt. Cờ này được kế thừa từ chế độ cài đặt gốc và chỉ nhằm mục đích cho thuận tiện. Hãy xem Setting.read_only để biết thêm thông tin.
update_time

Timestamp

Chỉ có đầu ra. Dấu thời gian cho biết thời điểm gần đây nhất giá trị của chế độ cài đặt được cập nhật.

UpdateSettingValueRequest

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

Trường
setting_value

SettingValue

Giá trị cài đặt cần cập nhật. Hãy xem SettingValue để biết các yêu cầu về trường.

Để uỷ quyền, bạn cần có quyền IAM sau đây trên tài nguyên settingValue được chỉ định:

  • resourcesettings.settingvalues.update

Giá trị

Dữ liệu trong một giá trị cài đặt.

Trường
Trường nhóm value. Chọn loại dữ liệu và giá trị được liên kết. value chỉ có thể là một trong những trạng thái sau:
boolean_value

bool

Xác định giá trị này là giá trị boolean.
string_value

string

Xác định giá trị này là giá trị chuỗi.
string_set_value

StringSet

Xác định giá trị này là một StringSet.

StringSet

Một giá trị tập hợp chuỗi có thể lưu giữ một tập hợp các chuỗi. Độ dài tối đa của mỗi chuỗi là 60 ký tự và có thể có tối đa 50 chuỗi trong bộ chuỗi.

Trường
values[]

string

Các chuỗi trong tập hợp