功能介紹
修改網關型終端節(jié)點policy。
調試
您可以在API Explorer中調試該接口，支持自動認證鑒權。API Explorer可以自動生成SDK代碼示例，并提供SDK代碼示例調試功能。
URI
PUT /v1/{project_id}/vpc-endpoints/{vpc_endpoint_id}/policy
|
參數 |
是否必選 |
參數類型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
項目ID 最小長度：1 最大長度：64 |
|
vpc_endpoint_id |
是 |
String |
終端節(jié)點的ID。 最小長度：1 最大長度：64 |
請求參數
|
參數 |
是否必選 |
參數類型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
用戶Token。通過調用 IAM 服務獲取用戶Token接口獲取(響應消息頭中X-Subject-Token的值)。 最小長度：1 最大長度：2048 |
|
Content-Type |
否 |
String |
發(fā)送的實體的MIME類型。推薦用戶默認使用application/json， 如果API是對象、 鏡像 上傳等接口，媒體類型可按照流類型的不同進行確定。 缺省值：application/json 最小長度：1 最大長度：64 |
|
參數 |
是否必選 |
參數類型 |
描述 |
|---|---|---|---|
|
policy_statement |
是 |
只涉及開啟雙端固定的網關型終端節(jié)點 |
響應參數
狀態(tài)碼： 200
|
參數 |
參數類型 |
描述 |
|---|---|---|
|
id |
String |
終端節(jié)點的ID，唯一標識。 |
|
service_type |
String |
終端節(jié)點連接的終端節(jié)點服務類型。 ● gataway：由運維人員配置。用戶無需創(chuàng)建，可直接使用。 ● interface：包括運維人員配置的云服務和用戶自己創(chuàng)建的私有服務。 其中，運維人員配置的云服務無需創(chuàng)建，用戶可直接使用。 您可以通過查詢公共終端節(jié)點服務列表， 查看由運維人員配置的所有用戶可見且可連接的終端節(jié)點服務， 并通過創(chuàng)建終端節(jié)點服務創(chuàng)建Interface類型的終端節(jié)點服務。 |
|
status |
String |
終端節(jié)點的連接狀態(tài)。 ● pendingAcceptance：待接受 ● creating：創(chuàng)建中 ● accepted：已接受 ● failed：失敗 |
|
active_status |
Array of strings |
帳號狀態(tài)。 ● frozen：凍結 ● active：解凍 |
|
endpoint_service_name |
String |
終端節(jié)點服務的名稱。 |
|
marker_id |
Integer |
終端節(jié)點的報文標識。 |
|
endpoint_service_id |
String |
終端節(jié)點服務的ID。 |
|
enable_dns |
Boolean |
是否創(chuàng)建域名。 ● true：創(chuàng)建域名 ● false：不創(chuàng)建域名 說明 當創(chuàng)建連接gateway類型終端節(jié)點服務的終端節(jié)點時， “enable_dns”設置為true或者false，均不創(chuàng)建域名。 |
|
dns_names |
Array of strings |
訪問所連接的終端節(jié)點服務的域名。 當“enable_dns”為true時，該參數可見。 |
|
ip |
String |
訪問所連接的終端節(jié)點服務的IP。 僅當同時滿足如下條件時，返回該參數： 當查詢連接interface類型終端節(jié)點服務的終端節(jié)點時。 終端節(jié)點服務啟用“連接審批”功能，且已經“接受”連接審批。 “status”可以是“accepted”或者“rejected（僅支持“接受”連接審批后再“拒絕”的情況）”。 |
|
vpc_id |
String |
終端節(jié)點所在的VPC的ID。 |
|
subnet_id |
String |
vpc_id對應VPC下已創(chuàng)建的網絡（network）的ID，UUID格式。 |
|
created_at |
String |
終端節(jié)點的創(chuàng)建時間。 采用UTC時間格式，格式為：YYYY-MM-DDTHH:MM:SSZ |
|
updated_at |
String |
終端節(jié)點的更新時間。 采用UTC時間格式，格式為：YYYY-MM-DDTHH:MM:SSZ |
|
project_id |
String |
項目ID，獲取方法請參見獲取項目ID。 |
|
tags |
標簽列表，沒有標簽默認為空數組。 |
|
|
error |
錯誤信息。 當終端節(jié)點狀態(tài)異常，即“status”的值為“failed”時，會返回該字段。 |
|
|
whitelist |
Array of strings |
控制訪問終端節(jié)點的白名單。 若未創(chuàng)建，則返回空列表。 創(chuàng)建連接Interface類型終端節(jié)點服務的終端節(jié)點時，顯示此參數。 |
|
enable_whitelist |
Boolean |
是否開啟網絡ACL隔離。 ● true：開啟網絡ACL隔離 ● false：不開啟網絡ACL隔離 若未指定，則返回false。 創(chuàng)建連接Interface類型終端節(jié)點服務的終端節(jié)點時，顯示此參數。 |
|
routetables |
Array of strings |
路由表ID列表。 若未指定，返回默認VPC下路由表ID。 創(chuàng)建連接Gateway類型終端節(jié)點服務的終端節(jié)點時，顯示此參數。 |
|
description |
String |
描述字段，支持中英文字母、數字等字符，不支持“<”或“>”字符。 |
|
policy_statement |
只涉及開啟雙端固定的網關型終端節(jié)點，響應體展示此字段 |
|
|
endpoint_pool_id |
String |
待廢棄，實例相關聯(lián)的集群ID |
|
public_border_group |
String |
終端節(jié)點關聯(lián)的Public Border Group信息，只有當終端節(jié)點和邊緣Pool相關聯(lián)時才會返回改字段 |
|
參數 |
參數類型 |
描述 |
|---|---|---|
|
key |
String |
鍵。 最大長度36個unicode字符。 key不能為空。不能包含“=”、“*”、“<”、“>”、“\”、“,”、“|”和“/”，且首尾字符不能為空格。 最小長度：1 最大長度：36 |
|
value |
String |
值。 每個值最大長度43個unicode字符，可以為空字符串。 不能包含“=”、“*”、“<”、“>”、“\”、“,”、“|”和“/”，且首尾字符不能為空格。 最小長度：1 最大長度：43 |
|
參數 |
參數類型 |
描述 |
|---|---|---|
|
Effect |
String |
允許或拒絕，控制訪問權限 |
|
Action |
Array of strings |
obs訪問權限 |
|
Resource |
Array of strings |
obs對象 |
狀態(tài)碼： 400
狀態(tài)碼： 401
狀態(tài)碼： 403
狀態(tài)碼： 404
狀態(tài)碼： 405
狀態(tài)碼： 406
狀態(tài)碼： 407
狀態(tài)碼： 408
狀態(tài)碼： 409
狀態(tài)碼： 500
狀態(tài)碼： 501
狀態(tài)碼： 502
狀態(tài)碼： 503
狀態(tài)碼： 504
請求示例
修改網關型終端節(jié)點policy，設置OBS訪問權限和OBS對象并允許訪問。
PUT https://{endpoint}/v1/{project_id}/vpc-endpoints/938c8167-631e-40a4-99f9-493753fbd16b/policy
{
"policy_statement" : [ {
"Action" : [ "obs:*:*" ],
"Resource" : [ "obs:*:*:*:*/*", "obs:*:*:*:*" ],
"Effect" : "Allow"
} ]
}
響應示例
狀態(tài)碼： 200
服務器已成功處理了請求
{
"id" : "938c8167-631e-40a4-99f9-493753fbd16b",
"status" : "accepted",
"tags" : [ ],
"marker_id" : 302035929,
"active_status" : [ "active" ],
"vpc_id" : "0da03835-1dcf-4361-9b87-34139d58dd59",
"service_type" : "gateway",
"project_id" : "0605767a3300d5762fb7c0186d9e1779",
"routetables" : [ "99477d3b-87f6-49d2-8f3b-2ffc72731a38" ],
"created_at" : "2022-08-03T03:03:54Z",
"updated_at" : "2022-08-03T03:03:57Z",
"endpoint_service_id" : "4651bc78-5cec-41b7-b448-f77326ebbed0",
"endpoint_service_name" : "br-abc-aaa1.obs_test.4651bc78-5cec-41b7-b448-f77326ebbed0",
"policy_statement" : [ {
"Action" : [ "obs:*:*" ],
"Resource" : [ "obs:*:*:*:*/*", "obs:*:*:*:*" ],
"Effect" : "Allow"
} ],
"description" : "",
"endpoint_pool_id" : "b0ad6a4f-55c0-43f1-a26d-278639661fc2"
}
狀態(tài)碼
|
狀態(tài)碼 |
描述 |
|---|---|
|
200 |
服務器已成功處理了請求 |
|
400 |
服務器未能處理請求 |
|
401 |
被請求的頁面需要用戶名和密碼 |
|
403 |
對被請求頁面的訪問被禁止 |
|
404 |
服務器無法找到被請求的頁面 |
|
405 |
請求中指定的方法不被允許 |
|
406 |
服務器生成的響應無法被客戶端所接受 |
|
407 |
用戶必須首先使用代理服務器進行驗證，這樣請求才會被處理 |
|
408 |
請求超出了服務器的等待時間 |
|
409 |
由于沖突，請求無法被完成 |
|
500 |
請求未完成。服務異常 |
|
501 |
請求未完成。服務器不支持所請求的功能 |
|
502 |
請求未完成。服務器從上游服務器收到一個無效的響應 |
|
503 |
請求未完成。系統(tǒng)暫時異常 |
|
504 |
網關超時 |
錯誤碼
請參見錯誤碼。
