設定阿里雲帳號（主帳號）或 RAM 使用者的存取金鑰網路存取限制策略。
調試
您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。
調試
授權資訊
請求參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
| UserPrincipalName |
string |
否 |
RAM 使用者的登入名稱。 若為空，預設為目前使用者的指定存取金鑰設定網路存取限制策略。 |
test@example.onaliyun.com |
| UserAccessKeyId |
string |
是 |
存取金鑰 ID。 |
LTAI******************* |
| AccessKeyPolicy |
string |
是 |
網路存取限制策略。 JSON 格式字串，詳細請參閱 AccessKeyPolicy 結構說明。 |
{"Status":"Inactive","Statements":[{"Value":"AllowAllVPC","Type":"VPCWhiteList","IPList":["::/0","0.0.0.0/0"]}]} |
AccessKeyPolicy 結構說明
AccessKeyPolicy 參數為 JSON 格式的字串，完整結構如下：
{
"Version": 1,
"Status": "Active",
"Statements": [
{
"Type": "ClassicWhiteList",
"IPList": ["203.0.113.1", "2001:db8:85a3::8a2e:370:7334", "198.51.100.0/24"]
},
{
"Type": "VPCWhiteList",
"Value": "vpc-bp1234567890abcdef",
"IPList": ["172.16.0.0/16"]
}
]
}
頂層欄位
| 欄位 | 類型 | 是否必填 | 描述 |
| Version | Integer | 否 | 策略版本號碼，目前固定為 1 |
| Status | String | 是 | 策略狀態。取值：Active（啟用）、Inactive（停用） |
| Statements | Array | 是 | 網路白名單規則清單，可以為空陣列 []，但不能為 null |
Statement 物件
每個 Statement 表示一條網路白名單規則，支援兩種類型：
| 欄位 | 類型 | 描述 |
| Type | String | 規則類型。取值：ClassicWhiteList（傳統網路白名單）、VPCWhiteList（VPC 網路白名單） |
| Value | String | VPC 識別碼，僅 VPCWhiteList 類型時使用 |
| IPList | Array | IP 位址白名單清單，支援 IPv4/IPv6 位址及 CIDR 格式 |
規則類型詳解。
1. 傳統網路白名單（ClassicWhiteList）
限制 AccessKey 只能從指定的公網 IP 位址發起呼叫。
Type：固定為
ClassicWhiteListValue：不可填寫，留空即可
IPList：必填。允許呼叫的 IP 位址清單，支援 IPv4 和 IPv6 位址，支援 CIDR 格式（如
203.0.113.5/30）
預設行為：若 Statements 中未設定任何 ClassicWhiteList 規則，表示拒絕所有傳統網路的存取。
約束：若 IPList 中包含 IPv4 全放通位址 0.0.0.0/0，則必須同時包含 IPv6 全放通位址 ::/0，反之亦然。不允許僅放通單一通訊協定堆疊。
範例：
{
"Type": "ClassicWhiteList",
"IPList": ["203.0.113.5/30", "198.51.100.0/24"]
}
2. VPC 網路白名單（VPCWhiteList）
限制 AccessKey 只能從指定的 VPC 內發起呼叫，可進一步限制到 VPC 內的指定 IP。
Type：固定為
VPCWhiteList- Value：必填。取值為以下之一：
具體 VPC 執行個體 ID，格式為
vpc-開頭（如vpc-bp1234567890abcdef）AllowAllVPC：允許所有 VPC
IPList：必填。VPC 內的 IP 位址白名單，支援 CIDR 格式（如
10.0.0.0/24）
預設行為：若 Statements 中未設定任何 VPCWhiteList 規則，則拒絕所有 VPC 網路的存取。
約束：
當 Value 為
AllowAllVPC時，IPList 必須同時包含0.0.0.0/0和::/0（即全放通），且僅包含這兩項當 Value 為具體 VPC ID 時，IPList 中不允許包含
0.0.0.0/0或::/0
範例 — 指定 VPC：
{
"Type": "VPCWhiteList",
"Value": "vpc-bp1234567890abcdef",
"IPList": ["172.16.0.0/16"]
}
範例 — 允許所有 VPC：
{
"Type": "VPCWhiteList",
"Value": "AllowAllVPC",
"IPList": ["0.0.0.0/0", "::/0"]
}
數量限制
| 限制項目 | 上限 |
| AccessKeyPolicy 總長度 | JSON 字串不超過 160,000 字元 |
| Statements 條目數 | 最多 8 條 |
| 單條 Statement 中的 IPList 條目數 | 最多 50 個 |
完整請求範例。
範例 1：僅允許特定公網 IP 呼叫
{
"Version": 1,
"Status": "Active",
"Statements": [
{
"Type": "ClassicWhiteList",
"IPList": ["203.0.113.5/30", "198.51.100.0/24"]
}
]
}
範例 2：僅允許指定 VPC 內呼叫
{
"Version": 1,
"Status": "Active",
"Statements": [
{
"Type": "VPCWhiteList",
"Value": "vpc-bp1234567890abcdef",
"IPList": ["172.16.0.0/16"]
}
]
}
範例 3：同時設定傳統網路和 VPC 網路白名單
{
"Version": 1,
"Status": "Active",
"Statements": [
{
"Type": "VPCWhiteList",
"Value": "vpc-bp1234567890abcdef",
"IPList": ["172.16.0.0/16"]
},
{
"Type": "ClassicWhiteList",
"IPList": ["203.0.113.0/30"]
}
]
}
範例 4：停用策略（保留規則但不生效）
{
"Version": 1,
"Status": "Inactive",
"Statements": [
{
"Type": "ClassicWhiteList",
"IPList": ["203.0.113.5/30"]
}
]
}
範例 5：清空所有白名單規則
{
"Version": 1,
"Status": "Inactive",
"Statements": []
}
返回參數
|
名稱 |
類型 |
描述 |
樣本值 |
|
object |
|||
| AccessKeyPolicy |
string |
網路存取限制策略。 JSON 格式字串，詳細請參閱 AccessKeyPolicy 結構說明。 |
{"Status":"Inactive","Statements":[{"Value":"AllowAllVPC","Type":"VPCWhiteList","IPList":["::/0","0.0.0.0/0"]}]} |
| RequestId |
string |
請求 ID。 |
30C9068D-FBAA-4998-9986-8A562FED0BC3 |
| AccessKeyId |
string |
存取金鑰 ID。 |
LTAI******************* |
樣本
正常返回樣本
JSON格式
{
"AccessKeyPolicy": "{\"Status\":\"Inactive\",\"Statements\":[{\"Value\":\"AllowAllVPC\",\"Type\":\"VPCWhiteList\",\"IPList\":[\"::/0\",\"0.0.0.0/0\"]}]}",
"RequestId": "30C9068D-FBAA-4998-9986-8A562FED0BC3",
"AccessKeyId": "LTAI*******************"
}錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊，參考變更詳情。