华为云用户手册

  • 响应示例 { "routetables": [ { "id": "3d42a0d4-a980-4613-ae76-a2cddecff054", "name": "routetable-1234", "vpc_id": "ab78be2d-782f-42a5-aa72-35879f6890ff", "subnets": [ { "id": "8d4ce32f-d68a-4c4c-9f18-c68d8a5c7f2f" } ], "tenant_id": "6fbe9263116a4b68818cf1edce16bc4f", "description": "abc", "created_at": "2022-12-15T02:56:40", "updated_at": "2022-12-15T02:56:40" }, { "id": "3d42a0d4-a980-4613-ae76-a2cddecfff89", "name": "routetable-5678", "vpc_id": "ab78be2d-782f-42a5-aa72-35879f667809", "subnets": [ { "id": "8d4ce32f-d68a-4c4c-9f18-c68d8a5c7f2f" } ], "tenant_id": "6fbe9263116a4b68818cf1edce16bc4f", "description": "abc", "created_at": "2022-12-15T02:59:03", "updated_at": "2022-12-15T02:59:03" } ] }
  • URI GET /v1/{project_id}/routetables 样例: GET https://{Endpoint}/v1/{project_id}/routetables?limit=10&marker=4779ab1c-7c1a-44b1-a02e-93dfc361b32d&vpc_id=3ec3b33f-ac1c-4630-ad1c-7dba1ed79d85&subnet_id=9873b33f-ac1c-4630-ad1c-7dba1ed79r78 参数说明请参见表1。 表1 参数说明 名称 是否必选 参数类型 说明 project_id 是 String 项目ID,请参见获取项目ID。 limit 否 Integer 分页查询每页返回的记录个数,取值范围为0~intmax(2^31-1),默认值2000。 limit需要和marker配合使用,详细规则请见marker的参数说明。 marker 否 String 分页查询的起始资源ID,表示从指定资源的下一条记录开始查询。 marker需要和limit配合使用: 若不传入marker和limit参数,查询结果返回第一页全部资源记录。 若不传入marker参数,limit为10,查询结果返回第1~10条资源记录。 若marker为第10条记录的资源ID,limit为10,查询结果返回第11~20条资源记录。 若marker为第10条记录的资源ID,不传入limit参数,查询结果返回第11条及之后的所有资源记录。 id 否 String 按照路由表ID过滤查询,可过滤对应ID的路由表。 vpc_id 否 String 按照路由表所属VPC的UUID过滤查询。 subnet_id 否 String 按照路由表所关联子网的UUID过滤查询。 如果您使用管理控制台,此值即为子网详情中的“网络ID”参数值。
  • 操作步骤 创建某个VPC的单个标签。 发送“POST https://VPC的Endpoint/v2.0/{project_id}/vpcs/{vpc_id}/tags”,project_id为项目ID,vpc_id为VPC ID。 此接口可以在vpc_id所指的VPC中创建单个标签。 在Request Header中增加“X-Auth-Token”。 在Request Body中传入参数如下。 { "tag": { "key": "key-test", "value": "value-test" } } 查看请求响应结果。 请求成功时,无响应消息,可以通过查询VPC资源标签查看结果,详见第2步。 请求异常时,错误码请参见错误码。 查询某个VPC的所有标签。 发送“GET https://VPC的Endpoint/v2.0/{project_id}/vpcs/{vpc_id}/tags”,project_id为项目ID,vpc_id为VPC ID。 此接口可以查询vpc_id所指的VPC的所有标签。 在Request Header中增加“X-Auth-Token”。 查看请求响应结果。 请求成功时,响应消息如下,可以看到第1步创建的tag,同时响应消息中的tags是列表类型,可能包含多个tag。 { "tags": [ { "key": "key-test", "value": "value-test" } ] } 请求异常时,错误码请参见错误码。 删除某个VPC的单个标签。 发送“DELETE https://VPC的Endpoint/v2.0/{project_id}/vpcs/{vpc_id}/tags/{key}”,project_id为项目ID,vpc_id为VPC ID,key为待删除标签的键值。 此接口可以在vpc_id所指的VPC中指定删除某个标签。 在Request Header中增加“X-Auth-Token”。 查看请求响应结果。 请求成功时,无响应消息,可以通过查询VPC资源标签查看标签是否被删除,详见第2步。 请求异常时,错误码请参见错误码。 批量创建某个VPC的多个标签。 发送“POST https://VPC的Endpoint/v2.0/{project_id}/vpcs/{vpc_id}/tags/action”,project_id为项目ID,vpc_id为VPC ID。 此接口可以在vpc_id所指的VPC中创建多个标签。 在Request Header中增加“X-Auth-Token”。 在Request Body中传入参数如下,创建标签时指定action为create。 { "action": "create", "tags": [ { "key": "key-1", "value": "value-1" }, { "key": "key-2", "value": "value-2" } ] } 查看请求响应结果。 请求成功时,无响应消息,可以通过查询VPC资源标签查看结果,详见第2步。 请求异常时,错误码请参见错误码。 批量删除某个VPC的多个标签。 发送“POST https://VPC的Endpoint/v2.0/{project_id}/vpcs/{vpc_id}/tags/action”,project_id为项目ID,vpc_id为VPC ID。 此接口可以在vpc_id所指的VPC中删除多个标签。 在Request Header中增加“X-Auth-Token”。 在Request Body中传入参数如下,删除标签时指定action为delete。 { "action": "delete", "tags": [ { "key": "key-1", "value": "value-1" }, { "key": "key-2", "value": "value-2" } ] } 查看请求响应结果。 请求成功时,无响应消息,可以通过查询VPC资源标签查看结果,详见第2步。 请求异常时,错误码请参见错误码。 用标签过滤查询VPC资源实例详情。 发送“POST https://VPC的Endpoint/v2.0/{project_id}/vpcs/resource_instances/action”,project_id为项目ID。 此接口可以指定标签作为过滤条件过滤查询VPC实例详情。 在Request Header中增加“X-Auth-Token”。 在Request Body中传入参数如下,过滤查询标签详情时指定action为filter。 { "action": "filter", "limit": 100, "offset": 0, "matches": [ { "key": "resource_name", "value": "vpc" } ], "tags": [ { "key": "key-1", "values": [ "value-1" ] } ] } 查看请求响应结果。 请求成功时,响应消息如下。 { "resources": [ { "resource_name": "vpc-jhc-test", "resource_id": "992ad4b2-35c1-4f8a-8dd0-caf8a7a7ec03", "resource_detail": "", "tags": [ { "key": "key-1", "value": "value-1" }, { "key": "key-2", "value": "value-2" }, { "key": "key-test", "value": "value-test" } ] } ], "total_count": 1 } 请求异常时,错误码请参见错误码。 用标签过滤查询VPC资源实例数量。 发送“POST https://VPC的Endpoint/v2.0/{project_id}/vpcs/resource_instances/action”,project_id为项目ID。 此接口可以指定标签作为过滤条件过滤查询VPC实例数量。 在Request Header中增加“X-Auth-Token”。 在Request Body中传入参数如下,过滤查询标签详情时指定action为count。 { "action": "count", "matches": [ { "key": "resource_name", "value": "vpc" } ], "tags": [ { "key": "key-1", "values": [ "value-1" ] } ] } 查看请求响应结果。 请求成功时,响应消息如下。 { "total_count": 1 } 请求异常时,错误码请参见错误码。 查询租户在指定区域的所有VPC标签。 发送“GET https://VPC的Endpoint/v2.0/{project_id}/vpcs/tags”,project_id为项目ID。 此接口可以查询租户在指定区域的所有VPC标签。 在Request Header中增加“X-Auth-Token”。 查看请求响应结果。 请求成功时,响应消息如下。 { "tags": [ { "key": "key-1", "values": [ "value-1" ] }, { "key": "key-2", "values": [ "value-2" ] }, { "key": "key-test", "values": [ "value-test" ] } ] } 请求异常时,错误码请参见错误码。
  • 请求示例 批量创建两条子网资源标签,action为create。 POST https://{Endpoint}/v2.0/{project_id}/subnets/{subnet_id}/tags/action { "action": "create", "tags": [ { "key": "key1", "value": "value1" }, { "key": "key2", "value": "value3" } ] } 批量删除两条子网资源标签,action为delete。 POST https://{Endpoint}/v2.0/{project_id}/subnets/{subnet_id}/tags/action { "action": "delete", "tags": [ { "key": "key1", "value": "value1" }, { "key": "key2", "value": "value3" } ] }
  • 请求参数 表2 请求参数 参数名称 类型 是否必选 说明 tags Array of tag objects 是 tag对象列表,请参见表3。 action String 是 操作标识: create:创建 delete:删除 表3 tag对象 属性 类型 是否必选 说明 key String 是 标签名称。 不能为空。 长度不超过128个字符(当前控制台操作key长度不超过36个字符)。 由英文字母、数字、下划线、中划线、中文字符组成。 同一资源的key值不能重复。 value String 是 标签值。 长度不超过255个字符(当前控制台操作value长度不超过43个字符)。 由英文字母、数字、下划线、点、中划线、中文字符组成。
  • 请求示例 创建地址组,命名为AutoTester746010.580123789,指定ip类型为IPv4,地址集包含:192.168.3.2、192.168.3.40、192.168.3.20-192.168.3.100、192.168.5.0/24。 POST https://{{endpoint}}/v3/b2782e6708b8475c993e6064bc456bf8/vpc/address-groups { "address_group": { "ip_version": 4, "name": "AutoTester746010.580123789", "ip_set": [ "192.168.3.2", "192.168.3.40", "192.168.3.20-192.168.3.100", "192.168.5.0/24" ], "description": "test", "max_capacity": 20, "enterprise_project_id": "0aad99bc-f5f6-4f78-8404-c598d76b0ed2" } }
  • 响应示例 状态码为 201 时: 地址组创建API的POST操作正常返回 { "address_group": { "id": "dd18a501-fcd5-4adc-acfe-b0e2384baf08", "name": "AutoTester746010.580123789", "tenant_id": "b2782e6708b8475c993e6064bc456bf8", "ip_version": 4, "ip_set": [ "192.168.5.0/24", "192.168.3.20-192.168.3.100", "192.168.3.40", "192.168.3.2" ], "ip_extra_set": [{ "ip": "192.168.5.0/24", "remarks": null }, { "ip": "192.168.3.20-192.168.3.100", "remarks": null }, { "ip": "192.168.3.40", "remarks": null }, { "ip": "192.168.3.2", "remarks": null }], "created_at": "2019-06-28T02:06:38", "updated_at": "2019-06-28T02:06:38", "description": "test", "enterprise_project_id": "0aad99bc-f5f6-4f78-8404-c598d76b0ed2", "tags": [], "max_capacity": 20, "status": "NORMAL", "status_message": "" }, "request_id": "f568db7a-2675-4271-8747-3e3f1c6381ba" }
  • 请求示例 创建一个子网,所在vpc的id为3ec3b33f-ac1c-4630-ad1c-7dba1ed79d85,命名为subent,设置cidr为192.168.20.0/24,网关IP为192.168.20.1。 POST https://{Endpoint}/v1/{project_id}/subnets { "subnet": { "name": "subnet", "description": "", "cidr": "192.168.20.0/24", "gateway_ip": "192.168.20.1", "ipv6_enable": true, "dhcp_enable": true, "primary_dns": "114.xx.xx.114", "secondary_dns": "114.xx.xx.115", "dnsList": [ "114.xx.xx.114", "114.xx.xx.115" ], "availability_zone": "aa-bb-cc", "vpc_id": "3ec3b33f-ac1c-4630-ad1c-7dba1ed79d85", "extra_dhcp_opts": [ { "opt_value": "10.100.0.33,10.100.0.34", "opt_name": "ntp" }, { "opt_value": "24h", "opt_name": "addresstime" } ] } }
  • 响应示例 { "subnet": { "id": "4779ab1c-7c1a-44b1-a02e-93dfc361b32d", "name": "subnet", "description": "", "cidr": "192.168.20.0/24", "dnsList": [ "114.xx.xx.114", "114.xx.xx.115" ], "status": "UNKNOWN", "vpc_id": "3ec3b33f-ac1c-4630-ad1c-7dba1ed79d85", "gateway_ip": "192.168.20.1", "ipv6_enable": true, "cidr_v6": "2001:db8:a583::/64", "gateway_ip_v6": "2001:db8:a583::1", "dhcp_enable": true, "primary_dns": "114.xx.xx.114", "secondary_dns": "114.xx.xx.115", "availability_zone": "aa-bb-cc", "neutron_network_id": "4779ab1c-7c1a-44b1-a02e-93dfc361b32d", "neutron_subnet_id": "213cb9d-3122-2ac1-1a29-91ffc1231a12", "neutron_subnet_id_v6": "e0fa7de1-a6e2-44c9-b052-b9d8cebe93c4", "extra_dhcp_opts": [ { "opt_value": "10.100.0.33,10.100.0.34", "opt_name": "ntp" }, { "opt_value": "24h", "opt_name": "addresstime" } ], "tenant_id": "087679f0aa80d32a2f4ec0172f5e902b", "created_at": "2022-12-15T02:42:07", "updated_at": "2022-12-15T02:42:07" } }
  • 响应示例 { "subnets": [ { "id": "4779ab1c-7c1a-44b1-a02e-93dfc361b32d", "name": "subnet", "description": "", "cidr": "192.168.20.0/24", "dnsList": [ "114.xx.xx.114", "114.xx.xx.115" ], "status": "ACTIVE", "vpc_id": "3ec3b33f-ac1c-4630-ad1c-7dba1ed79d85", "gateway_ip": "192.168.20.1", "ipv6_enable": true, "cidr_v6": "2001:db8:a583::/64", "gateway_ip_v6": "2001:db8:a583::1", "dhcp_enable": true, "primary_dns": "114.xx.xx.114", "secondary_dns": "114.xx.xx.115", "availability_zone": "aa-bb-cc", "neutron_network_id": "4779ab1c-7c1a-44b1-a02e-93dfc361b32d", "neutron_subnet_id": "213cb9d-3122-2ac1-1a29-91ffc1231a12", "neutron_subnet_id_v6": "e0fa7de1-a6e2-44c9-b052-b9d8cebe93c4", "extra_dhcp_opts": [ { "opt_value": "10.100.0.33,10.100.0.34", "opt_name": "ntp" }, { "opt_value": "24h", "opt_name": "addresstime" } ], "tenant_id": "087679f0aa80d32a2f4ec0172f5e902b", "created_at": "2022-12-15T02:42:07", "updated_at": "2022-12-15T02:42:07" }, { "id": "531dec0f-3116-411b-a21b-e612e42349fd", "name": "Subnet1", "description": "", "cidr": "192.168.1.0/24", "dnsList": [ "114.xx.xx.114", "114.xx.xx.115" ], "status": "ACTIVE", "vpc_id": "3ec3b33f-ac1c-4630-ad1c-7dba1ed79d85", "gateway_ip": "192.168.1.1", "ipv6_enable": false, "dhcp_enable": true, "primary_dns": "114.xx.xx.114", "secondary_dns": "114.xx.xx.115", "availability_zone": "aa-bb-cc", "neutron_network_id": "531dec0f-3116-411b-a21b-e612e42349fd", "neutron_subnet_id": "1aac193-a2ad-f153-d122-12d64c2c1d78", "extra_dhcp_opts": [ { "opt_value": "10.100.0.33,10.100.0.34", "opt_name": "ntp" }, { "opt_value": "24h", "opt_name": "addresstime" } ], "tenant_id": "087679f0aa80d32a2f4ec0172f5e902b", "created_at": "2022-12-15T03:41:22", "updated_at": "2022-12-15T03:41:22" } ] }
  • URI GET /v1/{project_id}/subnets 样例: GET https://{Endpoint}/v1/{project_id}/subnets?limit=10&marker=4779ab1c-7c1a-44b1-a02e-93dfc361b32d&vpc_id=3ec3b33f-ac1c-4630-ad1c-7dba1ed79d85 参数说明请参见表1。 表1 参数说明 名称 是否必选 参数类型 说明 project_id 是 String 项目ID,获取项目ID请参见获取项目ID。 marker 否 String 分页查询的起始资源ID,表示从指定资源的下一条记录开始查询。 marker需要和limit配合使用: 若不传入marker和limit参数,查询结果返回第一页全部资源记录。 若不传入marker参数,limit为10,查询结果返回第1~10条资源记录。 若marker为第10条记录的资源ID,limit为10,查询结果返回第11~20条资源记录。 若marker为第10条记录的资源ID,不传入limit参数,查询结果返回第11条及之后的所有资源记录。 limit 否 Integer 分页查询每页返回的记录个数,取值范围为0~intmax(2^31-1),默认值2000。 limit需要和marker配合使用,详细规则请见marker的参数说明。 vpc_id 否 String 按照子网所在VPC ID过滤查询。 企业项目细粒度授权场景下,该字段必传。
  • 响应参数 表2 响应参数 参数名称 类型 说明 tags Array of tag objects tag对象列表,请参见表3。 表3 tag对象 属性 类型 说明 key String 标签名称。 不能为空。 长度不超过128个字符(当前控制台操作key长度不超过36个字符)。 由英文字母、数字、下划线、中划线、中文字符组成。 同一资源的key值不能重复。 value String 标签值。 长度不超过255个字符(当前控制台操作value长度不超过43个字符)。 由英文字母、数字、下划线、点、中划线、中文字符组成。
  • 响应示例 状态码为 200 时: 地址组创建API的GET查列表操作正常返回 { "address_groups": [ { "id": "dd18a501-fcd5-4adc-acfe-b0e2384baf08", "name": "AutoTester746010.580123789", "tenant_id": "b2782e6708b8475c993e6064bc456bf8", "ip_version": 4, "ip_set": [ "192.168.5.0/24", "192.168.3.20-192.168.3.100", "192.168.3.40", "192.168.3.2" ], "ip_extra_set": [{ "ip": "192.168.5.0/24", "remarks": null }, { "ip": "192.168.3.20-192.168.3.100", "remarks": null }, { "ip": "192.168.3.40", "remarks": null }, { "ip": "192.168.3.2", "remarks": null }], "created_at": "2019-06-28T02:06:38", "updated_at": "2019-06-28T02:06:38", "description": "test", "enterprise_project_id": "0aad99bc-f5f6-4f78-8404-c598d76b0ed2", "tags": [], "max_capacity": 20, "status": "NORMAL", "status_message": "" } ], "page_info": { "previous_marker": "dd18a501-fcd5-4adc-acfe-b0e2384baf08", "current_count": 1 }, "request_id": "e51fa17c-3259-4122-afb1-9c03d4ef5408" }
  • URI GET /v3/{project_id}/vpc/address-groups 表1 参数说明 名称 是否必选 参数类型 说明 project_id 是 String 项目ID。 获取方法请参见获取项目ID。 表2 Query参数 参数 是否必选 参数类型 描述 limit 否 Integer 功能说明:每页返回的个数 取值范围:0-2000 enterprise_project_id 否 String 功能说明:企业项目ID。可以使用该字段过滤某个企业项目下的IP地址组。 取值范围:最大长度36字节,带“-”连字符的UUID格式,或者是字符串“0”。“0”表示默认企业项目。若需要查询当前用户所有企业项目绑定的IP地址组,请传参all_granted_eps。 最大长度:36 备注:该参数在华南-深圳、西南-贵阳一、华南-广州、亚太-新加坡区域上线。 marker 否 String 分页查询起始的资源ID,为空时查询第一页 id 否 Array of strings 地址组唯一标识,填写后接口按照id进行过滤,支持多ID同时过滤 name 否 Array of strings 地址组名称,填写后按照名称进行过滤,支持多名称同时过滤 ip_version 否 Integer IP地址组ip版本,取值范围:4、6 description 否 Array of strings 地址组描述信息,填写后按照地址组描述信息过滤,支持多描述同时过滤
  • 响应示例 { "network": { "id": "c360322d-5315-45d7-b7d2-481f98c56edb", "name": "network-test", "status": "ACTIVE", "shared": false, "subnets": [], "availability_zone_hints": [], "availability_zones": [ "az2.dc2", "az5.dc5" ], "admin_state_up": true, "tenant_id": "bbfe8c41dd034a07bebd592bf03b4b0c", "project_id": "bbfe8c41dd034a07bebd592bf03b4b0c", "provider:network_type": "vxlan", "router:external": false, "port_security_enabled": true, "created_at": "2018-09-20T01:53:18", "updated_at": "2018-09-20T01:53:20" } }
  • 请求参数 表1 请求参数 参数名称 类型 必选 说明 network network object 是 network对象,参见表2。 表2 network对象 属性 是否必选 类型 说明 name 否 String 网络名称。 【使用说明】name不能为admin_external_net(预置网络名称,不可占用)。 admin_state_up 否 Boolean 管理状态。 【使用说明】只支持true。 shared 否 Boolean 是否支持跨租户共享。 provider:network_type 否 String 扩展属性:网络类型。 取值范围:支持租户创建geneve、vxlan类型的网络 租户只能指定此参数为geneve,不指定时网路类型自动分配,一般分配为vxlan类型。预置网络admin_external_net的情况下,此参数为vlan,用户不可配置。 【使用说明】 创建geneve类型的网络,请指定此参数为geneve。 创建vxlan类型的网络,请求时请不要指定此参数。 port_security_enabled 否 Boolean 端口安全使能标记,如果不使能,则network下所有虚机的安全组和dhcp防欺骗不生效
  • 响应参数 表3 响应参数 参数名称 类型 说明 network network object network对象,参见表4。 表4 network对象 属性 类型 说明 status String 网络状态,可以为ACTIVE,BUILD,DOWN或ERROR。 subnets Array of strings 网络关联的子网ID列表。 一个network仅支持关联一个subnet。 name String 网络名称。 name不能为admin_external_net(预置网络名称,不可占用)。 router:external Boolean 扩展属性:是否外部网络,默认值false。 admin_state_up Boolean 管理状态。 只支持true。 tenant_id String 项目ID shared Boolean 是否支持跨租户共享。 id String 网络的id 【使用说明】在查询网络列表时候非必选 provider:network_type String 扩展属性:网络类型。 取值范围:支持租户创建geneve、vxlan类型的网络 租户只能指定此参数为geneve,不指定时网路类型自动分配,一般分配为vxlan类型。预置网络admin_external_net的情况下,此参数为vlan,用户不可配置。 【使用说明】 创建geneve类型的网络,请指定此参数为geneve。 创建vxlan类型的网络,请求时请不要指定此参数。 availability_zone_hints Array of strings 本网络的候选可用域,当前版本不支持可用域调度。 availability_zones Array of strings 本网络的可用域。 port_security_enabled Boolean 端口安全使能标记,如果不使能,则network下所有虚机的安全组和dhcp防欺骗不生效 dns_domain String 默认内网DNS域地址,系统自动生成维护,不支持设置和更新 project_id String 项目ID,请参见获取项目ID。 created_at String 资源创建时间,UTC时间 格式:yyyy-MM-ddTHH:mm:ss updated_at String 资源更新时间,UTC时间 格式:yyyy-MM-ddTHH:mm:ss
  • 响应示例 { "versions": [ { "status": "CURRENT", "id": "v2.0", "links": [ { "href": "https://{Endpoint}/v2.0", "rel": "self" } ] } ] }
  • 响应参数 表1 响应参数 参数名称 类型 说明 versions Array of version objects API版本列表,请参见表2。 表2 version对象 参数名称 类型 说明 status String API版本的状态: CURRENT(当前版本) STABLE(稳定版本) DEPRECATED(废弃版本) id String API版本。 links Array of link objects 链接列表,请参见表3。 表3 link对象 参数名称 类型 说明 href String API链接。 rel String API链接与该API版本的关系。
  • 响应参数 表2 响应参数 参数名称 类型 说明 tags Array of tag objects tag对象列表,请参见表3。 表3 tag对象 属性 类型 说明 key String 标签名称。 不能为空。 长度不超过128个字符(当前控制台操作key长度不超过36个字符)。 由英文字母、数字、下划线、中划线、中文字符组成。 同一资源的key值不能重复。 value String 标签值。 长度不超过255个字符(当前控制台操作value长度不超过43个字符)。 由英文字母、数字、下划线、点、中划线、中文字符组成。
  • 响应示例 状态码为 200 时: 地址组创建API的GET查询操作正常返回 { "address_group": { "id": "dd18a501-fcd5-4adc-acfe-b0e2384baf08", "name": "AutoTester746010.580123789", "tenant_id": "b2782e6708b8475c993e6064bc456bf8", "ip_version": 4, "ip_set": [ "192.168.5.0/24", "192.168.3.20-192.168.3.100", "192.168.3.40", "192.168.3.2" ], "ip_extra_set": [{ "ip": "192.168.5.0/24", "remarks": null }, { "ip": "192.168.3.20-192.168.3.100", "remarks": null }, { "ip": "192.168.3.40", "remarks": null }, { "ip": "192.168.3.2", "remarks": null }], "created_at": "2019-06-28T02:06:38", "updated_at": "2019-06-28T02:06:38", "description": "10.10.4.0/23", "enterprise_project_id": "0aad99bc-f5f6-4f78-8404-c598d76b0ed2", "tags": [], "max_capacity": 20, "status": "NORMAL", "status_message": "" }, "request_id": "ce6c359b-9002-41e5-a0b1-232759bd6637" }
  • 响应参数 表2 响应参数 参数名称 类型 说明 network network object network对象,参见表3。 表3 network对象 属性 类型 说明 status String 网络状态,可以为ACTIVE,BUILD,DOWN或ERROR。 subnets Array of strings 网络关联的子网ID列表。 一个network仅支持关联一个subnet。 name String 网络名称。 name不能为admin_external_net(预置网络名称,不可占用)。 router:external Boolean 扩展属性:是否外部网络,默认值false。 admin_state_up Boolean 管理状态。 只支持true。 tenant_id String 项目ID shared Boolean 是否支持跨租户共享。 id String 网络的id 【使用说明】在查询网络列表时候非必选 provider:network_type String 扩展属性:网络类型。 取值范围:支持租户创建geneve、vxlan类型的网络 租户只能指定此参数为geneve,不指定时网路类型自动分配,一般分配为vxlan类型。预置网络admin_external_net的情况下,此参数为vlan,用户不可配置。 【使用说明】 创建geneve类型的网络,请指定此参数为geneve。 创建vxlan类型的网络,请求时请不要指定此参数。 availability_zone_hints Array of strings 本网络的候选可用域,当前版本不支持可用域调度。 availability_zones Array of strings 本网络的可用域。 port_security_enabled Boolean 端口安全使能标记,如果不能使,则network下所有虚机的安全组和dhcp防欺骗不生效 dns_domain String 默认内网DNS域地址,系统自动生成维护,不支持设置和更新 project_id String 项目ID,请参见获取项目ID。 created_at String 资源创建时间,UTC时间 格式:yyyy-MM-ddTHH:mm:ss updated_at String 资源更新时间,UTC时间 格式:yyyy-MM-ddTHH:mm:ss
  • 响应示例 { "network": { "id": "0133cd73-34d4-4d4c-bf1f-e65b24603206", "name": "3804f26c-7862-43b6-ad3c-48445f42de89", "status": "ACTIVE", "shared": false, "subnets": [ "423796f5-e02f-476f-bf02-2b88c8ddac8b" ], "availability_zone_hints": [], "availability_zones": [ "az2.dc2", "az5.dc5" ], "admin_state_up": true, "tenant_id": "bbfe8c41dd034a07bebd592bf03b4b0c", "project_id": "bbfe8c41dd034a07bebd592bf03b4b0c", "provider:network_type": "vxlan", "router:external": false, "port_security_enabled": true, "created_at": "2018-03-23T03:51:58", "updated_at": "2018-03-23T03:51:58" } }
  • 请求参数 表2 请求Body参数 参数 是否必选 参数类型 描述 port 是 InsertSecurityGroupOption object 端口插入安全组请求体 表3 InsertSecurityGroupOption 参数 是否必选 参数类型 描述 security_groups 是 Array of strings 功能说明:安全组的ID列表;例如:"security_groups": ["a0608cbf-d047-4f54-8b28-cd7b59853fff"] index 否 Integer 安全组插入的位置,从0开始计数。 举例: 1. 要插入到已关联安全组列表的首位,index=0; 2. 要插入到已关联安全组列表的第n个安全组后面,index=n。 默认插入到端口已关联的安全组列表末尾。
  • 请求示例 指定端口插入安全组,端口99fd0c77-56b4-4bf6-8365-df352e45d5fc已关联的安全组列表为["567be4e3-d171-46ce-9e8a-c15e91cfe86a", "4940b983-5992-4663-bed9-d1d1e15d1009"],要将新安全组插入到第1个安全组567be4e3-d171-46ce-9e8a-c15e91cfe86a后面,此时新安全组插入的index为1。 PUT https://{Endpoint}/v3/f5dab68cd75740e68c599e9af5fe0aed/ports/99fd0c77-56b4-4bf6-8365-df352e45d5fc/insert-security-groups { "port" : { "security_groups" : [ "8edd3747-ccd4-49a1-82b9-a165eec314b4", "6c2d4540-3b7d-4207-a319-a7231b439995" ], "index" : 1 } }
  • 响应示例 状态码: 200 OK { "port" : { "name" : "", "id" : "99fd0c77-56b4-4bf6-8365-df352e45d5fc", "admin_state_up" : true, "status" : "DOWN", "project_id" : "f5dab68cd75740e68c599e9af5fe0aed", "device_id" : "", "mac_address" : "fa:16:3e:1f:17:df", "device_owner" : "", "description" : "", "vpc_id" : null, "zone_id" : "", "scope" : "center", "position_type" : "center", "vtep_ip" : null, "created_at" : "2023-05-10T01:35:02", "updated_at" : "2023-05-10T01:35:02", "port_security_enabled" : true, "tags" : [ ], "security_groups" : [ "567be4e3-d171-46ce-9e8a-c15e91cfe86a", "8edd3747-ccd4-49a1-82b9-a165eec314b4", "6c2d4540-3b7d-4207-a319-a7231b439995", "4940b983-5992-4663-bed9-d1d1e15d1009" ], "allowed_address_pairs" : [ ], "extra_dhcp_opts" : [ ], "instance_info" : null, "instance_id" : "", "instance_type" : "", "ecs_flavor" : "", "enable_efi" : false, "virsubnet_id" : "3847b263-2370-45c0-8236-38a1de568049", "private_ips" : [ { "subnet_cidr_id" : "ffe98087-6d4f-45cd-988b-1c87f75d2d53", "ip_address" : "192.168.158.228" } ], "vpc_tenant_id" : null, "binding:host_id" : "", "binding:vif_type" : "unbound", "binding:vnic_type" : "normal", "binding:vif_details" : { }, "binding:profile" : { }, "binding:migration_info" : { } }, "request_id" : "458691c0-7db2-43d8-9400-053800c5ff53" }
  • 响应示例 状态码: 201 Created { "security_group_rules" : [ { "id" : "abef369b-d646-4b8a-9f44-fcd248a6c421", "project_id" : "5f6387106c2048b589b369d96c2f23a2", "security_group_id" : "15457509-18f9-4387-bae6-d4ed1898b301", "remote_group_id" : null, "direction" : "ingress", "protocol" : "tcp", "description" : "", "created_at" : "2023-04-28T04:08:52Z", "updated_at" : "2023-04-28T04:08:52Z", "ethertype" : "IPv4", "remote_ip_prefix" : "117.78.12.122/32", "multiport" : "22", "remote_address_group_id" : null, "action" : "allow", "priority" : 1 } ], "request_id" : "f1ae2c6f9e94babf077cd3b3e1570c81" }
  • 请求示例 在安全组15457509-18f9-4387-bae6-d4ed1898b301中创建规则,忽略重复规则,两条规则相同。 POST https://{Endpoint}/v3/{project_id}/vpc/security-groups/15457509-18f9-4387-bae6-d4ed1898b301/security-group-rules/batch-create { "ignore_duplicate" : true, "security_group_rules" : [ { "direction" : "ingress", "description" : "", "protocol" : "tcp", "action" : "allow", "priority" : 1, "ethertype" : "IPv4", "multiport" : "22", "remote_ip_prefix" : "117.78.12.122/32" }, { "direction" : "ingress", "description" : "", "protocol" : "tcp", "action" : "allow", "priority" : 1, "ethertype" : "IPv4", "multiport" : "22", "remote_ip_prefix" : "117.78.12.122/32" } ] }
  • 响应参数 表5 响应参数 名称 参数类型 说明 subnet subnet object subnet对象 表6 subnet对象 名称 参数类型 说明 id String uuid形式的一个资源标识。 status String 功能说明:子网的状态。 取值范围:ACTIVE,UNKNOWN,ERROR ACTIVE表示子网已挂载到VPC上 UNKNOWN表示子网还未挂载到VPC上 ERROR表示子网状态故障
  • 请求示例 更新id为4779ab1c-7c1a-44b1-a02e-93dfc361b32d的子网,名称更新为subnet02,更新dns和dhcp。 PUT https://{Endpoint}/v1/{project_id}/vpcs/{vpc_id}/subnets/4779ab1c-7c1a-44b1-a02e-93dfc361b32d { "subnet": { "name": "subnet02", "ipv6_enable": true, "dhcp_enable": false, "primary_dns": "114.xx.xx.115", "secondary_dns": "114.xx.xx.116", "extra_dhcp_opts": [ { "opt_value": "10.100.0.33,10.100.0.34", "opt_name": "ntp" }, { "opt_value": "24h", "opt_name": "addresstime" } ] } }
共100000条