当前位置：主页 > 查看内容

轻量应用服务器 数据结构 - API 文档

发布时间：2021-09-09 00:00| 有 位朋友查看

简介：Blueprint 描述了镜像信息。 被如下接口引用：DescribeBlueprints。 名称 类型 描述 BlueprintId String 镜像 ID ，是 Blueprint 的唯一标识。 DisplayTitle String 镜像对外展示标题。 DisplayVersion String 镜像对外展示版本。 Description String 镜像描……

Blueprint

描述了镜像信息。

被如下接口引用：DescribeBlueprints。

名称 类型 描述
BlueprintId String 镜像 ID ，是 Blueprint 的唯一标识。
DisplayTitle String 镜像对外展示标题。
DisplayVersion String 镜像对外展示版本。
Description String 镜像描述信息。
OsName String 操作系统名称。
Platform String 操作系统平台。
PlatformType String 操作系统平台类型，如 LINUX_UNIX、WINDOWS。
BlueprintType String 镜像类型，如 APP_OS、PURE_OS、PRIVATE。
ImageUrl String 镜像图片 URL。
RequiredSystemDiskSize Integer 镜像所需系统盘大小。
BlueprintState String 镜像状态。
CreatedTime Timestamp ISO8601 创建时间。按照 ISO8601 标准表示，并且使用 UTC 时间。
格式为： YYYY-MM-DDThh:mm:ssZ。
注意：此字段可能返回 null，表示取不到有效值。
BlueprintName String 镜像名称。
SupportAutomationTools Boolean 镜像是否支持自动化助手。
RequiredMemorySize Integer 镜像所需内存大小, 单位: GB

Bundle

套餐信息。

被如下接口引用：DescribeBundles。

名称 类型 描述
BundleId String 套餐 ID。
Memory Integer 内存大小，单位 GB。
SystemDiskType String 系统盘类型。
取值范围：
  • LOCAL_BASIC：本地硬盘
  • LOCAL_SSD：本地 SSD 硬盘
  • CLOUD_BASIC：普通云硬盘
  • CLOUD_SSD：SSD 云硬盘
  • CLOUD_PREMIUM：高性能云硬盘
    		•
    SystemDiskSize Integer 系统盘大小。
    MonthlyTraffic Integer 每月网络流量，单位 Gb。
    SupportLinuxUnixPlatform Boolean 是否支持 Linux/Unix 平台。
    SupportWindowsPlatform Boolean 是否支持 Windows 平台。
    Price Price 套餐当前单位价格信息。
    CPU Integer CPU 核数。
    InternetMaxBandwidthOut Integer 峰值带宽，单位 Mbps。
    InternetChargeType String 网络计费类型。
    BundleSalesState String 套餐售卖状态,取值:‘AVAILABLE’(可用) , ‘SOLD_OUT’(售罄)
    BundleType String 套餐类型。
    取值范围：
  • GENERAL_BUNDLE：通用型
  • STORAGE_BUNDLE：存储型
    • BundleDisplayLabel String 套餐展示标签.
    取值范围:
    "ACTIVITY": 活动套餐,
    "NORMAL": 普通套餐
    "CAREFREE": 无忧套餐

    Filter

    描述键值对过滤器，用于条件过滤查询。例如过滤名称等

    • 若存在多个Filter时，Filter间的关系为逻辑与（AND）关系。
    • 若同一个Filter存在多个Values，同一Filter下Values间的关系为逻辑或（OR）关系。

    以DescribeInstances接口的Filter为例。若我们需要查询实例名称（instance-name）为test 并且 实例内网IP（private-ip-address）为10.10.10.10的实例时，可如下实现：

    Filters.0.Name=instance-name
&Filters.0.Values.0=test
&Filters.1.Name=private-ip-address
&Filters.1.Values.0=10.10.10.10

    被如下接口引用：DescribeBlueprints, DescribeBundles, DescribeInstances, DescribeSnapshots。

    名称 类型 必选 描述
    Name String 是 需要过滤的字段。
    Values Array of String 是 字段的过滤值。

    FirewallRule

    描述防火墙规则信息。

    被如下接口引用：CreateFirewallRules, DeleteFirewallRules。

    名称 类型 必选 描述
    Protocol String 是 协议，取值：TCP，UDP，ICMP，ALL。
    Port String 否 端口，取值：ALL，单独的端口，逗号分隔的离散端口，减号分隔的端口范围。
    CidrBlock String 否 网段或 IP (互斥)。默认为 0.0.0.0/0，表示所有来源。
    Action String 否 取值：ACCEPT，DROP。默认为 ACCEPT。
    FirewallRuleDescription String 否 防火墙规则描述。

    FirewallRuleInfo

    描述防火墙规则详细信息。

    被如下接口引用：DescribeFirewallRules。

    名称 类型 描述
    AppType String 应用类型，取值：自定义，HTTP(80)，HTTPS(443)，Linux登录(22)，Windows登录(3389)，MySQL(3306)，SQL Server(1433)，全部TCP，全部UDP，Ping-ICMP，ALL。
    Protocol String 协议，取值：TCP，UDP，ICMP，ALL。
    Port String 端口，取值：ALL，单独的端口，逗号分隔的离散端口，减号分隔的端口范围。
    CidrBlock String 网段或 IP (互斥)。默认为 0.0.0.0/0，表示所有来源。
    Action String 取值：ACCEPT，DROP。默认为 ACCEPT。
    FirewallRuleDescription String 防火墙规则描述。

    Instance

    描述了实例信息。

    被如下接口引用：DescribeInstances。

    名称 类型 描述
    InstanceId String 实例 ID。
    BundleId String 套餐 ID。
    BlueprintId String 镜像 ID。
    CPU Integer 实例的 CPU 核数，单位：核。
    Memory Integer 实例内存容量，单位：GB 。
    InstanceName String 实例名称。
    InstanceChargeType String 实例计费模式。取值范围：
    PREPAID：表示预付费，即包年包月。
    SystemDisk SystemDisk 实例系统盘信息。
    PrivateAddresses Array of String 实例主网卡的内网 IP。
    注意：此字段可能返回 空，表示取不到有效值。
    PublicAddresses Array of String 实例主网卡的公网 IP。
    注意：此字段可能返回 空，表示取不到有效值。
    InternetAccessible InternetAccessible 实例带宽信息。
    RenewFlag String 自动续费标识。取值范围：
    NOTIFY_AND_MANUAL_RENEW：表示通知即将过期，但不自动续费
    NOTIFY_AND_AUTO_RENEW：表示通知即将过期，而且自动续费 。
    LoginSettings LoginSettings 实例登录设置。
    InstanceState String 实例状态。取值范围：
  • PENDING：表示创建中
  • LAUNCH_FAILED：表示创建失败
  • RUNNING：表示运行中
  • STOPPED：表示关机
  • STARTING：表示开机中
  • STOPPING：表示关机中
  • REBOOTING：表示重启中
  • SHUTDOWN：表示停止待销毁
  • TERMINATING：表示销毁中
    		•
    Uuid String 实例全局唯一 ID。
    LatestOperation String 实例的最新操作。例：StopInstances、ResetInstance。注意：此字段可能返回 空值，表示取不到有效值。
    LatestOperationState String 实例的最新操作状态。取值范围：
    SUCCESS：表示操作成功
    OPERATING：表示操作执行中
    FAILED：表示操作失败
    注意：此字段可能返回 空值，表示取不到有效值。
    LatestOperationRequestId String 实例最新操作的唯一请求 ID。
    注意：此字段可能返回 空值，表示取不到有效值。
    IsolatedTime Timestamp ISO8601 隔离时间。按照 ISO8601 标准表示，并且使用 UTC 时间。
    格式为： YYYY-MM-DDThh:mm:ssZ。
    注意：此字段可能返回 null，表示取不到有效值。
    CreatedTime Timestamp ISO8601 创建时间。按照 ISO8601 标准表示，并且使用 UTC 时间。
    格式为： YYYY-MM-DDThh:mm:ssZ。
    注意：此字段可能返回 null，表示取不到有效值。
    ExpiredTime Timestamp ISO8601 到期时间。按照 ISO8601 标准表示，并且使用 UTC 时间。
    格式为： YYYY-MM-DDThh:mm:ssZ 。
    注意：此字段可能返回 null，表示取不到有效值。
    PlatformType String 操作系统平台类型，如 LINUX_UNIX、WINDOWS。
    Platform String 操作系统平台。
    OsName String 操作系统名称。

    InstancePrice

    关于Lighthouse Instance实例的价格信息

    被如下接口引用：DescribeBundles。

    名称 类型 描述
    OriginalBundlePrice Float 套餐单价原价。
    OriginalPrice Float 原价。
    Discount Integer 折扣。
    DiscountPrice Float 折后价。

    InstanceTrafficPackage

    实例流量包详情

    被如下接口引用：DescribeInstancesTrafficPackages。

    名称 类型 描述
    InstanceId String 实例ID。
    TrafficPackageSet Array of TrafficPackage 流量包详情列表。

    InternetAccessible

    描述了启动配置创建实例的公网可访问性，声明了实例的公网使用计费模式，最大带宽等。

    被如下接口引用：DescribeInstances。

    名称 类型 描述
    InternetChargeType String 网络计费类型。
    InternetMaxBandwidthOut Integer 公网出带宽上限，单位：Mbps。
    PublicIpAssigned Boolean 是否分配公网 IP。

    LoginSettings

    描述了实例登录相关配置与信息。

    被如下接口引用：DescribeInstances。

    名称 类型 描述
    KeyIds Array of String 密钥 ID 列表。关联密钥后，就可以通过对应的私钥来访问实例。注意：此字段可能返回 []，表示取不到有效值。

    Price

    价格信息

    被如下接口引用：DescribeBundles。

    名称 类型 描述
    InstancePrice InstancePrice 实例价格。

    Snapshot

    描述了快照相关信息。

    被如下接口引用：DescribeSnapshots。

    名称 类型 描述
    SnapshotId String 快照 ID。
    DiskUsage String 创建此快照的磁盘类型。取值：
  • SYSTEM_DISK：系统盘
    		•
    DiskId String 创建此快照的磁盘 ID。
    DiskSize Integer 创建此快照的磁盘大小，单位 GB。
    SnapshotName String 快照名称，用户自定义的快照别名。
    SnapshotState String 快照的状态。取值范围：
  • NORMAL：正常
  • CREATING：创建中
  • ROLLBACKING：回滚中。
    		•
    Percent Integer 创建或回滚快照进度百分比，成功后此字段取值为 100。
    LatestOperation String 快照的最新操作，只有创建、回滚快照时记录。
    取值如 CreateInstanceSnapshot，RollbackInstanceSnapshot。
    注意：此字段可能返回 null，表示取不到有效值。
    LatestOperationState String 快照的最新操作状态，只有创建、回滚快照时记录。
    取值范围：
  • SUCCESS：表示操作成功
  • OPERATING：表示操作执行中
  • FAILED：表示操作失败

    • 注意：此字段可能返回 null，表示取不到有效值。
    LatestOperationRequestId String 快照最新操作的唯一请求 ID，只有创建、回滚快照时记录。
    注意：此字段可能返回 null，表示取不到有效值。
    CreatedTime Timestamp ISO8601 快照的创建时间。

    SystemDisk

    描述了操作系统所在块设备即系统盘的信息。

    被如下接口引用：DescribeInstances。

    名称 类型 描述
    DiskType String 系统盘类型。
    取值范围：
  • LOCAL_BASIC：本地硬盘
  • LOCAL_SSD：本地 SSD 硬盘
  • CLOUD_BASIC：普通云硬盘
  • CLOUD_SSD：SSD 云硬盘
  • CLOUD_PREMIUM：高性能云硬盘
    		•
    DiskSize Integer 系统盘大小，单位：GB。
    DiskId String 系统盘ID。
    注意：此字段可能返回 null，表示取不到有效值。

    TrafficPackage

    流量包详情

    被如下接口引用：DescribeInstancesTrafficPackages。

    名称 类型 描述
    TrafficPackageId String 流量包ID。
    TrafficUsed Integer 流量包生效周期内已使用流量，单位字节。
    TrafficPackageTotal Integer 流量包生效周期内的总流量，单位字节。
    TrafficPackageRemaining Integer 流量包生效周期内的剩余流量，单位字节。
    TrafficOverflow Integer 流量包生效周期内超出流量包额度的流量，单位字节。
    StartTime Timestamp ISO8601 流量包生效周期开始时间。按照 ISO8601 标准表示，并且使用 UTC 时间。
    格式为： YYYY-MM-DDThh:mm:ssZ。
    注意：此字段可能返回 null，表示取不到有效值。
    EndTime Timestamp ISO8601 流量包生效周期结束时间。按照 ISO8601 标准表示，并且使用 UTC 时间。
    格式为： YYYY-MM-DDThh:mm:ssZ。
    注意：此字段可能返回 null，表示取不到有效值。
    Deadline Timestamp ISO8601 流量包到期时间。按照 ISO8601 标准表示，并且使用 UTC 时间。
    格式为： YYYY-MM-DDThh:mm:ssZ。
    注意：此字段可能返回 null，表示取不到有效值。
    Status String 流量包状态：
  • NETWORK_NORMAL：正常
  • OVERDUE_NETWORK_DISABLED：欠费断网
    		•

    本站部分内容转载于网络，版权归原作者所有，转载之目的在于传播更多优秀技术内容，如有侵权请联系QQ/微信：153890879删除，谢谢！
    上一篇：购买预留实例券 - 云服务器 ECS 下一篇：没有了

    推荐图文

    • 周排行
    • 月排行
    • 总排行

    随机推荐