云服务器内容精选

  • 响应示例 { "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
  • 响应参数 状态码: 400 表5 响应Body参数 参数 参数类型 描述 request_id String 请求ID error_msg String 错误消息 error_code String 错误码 状态码: 401 表6 响应Body参数 参数 参数类型 描述 request_id String 请求ID error_msg String 错误消息 error_code String 错误码 状态码: 403 表7 响应Body参数 参数 参数类型 描述 request_id String 请求ID error_msg String 错误消息 error_code String 错误码 状态码: 404 表8 响应Body参数 参数 参数类型 描述 request_id String 请求ID error_msg String 错误消息 error_code String 错误码 状态码: 500 表9 响应Body参数 参数 参数类型 描述 request_id String 请求ID error_msg String 错误消息 error_code String 错误码
  • 请求示例 批量添加2条ACL标签。 POST https://{Endpoint}/v3/{project_id}/firewalls/{firewall_id}/tags/create { "tags" : [ { "key" : "keyxxx", "value" : "value1" }, { "key" : "keyyyy", "value" : "value2" } ] }
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 获取Token ,请参考《 统一身份认证 服务API参考》的“获取用户Token”章节。请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。 表3 请求Body参数 参数 是否必选 参数类型 描述 tags 否 Array of ResourceTag objects 标签列表 表4 ResourceTag 参数 是否必选 参数类型 描述 key 是 String 功能说明:标签键 约束:同一资源的key值不能重复。 最大长度:128 value 是 String 功能说明:标签值 最大长度:255
  • 响应参数 状态码: 400 表5 响应Body参数 参数 参数类型 描述 request_id String 请求ID error_msg String 错误消息 error_code String 错误码 状态码: 401 表6 响应Body参数 参数 参数类型 描述 request_id String 请求ID error_msg String 错误消息 error_code String 错误码 状态码: 403 表7 响应Body参数 参数 参数类型 描述 request_id String 请求ID error_msg String 错误消息 error_code String 错误码 状态码: 404 表8 响应Body参数 参数 参数类型 描述 request_id String 请求ID error_msg String 错误消息 error_code String 错误码 状态码: 500 表9 响应Body参数 参数 参数类型 描述 request_id String 请求ID error_msg String 错误消息 error_code String 错误码
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 获取Token,请参考《统一身份认证服务API参考》的“获取用户Token”章节。请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。 表3 请求Body参数 参数 是否必选 参数类型 描述 tags 否 Array of DeleteResourceTagRequestBody objects 标签列表 表4 DeleteResourceTagRequestBody 参数 是否必选 参数类型 描述 key 是 String 功能说明:标签键 约束:同一资源的key值不能重复。 value 否 String 功能说明:标签值
  • 响应参数 表4 响应参数 名称 参数类型 说明 security_group security_group object 安全组对象,请参见表5。 表5 security_group字段说明 名称 参数类型 说明 name String 安全组名称。 description String 安全组描述。 id String 安全组唯一标识。 vpc_id String 安全组所在的vpc的资源标识。 说明: 当前该参数只作提示用,不约束安全组在此vpc下,不建议继续使用。 security_group_rules Array of security_group_rule objects 默认安全组规则列表,保证安全组内互通。 enterprise_project_id String 功能说明:企业项目ID。创建安全组时,给安全组绑定企业项目ID。 取值范围:最大长度36字节,带“-”连字符的UUID格式,或者是字符串“0”。“0”表示默认企业项目。 说明: 关于企业项目ID的获取及企业项目特性的详细信息,请参见《企业管理用户指南》。 表6 security_group_rule对象 名称 参数类型 说明 id String 安全组规则标识。 description String 功能说明:安全组规则描述。 取值范围:0-255个字符,支持数字、字母、中文字符。 security_group_id String 安全组标识。 direction String 功能说明:出入控制方向。 取值范围: egress:出方向 ingress:入方向 ethertype String 功能说明:IP协议类型。 取值范围:IPv4,IPv6 protocol String 功能说明:协议类型。 取值范围:icmp、tcp、udp、icmpv6、IP协议号(0~255)(如gre协议号为47)。 约束:为空表示支持所有协议。 port_range_min Integer 功能说明:起始端口值。 取值范围:1~65535 约束:不能大于port_range_max的值,为空表示所有端口,如果协议是icmp类型,取值范围请参见安全组规则icmp协议名称对应关系表。 port_range_max Integer 功能说明:结束端口值。 取值范围:1~65535 约束:协议不为icmp时,取值不能小于port_range_min的值,为空表示所有端口,如果协议是icmp类型,取值范围请参见安全组规则icmp协议名称对应关系表。 remote_ip_prefix String 功能说明:远端IP地址,当direction是egress时为虚拟机访问端的地址,当direction是ingress时为访问虚拟机的地址。 取值范围:IP地址,或者cidr格式 约束:和remote_group_id,remote_address_group_id互斥。 remote_group_id String 功能说明:对端安全组id。 约束:和remote_ip_prefix,remote_address_group_id互斥。 remote_address_group_id String 功能说明:远端IP地址组ID。 约束:和remote_ip_prefix,remote_group_id互斥。 tenant_id String 功能说明:安全组规则所属项目ID。
  • 请求示例 创建一个安全组,命名为sg-01,所在vpc id为3ec3b33f-ac1c-4630-ad1c-7dba1ed79d85。 POST https://{Endpoint}/v1/{project_id}/security-groups { "security_group": { "name": "sg-01", "vpc_id": "3ec3b33f-ac1c-4630-ad1c-7dba1ed79d85", "enterprise_project_id": "0aad99bc-f5f6-4f78-8404-c598d76b0ed2" } }
  • 响应示例 { "security_group": { "id": "16b6e77a-08fa-42c7-aa8b-106c048884e6", "name": "qq", "description": "", "vpc_id": "3ec3b33f-ac1c-4630-ad1c-7dba1ed79d85", "enterprise_project_id": "0aad99bc-f5f6-4f78-8404-c598d76b0ed2", "security_group_rules": [ { "id": "f11a3824-ac19-4fad-b4f1-c5f4a6dd0a80", "tenant_id": "060576782980d5762f9ec014dd2f1148", "security_group_id": "69c999ad-d9ef-4d79-94fd-35e6ceb75325", "remote_group_id": "69c999ad-d9ef-4d79-94fd-35e6ceb75325", "direction": "ingress", "protocol": null, "description": "", "ethertype": "IPv6", "remote_ip_prefix": null, "remote_address_group_id": null, "port_range_max": null, "port_range_min": null }, { "id": "3d6480e8-9ea4-46dc-bb1b-8db190cd5677", "tenant_id": "060576782980d5762f9ec014dd2f1148", "security_group_id": "69c999ad-d9ef-4d79-94fd-35e6ceb75325", "remote_group_id": null, "direction": "egress", "protocol": null, "description": "", "ethertype": "IPv6", "remote_ip_prefix": null, "remote_address_group_id": null, "port_range_max": null, "port_range_min": null }, { "id": "9581f18c-1fdd-43da-ace9-7758a56ef28a", "tenant_id": "060576782980d5762f9ec014dd2f1148", "security_group_id": "69c999ad-d9ef-4d79-94fd-35e6ceb75325", "remote_group_id": null, "direction": "egress", "protocol": null, "description": "", "ethertype": "IPv4", "remote_ip_prefix": null, "remote_address_group_id": null, "port_range_max": null, "port_range_min": null }, { "id": "a3ba270e-e58b-432d-a912-aeb7eace9fb8", "tenant_id": "060576782980d5762f9ec014dd2f1148", "security_group_id": "69c999ad-d9ef-4d79-94fd-35e6ceb75325", "remote_group_id": "69c999ad-d9ef-4d79-94fd-35e6ceb75325", "direction": "ingress", "protocol": null, "description": "", "ethertype": "IPv4", "remote_ip_prefix": null, "remote_address_group_id": null, "port_range_max": null, "port_range_min": null } ] } }
  • 请求参数 表2 请求参数 名称 是否必选 参数类型 说明 security_group 是 security_group object 安全组对象,请参见表3。 表3 security_group字段说明 名称 是否必选 参数类型 说明 name 是 String 功能说明:安全组名称。 取值范围:1-64个字符,支持数字、字母、中文、_(下划线)、-(中划线)、.(点)。 vpc_id 否 String 安全组所在的vpc的资源标识。 说明: 当前该参数只作提示用,不约束安全组在此vpc下,不建议继续使用。 enterprise_project_id 否 String 功能说明:企业项目ID。创建安全组时,给安全组绑定企业项目ID。 取值范围:最大长度36字节,带“-”连字符的UUID格式,或者是字符串“0”。“0”表示默认企业项目。 说明: 关于企业项目ID的获取及企业项目特性的详细信息,请参见《企业管理用户指南》。
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 获取Token,请参考《统一身份认证服务API参考》的“获取用户Token”章节。请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。 表3 请求Body参数 参数 是否必选 参数类型 描述 tag 是 ResourceTag object 创建ACL资源标签请求体 表4 ResourceTag 参数 是否必选 参数类型 描述 key 是 String 功能说明:标签键 约束:同一资源的key值不能重复。 最大长度:128 value 是 String 功能说明:标签值 最大长度:255
  • 响应参数 状态码: 400 表5 响应Body参数 参数 参数类型 描述 request_id String 请求ID error_msg String 错误消息 error_code String 错误码 状态码: 401 表6 响应Body参数 参数 参数类型 描述 request_id String 请求ID error_msg String 错误消息 error_code String 错误码 状态码: 403 表7 响应Body参数 参数 参数类型 描述 request_id String 请求ID error_msg String 错误消息 error_code String 错误码 状态码: 404 表8 响应Body参数 参数 参数类型 描述 request_id String 请求ID error_msg String 错误消息 error_code String 错误码 状态码: 500 表9 响应Body参数 参数 参数类型 描述 request_id String 请求ID error_msg String 错误消息 error_code String 错误码
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 tags Array of ResourceTag objects tag对象列表 request_id String 请求ID 表4 ResourceTag 参数 参数类型 描述 key String 功能说明:标签键 约束:同一资源的key值不能重复。 最大长度:128 value String 功能说明:标签值 最大长度:255 状态码: 400 表5 响应Body参数 参数 参数类型 描述 request_id String 请求ID error_msg String 错误消息 error_code String 错误码 状态码: 401 表6 响应Body参数 参数 参数类型 描述 request_id String 请求ID error_msg String 错误消息 error_code String 错误码 状态码: 403 表7 响应Body参数 参数 参数类型 描述 request_id String 请求ID error_msg String 错误消息 error_code String 错误码 状态码: 404 表8 响应Body参数 参数 参数类型 描述 request_id String 请求ID error_msg String 错误消息 error_code String 错误码 状态码: 500 表9 响应Body参数 参数 参数类型 描述 request_id String 请求ID error_msg String 错误消息 error_code String 错误码