OpenAPI文档
  • 基础、平台产品
  • CDN
  • Kafka
  • Memcached
  • MongoDB
  • MySQL
  • Redis
  • 对象存储
  • 对象存储(v1.1)
  • 负载均衡
  • 新版MongoDB
  • Vira
  • Vira2

首云Open API目录

# 首云 Open API 目录

  • 首云公开 API 文档 (opens new window)

    • 认证方式 (opens new window)

      • 1.公共请求参数 (opens new window)
      • 2.签名机制 (opens new window)
        • 步骤一:构造规范化请求字符串 (opens new window)
        • 步骤二:构造签名字符串 (opens new window)
      • 3.获取签名代码 (opens new window)
    • 访问地址 (opens new window)

    • 实例相关 (opens new window)

      • 1.CreateInstance (opens new window)
      • 2.DeleteInstance (opens new window)
      • 3.StopInstance (opens new window)
      • 4.RebootInstance (opens new window)
      • 5.ModifyInstanceChargeType (opens new window)
      • 6.ModifyInstanceSpec (opens new window)
      • 7.CreateDisk (opens new window)
      • 8.ResizeDisk (opens new window)
      • 9.DeleteDisk (opens new window)
      • 11.DescribeInstances (opens new window)
      • 12.ConnectNetworkInterface (opens new window)
      • 13.DisconnectNetworkInterface (opens new window)
      • 14.ModifyIpAddress (opens new window)
      • 15.DescribeInstanceMonitor (opens new window)
      • 16.StartInstance (opens new window)
      • 17.ModifyInstanceName (opens new window)
      • 18.DescribeTags (opens new window)
      • 19.CreateTag (opens new window)
      • 20.DeleteTag (opens new window)
      • 21.AddInstancesTags (opens new window)
      • 22.DeleteInstancesTags (opens new window)
      • 23.DescribeInstanceType (opens new window)
      • 24.DescribePublicIp (opens new window)
      • 25.DescribePrivateIp (opens new window)
      • 26.ResetInstancesPassword (opens new window)
      • 27.CreateInstanceHtmlConsoleURL (opens new window)
      • 28.ExtendSystemDisk (opens new window)
      • 29.DescribeInstancePrice (opens new window)
      • 30.StopInstances (opens new window)
      • 31.StartInstances (opens new window)
      • 32.RebootInstances (opens new window)
      • 33.BatchAddNetworkInterfaces (opens new window)
      • 34.BatchDeleteNetworkInterfaces (opens new window)
    • 安全组相关 (opens new window)

      • 1.CreateSecurityGroup (opens new window)
      • 2.DeleteSecurityGroup (opens new window)
      • 3.ForceDeleteSecurityGroup (opens new window)
      • 4.DescribeSecurityGroupAttribute (opens new window)
      • 5.ModifySecurityGroupAttribute (opens new window)
      • 6.DescribeSecurityGroups (opens new window)
      • 7.AddSecurityGroupRule (opens new window)
      • 8.RemoveSecurityGroupRule (opens new window)
      • 9.ModifySecurityGroupRule (opens new window)
      • 10.JoinSecurityGroup (opens new window)
      • 11.LeaveSecurityGroup (opens new window)
      • 12.ModifySecurityGroupRulePriority (opens new window)
    • 模板相关 (opens new window)

      • 1.CreateTemplate (opens new window)
      • 2.DeleteTemplate (opens new window)
      • 3.SyncTemplate (opens new window)
      • 4.DescribeTemplateInfo (opens new window)
    • 虚拟数据中心相关 (opens new window)

      • 1.DescribeVdc (opens new window)
      • 2.CreateVdc (opens new window)
      • 3.DeleteVdc (opens new window)
      • 4.CreatePublicNetwork (opens new window)
      • 5.CreatePrivateNetwork (opens new window)
      • 6.ModifyPublicNetwork (opens new window)
      • 7.AddPublicIp (opens new window)
      • 8.DeletePublicIp (opens new window)
      • 9.DeletePublicNetwork (opens new window)
      • 10.DeletePrivateNetwork (opens new window)
      • 11.RenewPublicNetwork (opens new window)
      • 12.DescribeBandwidthTraffic (opens new window)
      • 13.DescribeGPN (opens new window)
      • 14.AddAccessPoint (opens new window)
      • 15.DeleteAccessPoint (opens new window)
      • 16.DescribeAccessInfo (opens new window)
      • 17.CreateGPN (opens new window)
      • 18.DeleteGPN (opens new window)
      • 19.ModifyVdcName (opens new window)
      • 20.DescribePipeUtilization (opens new window)
      • 21.VDCBandwidthBillingScheme (opens new window)
      • 22.VDCBandwidthUnitPrice (opens new window)
    • 私有网络相关 (opens new window)

      • 1.DescribeVPC (opens new window)
      • 2.CreateVPC (opens new window)
      • 3.DeleteVPC (opens new window)
      • 4.DescribeSubnet (opens new window)
      • 5.CreateSubnet (opens new window)
      • 6.DeleteSubnet (opens new window)
      • 7.DescribeVirtualGateWay (opens new window)
      • 8.CreateVirtualGateWay (opens new window)
      • 9.DeleteVirtualGateWay (opens new window)
      • 10.DescribeEIP (opens new window)
      • 11.CreateEIP (opens new window)
      • 12.UpdateEIP (opens new window)
      • 13.DeleteEIP (opens new window)
      • 14.BindEIP (opens new window)
      • 15.UnbindEIP (opens new window)
      • 16.DescribeBandwidth (opens new window)
      • 17.CreateBandwidth (opens new window)
      • 18.UpdateBandwidth (opens new window)
      • 19.DeleteBandwidth (opens new window)
      • 20.BandwidthAddEIP (opens new window)
      • 21.BandwidthRemoveEIP (opens new window)
      • 22.DescribeIPInfo (opens new window)
      • 23.NetEIPInfo (opens new window)
      • 24.ReserveIPAndBindEIP (opens new window)
      • 25.DescribeSubnetIp (opens new window)
      • 26.CreateVLINK (opens new window)
      • 27.DeleteVLINK (opens new window)
      • 28.VLINKAddVM (opens new window)
      • 29.VLINKDeleteVM (opens new window)
      • 30.UpdateVPCBandwidthType (opens new window)
    • 裸金属相关 (opens new window)

      • 1.DescribeBmsGoods (opens new window)
      • 2.DescribeBmsGoodsPrice (opens new window)
      • 3.DescribeBmsImage (opens new window)
      • 4.CreateBmsInstance (opens new window)
      • 5.DescribeBms (opens new window)
      • 6.DescribeBmsDetail (opens new window)
      • 7.OperateBmsPower (opens new window)
      • 8.ReinstallBms (opens new window)
      • 9.DescribeBmsVNC (opens new window)
      • 10.ModifyBmsOrder (opens new window)
      • 11.DescribeBmsTask (opens new window)
      • 12.DeleteBmsInstance (opens new window)
    • 裸金属云盘相关 (opens new window)

      • 1.CreateDisk (opens new window)
      • 2.AttachDisk (opens new window)
      • 3.DetachDisk (opens new window)
      • 4.DeleteDisk (opens new window)
      • 5.DescribeDisks (opens new window)
      • 6.DescribeDiskUsage (opens new window)
      • 7.DescribePoolUsage (opens new window)
      • 8.ChangeIops (opens new window)
      • 9.ChangeBandwidth (opens new window)
      • 10.ExpansionSize (opens new window)
      • 11.CreateSnapshot (opens new window)
      • 12.CloneSnapshot (opens new window)
      • 13.DeleteSnapshot (opens new window)
      • 14.RollbackSnapshot (opens new window)
      • 15.DescribeGoodsId (opens new window)
    • 账单相关 (opens new window)

      • 1.DescribeBill (opens new window)
      • 2.DescribeBillInfo (opens new window)
      • 3.DescribeBillDetail (opens new window)
      • 4.DescribeAccountInfo (opens new window)
      • 5.DescribeCostSummaryByPro (opens new window)
      • 6.DescribeCostSummaryByProject (opens new window)
    • 测试项目相关 (opens new window)

      • 1.DescribeSubjects (opens new window)
    • 冷云计量相关 (opens new window)

      • 1.GetMetering (opens new window)
    • MySQL 相关 (opens new window)

      • 1.DescribeRegions (opens new window)
      • 2.DescribeAvailableDBConfig (opens new window)
      • 3.CreateDBInstance (opens new window)
      • 4.DescribeDBInstances (opens new window)
      • 5.CreatePrivilegedAccount (opens new window)
      • 6.DescribeModifiableDBSpec (opens new window)
      • 7.ModifyDBInstanceSpec (opens new window)
      • 8.DeleteDBInstance (opens new window)
      • 9.DescribeAvailableReadOnlyConfig (opens new window)
      • 10.CreateReadOnlyDBInstance (opens new window)
      • 11.CreateBackup (opens new window)
      • 12.DescribeBackups (opens new window)
      • 13.DeleteBackup (opens new window)
      • 14.DownloadBackup (opens new window)
      • 15.StartBatchRollback (opens new window)
      • 16.DescribeRollbackRangeTime (opens new window)
      • 17.StartBatchRollbackToTemporaryDBInstance (opens new window)
      • 18.DescribeTemporaryDBInstances (opens new window)
      • 19.RegularizeTemporaryDBInstances (opens new window)
      • 20.DeleteTemporaryDBInstances (opens new window)
    • Redis 相关 (opens new window)

      • 1.DescribeRegins (opens new window)
      • 2.DescribeAvailableDBConfig (opens new window)
      • 3.CreateDBInstance (opens new window)
      • 4.DescribeDBInstances (opens new window)
      • 5.DeleteDBInstance (opens new window)
      • 6.DescribeBackups (opens new window)
      • 7.DownloadBackup (opens new window)
      • 8.CreateBackup (opens new window)
      • 9.DeleteBackup (opens new window)
      • 10.DescribeRedisConfig (opens new window)
    • MongoDB 相关 (opens new window)

      • 1.DescribeZones (opens new window)
      • 2.DescribeSpecInfo (opens new window)
      • 3.CreateDBInstance (opens new window)
      • 4.DescribeDBInstances (opens new window)
      • 5.DeleteDBInstance (opens new window)
    • 新版 MongoDB 相关 (opens new window)

      • 1.DescribeZones (opens new window)
      • 2.DescribeSpecInfo (opens new window)
      • 3.CreateDBInstance (opens new window)
      • 4.DescribeDBInstances (opens new window)
      • 5.DeleteDBInstance (opens new window)
    • Memcached 相关 (opens new window)

      • 1.CreateMemcachedInstance (opens new window)
      • 2.MemcachedInstanceList (opens new window)
      • 3.DescribeMemcachedInstance (opens new window)
      • 4.DeleteMemcachedInstance (opens new window)
      • 5.ClearMemcachedInstance (opens new window)
      • 6.UpdateMemcachedInstance (opens new window)
    • Kafka 相关 (opens new window)

      • 1.GetKafkaList (opens new window)
    • HaProxy 相关 (opens new window)

      • 1.DescribeZones (opens new window)
      • 2.DescribeLoadBalancersSpec (opens new window)
      • 3.CreateLoadBalancer (opens new window)
      • 4.DescribeLoadBalancers (opens new window)
      • 5.DescribeLoadBalancersModifySpec (opens new window)
      • 6.ModifyLoadBalancerInstanceSpec (opens new window)
      • 7.DeleteloadBalancer (opens new window)
      • 8.DescribeCACertificates (opens new window)
      • 9.DescribeCACertificate (opens new window)
      • 10.DeleteCACertificate (opens new window)
      • 11.UploadCACertificate (opens new window)
      • 12.DescribeLoadBalancerStrategys (opens new window)
      • 13.ModifyLoadBalancerStrategys (opens new window)
    • CDN 相关 (opens new window)

      • 1.CreateCDN (opens new window)
      • 2.DescribeCDN (opens new window)
      • 3.DescribeCDNInfo (opens new window)
      • 4.ModifyCDN (opens new window)
      • 5.EnableCDN (opens new window)
      • 6.DisableCDN (opens new window)
      • 7.DeleteCDN (opens new window)
      • 8.ModifyProtocol (opens new window)
      • 9.CreateSSL (opens new window)
      • 10.ModifySSL (opens new window)
      • 11.DescribeSSL (opens new window)
      • 12.DescribeSSLInfo (opens new window)
      • 13.PrefetchFile (opens new window)
      • 14.ContentRefresh (opens new window)
      • 15.FlowStatistics (opens new window)
      • 16.DosageAnalysis (opens new window)
      • 17.PathMetering (opens new window)
    • 网络告警相关 (opens new window)

    • 1.GetWanAlarmReceiver (opens new window)

    • 2.UpdateWanAlarmReceiver (opens new window)

    • 云桌面相关 (opens new window)

      • 1.QueryTask (opens new window)
      • 2.QuerySites (opens new window)
      • 3.QueryProducts (opens new window)
      • 4.QueryImages (opens new window)
      • 5.QueryVmPrice (opens new window)
      • 6.UpdateOrder (opens new window)
      • 7.RenewalOrder (opens new window)
      • 8.QuerySubAccounts (opens new window)
      • 9.CreateSubAccount (opens new window)
      • 10.CreateSubAccounts (opens new window)
      • 11.ChangeSubAccountName (opens new window)
      • 12.ChangeSubAccountRemark (opens new window)
      • 13.CreateDefaultNet (opens new window)
      • 14.SupplyDefaultNet (opens new window)
      • 15.GetDefaultNet (opens new window)
      • 16.GetCustomNet (opens new window)
      • 17.GetLineBillingScheme (opens new window)
      • 18.GetEipPrice (opens new window)
      • 19.QueryVms (opens new window)
      • 20.QueryVm (opens new window)
      • 21.QueryExpireVms (opens new window)
      • 22.CreateVm (opens new window)
      • 23.OperateVm (opens new window)
      • 24.RebuildVm (opens new window)
      • 25.DeleteVm (opens new window)
      • 26.ChangeVmName (opens new window)
      • 27.UpdateVmLabels (opens new window)
      • 28.ChangeAccount (opens new window)
      • 29.UnbindAccounts (opens new window)
      • 30.BindAccounts (opens new window)
    • 弹性云服务器 ECS 相关 (opens new window)

      • 1.DescribeRegions (opens new window)
      • 2.DescribeEcsFamilyInfo (opens new window)
      • 3.DescribeImage (opens new window)
      • 4.DescribeInstanceList (opens new window)
      • 5.DescribePrice (opens new window)
      • 6.DescribeInstance (opens new window)
      • 7.DescribeInstanceStatus (opens new window)
      • 8.DescribeEvent (opens new window)
      • 9.CreateInstance (opens new window)
      • 10.OperateInstance (opens new window)
      • 11.DeleteInstance (opens new window)
      • 12.ModifyInstancePassword (opens new window)
      • 13.ModifyInstanceName (opens new window)
    • 云盘 EBS 相关 (opens new window)

      • 1.CreateDisk (opens new window)
      • 2.DeleteDisk (opens new window)
      • 3.DetachDisk (opens new window)
      • 4.AttachDisk (opens new window)
      • 5.ExtendDisk (opens new window)
      • 6.DescribeDiskQuota (opens new window)
      • 7.DescribeDiskList (opens new window)
      • 8.DescribeDisk (opens new window)
      • 9.DescribeEcsAttachDisks (opens new window)
      • 10.DescribeEvent (opens new window)
    • 快照 SNAPSHOT 相关 (opens new window)

      • 1.DescribeSnapshotList (opens new window)
      • 2.DescribeSnapshot (opens new window)
      • 3.DescribeSnapshotChainList (opens new window)
      • 4.DescribeSnapshotChain (opens new window)
      • 5.CreateSnapshot (opens new window)
      • 6.RollbackDiskBySnapshot (opens new window)
      • 7.RenameSnapshot (opens new window)
      • 8.DeleteSnapshot (opens new window)
      • 9.DescribeSnapshotQuota (opens new window)
    • ECS 安全组相关接口 (opens new window)

      • 1.DescribeSecurityGroups (opens new window)
      • 2.CreateSecurityGroup (opens new window)
      • 3.ModifySecurityGroupAttribute (opens new window)
      • 4.DeleteSecurityGroup (opens new window)
      • 5.CreateSecurityGroupPolicies (opens new window)
      • 6.DescribeSecurityGroupPolicies (opens new window)
      • 7.DeleteSecurityGroupPolicies (opens new window)
      • 8.ModifySecurityGroupPolicies (opens new window)
      • 9.AssociateSecurityGroups (opens new window)
      • 10.DisassociateSecurityGroups (opens new window)
      • 11.ModifySecurityGroupsPriority (opens new window)
      • 12.DescribeSecurityGroupAssociationStatistics (opens new window)
    • 其他公共接口 (opens new window)

      • 1.DescribeAvailableResource (opens new window)
      • 2.DescribeTask (opens new window)
    • 附件一 (opens new window) * 可用区名称 (opens new window)

    • 附件二 (opens new window) * 主机类型 (opens new window)

    • 附件三 (opens new window) * 带宽类型 (opens new window)

    • 附件四 (opens new window) * 公共模板 (opens new window)

    • 示例 (opens new window)

      • 1.获取请求 url (opens new window)
      • 2.获取虚拟数据中心公网信息 (opens new window)
      • 3.获取机器信息 (opens new window)
      • 4.创建云主机实例 (opens new window)
      • 5.修改公网带宽 (opens new window)
      • 6.修改云主机实例计费类型 (opens new window)
      • 7.获取任务状态 (opens new window)
      • 8.定制模板 (opens new window)