API Overview

Last updated: 2020-06-07 15:11:59

    Note:

    This is a legacy API which has been hidden and will no longer be updated. We recommend using the new CVM API 3.0 which is standardized and faster.

    Feature Action ID Description
    View instance list DescribeInstances Obtain the details of one or more instances.
    View instance status list DescribeInstancesStatus Query the status of one of more instances.
    Create instances RunInstances Create one or more instances with specified configuration.
    Inquire the prices of created instances InquiryPriceRunInstances Inquire the prices of created instances
    Start up instances StartInstances Start up one or more instances.
    Stop instances StopInstances Stop running of one or more instances.
    Return instances TerminateInstances Return instances.
    Restart instances RebootInstances Restart one or more instances.
    Reinstall system ResetInstance Reinstall the operating system on the specified instance.
    Query the prices of reinstalled operating systems InquiryPriceResetInstance Inquire the prices of reinstalled operating systems.
    Scale up instance disks ResizeInstanceDisks Scale up disks for an instance.
    Inquire the prices of scaled-up disks for an instance InquiryPriceResizeInstanceDisks Inquire the prices of scaled-up disks for an instance.
    Adjust instance configurations ResetInstancesType Adjust instance models.
    Inquire the prices of adjusted instance configurations InquiryPriceResetInstancesType Query the prices of adjusted instance models.
    Modify instance attributes ModifyInstancesAttribute Modify instance attributes.
    Adjust the upper limit of bandwidth for instances ResetInstancesInternetMaxBandwidth Adjust the upper limit of the public network bandwidth for instances.
    Modify the project to which an instance belongs ModifyInstancesProject Modify the project to which an instance belongs.
    Modify VPC attributes UpdateInstanceVpcConfig Modify VPC attributes, such as IP.
    Reset instance password ResetInstancesPassword Reset the password of the instance's operating system to a user-specified value.

    Feature Action ID Description
    View image list DescribeImages Obtain the images that current account can use to create CVM instances.
    Create custom images CreateImage Make the current status of instance system disk into a new image, which can be used to quickly create instances.
    Delete images DeleteImages Delete one or more images.
    Modify image attributes ModifyImageAttribute Modify the information of an image such as name and description.
    Synchronize images SyncImages Copy (synchronize) a custom image to another region.
    Modify image-sharing information ModifyImageSharePermission Set image permissions.
    Query image-sharing information DescribeImageSharePermission Query the image-sharing information of current account, including the list of accounts to which the image is shared.

    Feature Action ID Description
    Bind a server with an Elastic NIC AttachNetworkInterface Bind a server with an EIP

    Feature Action ID Description
    Query security group list DescribeSecurityGroups Query existing security groups.
    Create security groups CreateSecurityGroup Create security groups.
    Delete security groups DeleteSecurityGroup Delete security groups.
    Modify security group attributes ModifySecurityGroupAttributes Modify the attribute information of an existing security group, including name and description.
    Query security group rules DescribeSecurityGroupPolicy Query the rules for existing security groups.
    Modify security group rules ModifySecurityGroupPolicy Modify the rules for existing security groups.
    Query the list of instances associated with a security group DescribeInstancesOfSecurityGroup Query the CVM associated with the specified security group.
    Modify the security group associated with instances ModifySecurityGroupsOfInstance Modify the security group associated with the specified CVM.
    Query the list of associated security groups DescribeAssociateSecurityGroups Query which security groups have outbound or inbound rules that contain the entered security group ID.

    Feature Action ID Description
    Query the list of elastic public IPs (EIPs) DescribeEip Query EIPs
    Query the quota on EIPs DescribeEipQuota Query the quota on EIPs for a specified region.
    Modify EIP name ModifyEipAttributes Modify the EIP name.
    Create an EIP CreateEip Create an EIP, a static IP address designed for dynamic cloud computing. With EIP, you can quickly remap the EIP to another instance, shielding off the instance failures.
    Release an EIP DeleteEip Release an EIP.
    Bind an EIP EipBindInstance Bind an EIP to a server.
    Unbind an EIP EipUnBindInstance Unbind an EIP from a server.
    Transform an ordinary public IP to an EIP TransformWanIpToEip Transform an ordinary public IP bound to the server to an EIP. After the conversion, the EIP will be retained when the server is released.

    Feature Action ID Description
    Query key pair list DescribeKeyPairs Query key pair information.
    Create a key pair CreateKeyPair Create an OpenSSH RSA key pair that can be used to log in to a Linux instance.
    Modify key pair attributes ModifyKeyPairAttribute Modify key pair attributes.
    Delete key pairs DeleteKeyPairs Delete a key pair hosted on Tencent Cloud.
    Import a key pair ImportKeyPair Import a key pair.
    Bind a key pair AssociasteInstancesKeyPairs Bind a key pair to an instance.
    Unbind a key pair DisassociasteInstancesKeyPairs Unbind a key pair from an instance.

    Was this page helpful?

    Was this page helpful?

    • Not at all
    • Not very helpful
    • Somewhat helpful
    • Very helpful
    • Extremely helpful
    Send Feedback
    Help