全部產品
Search

搜尋本產品

    Virtual Private Cloud：UpdateIpam - 修改IPAM執行個體

    文件中心

    Virtual Private Cloud：UpdateIpam - 修改IPAM執行個體

    更新時間：Oct 10, 2025

    修改IPAM執行個體。

    介面說明

    • 為 IPAM 執行個體移除生效地區時，不能包含 IPAM 託管地區。

    調試

    您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

    調試

    授權資訊

    下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

    • 操作：是指具體的許可權點。

    • 存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。

    • 資源類型：是指操作中支援授權的資源類型。具體說明如下：

      • 對於必選的資源類型，用前面加 * 表示。

      • 對於不支援資源級授權的操作，用全部資源表示。

    • 條件關鍵字：是指雲產品自身定義的條件關鍵字。

    • 關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

    操作

    存取層級

    資源類型

    條件關鍵字

    關聯操作

    vpc:UpdateIpam

    update

    *Ipam

    acs:vpc:{#regionId}:{#accountId}:ipam/{#IpamId}

    		 無 無

    請求參數

    名稱

    類型

    必填

    描述

    樣本值
    RegionId

    string

    是

    IPAM 託管地區 ID。您可以通過調用 DescribeRegions 介面擷取地區 ID。

    cn-hangzhou
    IpamId

    string

    是

    IPAM 的執行個體 ID。

    ipam-ccxbnsbhew0d6t****
    IpamName

    string

    否

    IPAM 的名稱。

    長度為 1～128 個字元，不能以http://或https://開頭。

    test
    IpamDescription

    string

    否

    IPAM 的描述資訊。

    長度為 1～256 個字元，必須以英文大小寫字母或中文開頭。但不能以http://或https://開頭。預設為空白，不填則為空白。

    test description
    AddOperatingRegion

    array

    否

    為 IPAM 添加的生效地區列表。

    string

    否

    為 IPAM 添加的生效地區。

    eu-central-1
    RemoveOperatingRegion

    array

    否

    為 IPAM 移除的生效地區列表。

    string

    否

    為 IPAM 移除的生效地區。

    cn-beijing
    DryRun

    boolean

    否

    是否只預檢此次請求。取值：

    • true：發送檢查請求，不會修改 IPAM 執行個體。檢查項包括是否填寫了必需參數、請求格式、業務限制。如果檢查不通過，則返回對應錯誤。如果檢查通過，則返回錯誤碼 DryRunOperation。

    • false（預設值）：發送正常請求，通過檢查後返回 HTTP 2xx 狀態代碼並修改 IPAM 執行個體。

    false
    ClientToken

    string

    否

    用戶端 Token，用於保證請求的等冪性。從您的用戶端產生一個參數值，確保不同請求間該參數值唯一。ClientToken 只支援 ASCII 字元。

    說明

    若您未指定，則系統自動使用 API 請求的 RequestId 作為 ClientToken 標識。每次 API 請求的 RequestId 不一樣。

    123e4567-e89b-12d3-a456-426655440000

    返回參數

    名稱

    類型

    描述

    樣本值

    object

    返回的資訊列表。

    RequestId

    string

    請求 ID。

    F4650E33-895C-53F0-9CD5-D1338F322DE8

    樣本

    正常返回樣本

    JSON格式

    {
  "RequestId": "F4650E33-895C-53F0-9CD5-D1338F322DE8"
}

    錯誤碼

    HTTP status code

    錯誤碼

    錯誤資訊

    描述
    400 ResourceNotFound.Ipam The specified resource of ipam is not found. 輸入的IPAM不存在。
    400 IllegalParam.OperatingRegion The operating region is invalid. 生效地區非法。
    400 DependencyViolation.IpamPool The specified resource of %s depends on %s, so the operation cannot be completed. 指定的資源被其他的資源依賴，不允許進行當前操作。
    400 DryRunOperation Request validation has been passed with DryRun flag set. DryRun校正通過。
    400 OperationDenied.IpamRegionCannotBeRemoved The IPAM region cannot be removed. 不能移除IPAM託管地區。

    訪問錯誤中心查看更多錯誤碼。

    變更歷史

    更多資訊，參考變更詳情。