更新时间:2022-04-17 GMT+08:00
分享

更新地址组

功能介绍

更新地址组。

调试

您可以在API Explorer中调试该接口。

URI

PUT /v3/{project_id}/vpc/address-groups/{address_group_id}

表1 参数说明

参数

是否必选

参数类型

描述

address_group_id

String

地址组的唯一标识

project_id

String

项目ID。

获取方法请参见获取项目ID

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

dry_run

Boolean

功能说明:是否只预检此次请求

取值范围:
  • true:发送检查请求,不会更新地址组内容。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过,则返回对应错误。如果检查通过,则返回响应码202。
  • false(默认值):发送正常请求,并直接更新地址组。

address_group

UpdateAddressGroupOption object

更新地址组的请求体

表3 UpdateAddressGroupOption

参数

是否必选

参数类型

描述

name

String

功能说明:地址组名称

取值范围:0-64个字符,支持数字、字母、中文、_(下划线)、-(中划线)、.(点)

description

String

功能说明:IP地址组描述信息

取值范围:0-255个字符

约束:不能包含“<”和“>”。

ip_set

Array of strings

功能说明:IP地址组可包含地址集

取值范围:可以是单个ip地址,ip地址范围,ip地址cidr

约束:当前一个地址组ip_set数量限制默认值为20,即配置的ip地址、ip地址范围或ip地址cidr的总数默认限制20

请求示例

  • 更新地址组信息
    "PUT https://{endpoint}/v3/b2782e6708b8475c993e6064bc456bf8/vpc/address-groups/dd18a501-fcd5-4adc-acfe-b0e2384baf08"
    
    {
        "address_group": {
            "name": "vkvgykvsvhjaaaa1", 
            "ip_set": [
                "192.168.3.2", 
                "192.168.3.40", 
                "192.168.3.41", 
                "192.168.3.42", 
                "192.168.3.43", 
                "192.168.3.20-192.168.3.100", 
                "192.168.5.0/24"
            ], 
            "description": "xxxxxxxxxx"
        }
    }

响应参数

状态码为 200 时:

表4 响应Body参数

参数

参数类型

描述

request_id

String

请求ID

address_group

AddressGroup object

更新地址组的响应体

表5 AddressGroup

参数

参数类型

描述

id

String

功能说明:地址组唯一标识

取值范围:合法UUID的字符串

name

String

功能说明:地址组名称

取值范围:0-64个字符,支持数字、字母、中文、_(下划线)、-(中划线)、.(点)

description

String

功能说明:地址组描述信息

取值范围:0-255个字符

约束:不能包含“<”和“>”。

ip_set

Array of strings

功能说明:地址组可包含地址集

取值范围:可以是单个ip地址,ip地址范围,ip地址cidr

约束:当前一个地址组ip_set数量限制默认值为20,即配置的ip地址、ip地址范围或ip地址cidr的总数默认限制20

ip_version

Integer

功能说明:IP地址组ip版本

取值范围:

  • 4:表示ipv4地址组
  • 6:表示ipv6地址组

created_at

String

功能说明:地址组创建时间

取值范围:UTC时间格式,yyyy-MM-ddTHH:mm:ss

系统自动生成

updated_at

String

功能描述:地址组最近一次更新资源的时间

取值范围:UTC时间格式,yyyy-MM-ddTHH:mm:ss

系统自动生成

tenant_id

String

功能说明:资源所属项目ID

响应示例

状态码为 200 时:

地址组创建API的PUT更新操作正常返回
{
    "address_group": {
        "id": "dd18a501-fcd5-4adc-acfe-b0e2384baf08", 
        "name": "vkvgykvsvhjaaaa1", 
        "tenant_id": "b2782e6708b8475c993e6064bc456bf8", 
        "ip_version": 4, 
        "ip_set": [
            "192.168.5.0/24", 
            "192.168.3.20-192.168.3.100", 
            "192.168.3.43", 
            "192.168.3.42", 
            "192.168.3.41", 
            "192.168.3.40", 
            "192.168.3.2"
        ], 
        "created_at": "2019-06-28T02:06:38", 
        "updated_at": "2019-06-28T02:14:01", 
        "description": "xxxxxxxxxx"
    }, 
    "request_id": "5bbd1640-fa68-4362-9a5c-30c4809958e0"
}

状态码

请参见状态码

错误码

请参见错误码

分享:

    相关文档

    相关产品

close