Trang này được dịch bởi Cloud Translation API.

Package google.cloud.resourcesettings.v1alpha1

Chỉ mục

ResourceSettingsService (giao diện)
CreateSettingValueRequest (thông báo)
DeleteSettingValueRequest (thông báo)
GetSettingValueRequest (thông báo)
ListSettingsRequest (thông báo)
ListSettingsResponse (thông báo)
LookupEffectiveSettingValueRequest (thông báo)
SearchSettingValuesRequest (thông báo)
SearchSettingValuesResponse (thông báo)
Setting (thông báo)
Setting.DataType (enum)
SettingValue (thông báo)
UpdateSettingValueRequest (thông báo)
Value (thông báo)
Value.StringSet (thông báo)

Dịch vụ cài đặt tài nguyên

Một giao diện để tương tác với các chế độ cài đặt tài nguyên và đặt giá trị 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 thức hoạt động của tài nguyên. Các giá trị cài đặt áp dụng cho một tài nguyên trên đám mây nhất định được đánh giá theo cấp bậc và kế thừa từ tất cả các thành phần con của tài nguyên đó.

Đối với tất cả các yêu cầu, hãy trả về một google.rpc.Status với 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 thuộc một tổ chức đám mây. Đối với tất cả các yêu cầu, trả về google.rpc.Status với google.rpc.Code.INVALID_ARGUMENT nếu yêu cầu không đúng định dạng.

Lưu ý: Đối với tất cả các chế độ Cài đặt giai đoạn alpha, Chế độ cài đặt này không tồn tại trong bất kỳ tài nguyên nào trong các Tổ chức đám mây không phải alpha.

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

Tạo giá trị cài đặt
`rpc CreateSettingValue(CreateSettingValueRequest) returns (SettingValue)` Tạo giá trị cài đặt. Trả về `google.rpc.Status` có `google.rpc.Code.NOT_FOUND` nếu không có tuỳ chọn cài đặt này. Trả về `google.rpc.Status` bằng `google.rpc.Code.ALREADY_EXISTS` nếu giá trị cài đặt đã tồn tại trên tài nguyên Cloud nhất định. 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 phần Tổng quan về quy trình xác thực.

rpc CreateSettingValue(CreateSettingValueRequest) returns (SettingValue)

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

Trả về google.rpc.Status có google.rpc.Code.NOT_FOUND nếu không có tuỳ chọn cài đặt này. Trả về google.rpc.Status bằng google.rpc.Code.ALREADY_EXISTS nếu giá trị cài đặt đã tồn tại trên tài nguyên Cloud nhất định. 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 phần Tổng quan về quy trình xác thực.

Xóa giá trị cài đặt

Xóa giá trị cài đặt
`rpc DeleteSettingValue(DeleteSettingValueRequest) returns (Empty)` Xóa giá trị cài đặt. Nếu giá trị cài đặt không tồn tại, thì thao tác này không hoạt động. Trả về `google.rpc.Status` với `google.rpc.Code.NOT_FOUND` nếu chế độ cài đặt hoặc giá trị cài đặt không tồn tại. Giá trị cài đặt sẽ không tồn tại nếu lệnh gọi trước đó đến `DeleteSetting` cho giá trị 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 phần Tổng quan về quy trình xác thực.

rpc DeleteSettingValue(DeleteSettingValueRequest) returns (Empty)

Xóa giá trị cài đặt. Nếu giá trị cài đặt không tồn tại, thì thao tác này không hoạt động.

Trả về google.rpc.Status với google.rpc.Code.NOT_FOUND nếu chế độ cài đặt hoặc giá trị cài đặt không tồn tại. Giá trị cài đặt sẽ không tồn tại nếu lệnh gọi trước đó đến DeleteSetting cho giá trị 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 phần Tổng quan về quy trình xác thực.

Nhận giá trị cài đặt

Nhận giá trị cài đặt
`rpc GetSettingValue(GetSettingValueRequest) returns (SettingValue)` Xem giá trị chế độ cài đặt. Trả về `google.rpc.Status` bằng `google.rpc.Code.NOT_FOUND` nếu giá trị 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 phần Tổng quan về quy trình xác thực.

rpc GetSettingValue(GetSettingValueRequest) returns (SettingValue)

Xem giá trị chế độ cài đặt.

Trả về google.rpc.Status bằng google.rpc.Code.NOT_FOUND nếu giá trị 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 phần Tổng quan về quy trình xác thực.

ListSettings (Cài đặt danh sách)

ListSettings (Cài đặt danh sách)
`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 phần Tổng quan về quy trình xác thực.

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 phần Tổng quan về quy trình xác thực.

LOOKEffectSettingValue

LOOKEffectSettingValue
`rpc LookupEffectiveSettingValue(LookupEffectiveSettingValueRequest) returns (SettingValue)` Tính toán giá trị cài đặt hiệu quả của một cài đặt tại tài nguyên đám mây `parent`. Giá trị cài đặt hiệu quả là giá trị cài đặt được tính toán tại tài nguyên trên đám mây và có giá trị là một trong các tùy chọn sau theo thứ tự nhất định (tùy chọn tiếp theo được sử dụng nếu tùy chọn trước đó không tồn tại): giá trị cài đặt của một tài nguyên cụ thể giá trị cài đặt trên đối tượng cấp trên gần nhất của tài nguyên nhất định giá trị mặc định của cài đặt một giá trị cài đặt trống được định nghĩa là `SettingValue` với tất cả các trường không được đặt Trả về `google.rpc.Status` có `google.rpc.Code.NOT_FOUND` nếu không có tuỳ chọn cài đặt nà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 phần Tổng quan về quy trình xác thực.

rpc LookupEffectiveSettingValue(LookupEffectiveSettingValueRequest) returns (SettingValue)

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

giá trị cài đặt của một tài nguyên cụ thể
giá trị cài đặt trên đối tượng cấp trên gần nhất của tài nguyên nhất định
giá trị mặc định của cài đặt
một giá trị cài đặt trống được định nghĩa là SettingValue với tất cả các trường không được đặt

Trả về google.rpc.Status có google.rpc.Code.NOT_FOUND nếu không có tuỳ chọn cài đặt nà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 phần Tổng quan về quy trình xác thực.

Giá trị cài đặt tìm kiếm

Giá trị cài đặt tìm kiếm
`rpc SearchSettingValues(SearchSettingValuesRequest) returns (SearchSettingValuesResponse)` Tìm kiếm tất cả các giá trị cài đặt tồn tại trên tài nguyên `parent`. Giá trị của chế độ cài đặt này không bị giới hạn ở những 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 phần Tổng quan về quy trình xác thực.

rpc SearchSettingValues(SearchSettingValuesRequest) returns (SearchSettingValuesResponse)

Tìm kiếm tất cả các giá trị cài đặt tồn tại trên tài nguyên parent. Giá trị của chế độ cài đặt này không bị giới hạn ở những 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 phần Tổng quan về quy trình xác thực.

Cập nhật giá trị cài đặt

Cập nhật giá trị cài đặt
`rpc UpdateSettingValue(UpdateSettingValueRequest) returns (SettingValue)` Cập nhật giá trị cài đặt. Trả về `google.rpc.Status` với `google.rpc.Code.NOT_FOUND` nếu chế độ cài đặt hoặc giá trị 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` với `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ị cài đặt. Lưu ý: giá trị cài đặt được cung cấp sẽ thực hiện ghi đè đầy đủ 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 phần Tổng quan về quy trình xác thực.

rpc UpdateSettingValue(UpdateSettingValueRequest) returns (SettingValue)

Cập nhật giá trị cài đặt.

Trả về google.rpc.Status với google.rpc.Code.NOT_FOUND nếu chế độ cài đặt hoặc giá trị 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 với 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ị cài đặt.

Lưu ý: giá trị cài đặt được cung cấp sẽ thực hiện ghi đè đầy đủ 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 phần Tổng quan về quy trình xác thực.

Tạo giá trị yêu cầu

Yêu cầu tạo CreateSettingValue.

Các trường

Các trường
`setting_value`	`SettingValue` Giá trị cài đặt để tạo. Hãy xem `SettingValue` để biết các yêu cầu của trường. Việc uỷ quyền đòi hỏi quyền IAM sau đây trên tài nguyên được chỉ định `settingValue`: `resourcesettings.settingvalues.create`

setting_value

SettingValue

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

Việc uỷ quyền đòi hỏi quyền IAM sau đây trên tài nguyên được chỉ định settingValue:

resourcesettings.settingvalues.create

DeleteSettingValueRequest

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

Các trường

Các trường
`name`	`string` Tên của giá trị cài đặt cần xoá. Xem `SettingValue` để biết yêu cầu đặt tên. Việc uỷ quyền đòi hỏi quyền IAM sau đây trên tài nguyên được chỉ định `name`: `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: Hãy tự chịu rủi ro khi sử dụng. Bạn không thể huỷ thao tác xoá chế độ cài đặt chỉ có thể đọc này (tức là không thể tạo lại thao tác này).

name

string

Tên của giá trị cài đặt cần xoá. Xem SettingValue để biết yêu cầu đặt tên.

Việc uỷ quyền đòi hỏi quyền IAM sau đây trên tài nguyên được chỉ định name:

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: Hãy tự chịu rủi ro khi sử dụng. Bạn không thể huỷ thao tác xoá chế độ cài đặt chỉ có thể đọc này (tức là không thể tạo lại thao tác này).

Nhận giá trị đặt giá trị

Yêu cầu cho GetSettingValue.

Các trường

Các trường
`name`	`string` Tên của giá trị cài đặt cần nhận. Xem `SettingValue` để biết yêu cầu đặt tên. Việc uỷ quyền đòi hỏi quyền IAM sau đây trên tài nguyên được chỉ định `name`: `resourcesettings.settingvalues.get`

name

string

Tên của giá trị cài đặt cần nhận. Xem SettingValue để biết yêu cầu đặt tên.

Việc uỷ quyền đòi hỏi quyền IAM sau đây trên tài nguyên được chỉ định name:

resourcesettings.settingvalues.get

ListSettingsRequest

Yêu cầu đối với ListSettings (Cài đặt).

Các trường

Các trường
`parent`	`string` Tài nguyên trên đám mây tạo thành phần cài đặt mẹ. Phải ở một trong các dạng sau: `projects/{project_number}` `projects/{project_id}` `folders/{folder_id}` `organizations/{organization_id}` Việc uỷ quyền đòi hỏi quyền IAM sau đây trên tài nguyên được chỉ định `parent`: `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.

parent

string

Tài nguyên trên đám mây tạo thành phần cài đặt mẹ. Phải ở một trong các dạng sau:

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

Việc uỷ quyền đòi hỏi quyền IAM sau đây trên tài nguyên được chỉ định parent:

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.

Các trường

Các trường
`settings[]`	`Setting` Danh sách chế độ cài đặt có trên tài nguyên Cloud đã 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.

settings[]

Setting

Danh sách chế độ cài đặt có trên tài nguyên Cloud đã 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.

lookupEffectSettingValueRequest

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

Các trường

Các trường
`parent`	`string` Chế độ cài đặt mà giá trị hiệu quả sẽ được đánh giá. Xem `Setting` để biết yêu cầu đặt tên. Việc uỷ quyền đòi hỏi quyền IAM sau đây trên tài nguyên được chỉ định `parent`: `resourcesettings.settingvalues.get`

parent

string

Chế độ cài đặt mà giá trị hiệu quả sẽ được đánh giá. Xem Setting để biết yêu cầu đặt tên.

Việc uỷ quyền đòi hỏi quyền IAM sau đây trên tài nguyên được chỉ định parent:

resourcesettings.settingvalues.get

Yêu cầu giá trị cài đặt tìm kiếm

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

Các trường

Các trường
`parent`	`string` Tài nguyên trên đám mây tạo thành phần cài đặt mẹ. Phải ở một trong các dạng sau: `projects/{project_number}` `projects/{project_id}` `folders/{folder_id}` `organizations/{organization_id}` Việc uỷ quyền đòi hỏi quyền IAM sau đây trên tài nguyên được chỉ định `parent`: `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.

parent

string

Tài nguyên trên đám mây tạo thành phần cài đặt mẹ. Phải ở một trong các dạng sau:

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

Việc uỷ quyền đòi hỏi quyền IAM sau đây trên tài nguyên được chỉ định parent:

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.

Phản hồi giá trị cài đặt tìm kiếm

Phản hồi từ SearchSettingValues.

Các trường

Các trường
`setting_values[]`	`SettingValue` Tất cả giá trị cài đặt hiện có trên 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.

setting_values[]

SettingValue

Tất cả giá trị cài đặt hiện có trên 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.

Chế độ cài đặt

Giản đồ đặt giá trị. Ở một tài nguyên Cloud cụ thể, mỗi chế độ cài đặt chỉ có thể chứa một giá trị cài đặt.

Các trường
`name`	`string` Tên tài nguyên của chế độ cài đặt này. Phải ở 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 dễ đọc của chế độ cài đặt này.
`description`	`string` Mô tả chi tiết về chức năng của chế độ cài đặt này.
`read_only`	`bool` Cờ cho biết rằng không thể sửa đổi các giá trị của cài đặt này (xem tài liệu về cài đặt cụ thể cho nội dung cập nhật và lý do); tuy nhiên, có thể xóa 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à thông báo xác nhận rằng giá trị cài đặt không thể tạo lại được. Hãy xem `DeleteSettingValueRequest.ignore_read_only` để biết thêm chi tiết.
`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 không có giá trị cài đặt nào được đặt rõ ràng. Lưu ý: không phải tất cả các tùy chọn cài đặt đều có giá trị mặc định.

Loại dữ liệu

Loại dữ liệu cho các giá trị cài đặt của chế độ cài đặt này. Vui lòng 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`	Chế độ cài đặt boolean.
`STRING`	Một chế độ cài đặt chuỗi.
`STRING_SET`	Một chế độ cài đặt chuỗi.

Giá trị cài đặt

Tạo bản sao của một chế độ cài đặt. Mọi giá trị chế độ cài đặt đều sử dụng chế độ cài đặt tương ứng.

Các trường
`name`	`string` Tên tài nguyên của giá trị cài đặt. Phải ở 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 này. 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 mẹ xác định.
`etag`	`string` Tệp tham chiếu được dùng để đồng thời lạc quan. Hãy xem `UpdateSettingValue` để biết thêm chi tiết.
`read_only`	`bool` Chỉ đầu ra. Một cờ cho biết không thể sửa đổi giá trị cài đặt này; tuy nhiên, có thể xóa giá trị này bằng cách sử dụng `DeleteSettingValue` nếu `DeleteSettingValueRequest.ignore_read_only` được đặt thành đúng. Việc sử dụng cờ này được coi là thông báo xác nhận rằng giá trị cài đặt không thể tạo lại được. Cờ này được kế thừa từ chế độ cài đặt gốc và nhằm mục đích thuận tiện. Hãy xem `Setting.read_only` để biết thêm chi tiết.
`update_time`	`Timestamp` Chỉ đầu ra. Dấu thời gian cho biết thời điểm giá trị cài đặt được cập nhật lần cuối.

UpdateSettingValueRequest

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

Các trường

Các 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 của trường. Việc uỷ quyền đòi hỏi quyền IAM sau đây trên tài nguyên được chỉ định `settingValue`: `resourcesettings.settingvalues.update`

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 của trường.

Việc uỷ quyền đòi hỏi quyền IAM sau đây trên tài nguyên được chỉ định settingValue:

resourcesettings.settingvalues.update

Giá trị

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

Các trường
Trường liên kết `value`. Chọn loại dữ liệu và giá trị có liên quan. `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à một giá trị boolean.
`string_value`	`string` Xác định giá trị này là một giá trị chuỗi.
`string_set_value`	`StringSet` Xác định giá trị này là một StringSet.

Chuỗi

Một giá trị tập hợp chuỗi có thể chứa 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 tập hợp chuỗi.

Các trường

Các trường
`values[]`	`string` Chuỗi trong tập hợp

values[]

string

Chuỗi trong tập hợp