QingCloud 文档 – 云应用 - kaiyun官方网站下载手机网页

Development_docs: AddClusterNodes

Mon, 01 Jan 0001 00:00:00 +0000

横向扩容集群，增加集群节点。前提是集群支持增加节点的操作，即应用配置中角色 advanced_actions 包含 scale_horizontal ，可以通过 API DescribeAppVersions 来查看应用的配置文件是否包含此配置，也可以通过 API DescribeClusters 来查看集群的角色是否支持此操作。

Request Parameters

Parameter name	Type	Description	Required
cluster	String	增加节点的集群ID	Yes
node_count	Integer	增加的节点数量	Yes
noede_role	String	增加的节点的角色，如无角色，可不传递此项	No
resource_conf	String	JSON格式的节点配置，保持默认配置，此项留空即可	No
private_ips	String	JSON格式的节点私有ip地址	No
node_name	String	节点的名称	No

公共参数

Response Elements

Name	Type	Description
action	String	响应动作
cluster_id	String	集群的ID
new_node_ids	Array	新增的节点ID
job_id	String	执行任务的 Job ID
ret_code	Integer	执行成功与否，0 表示成功，其他值则为错误代码

Example

以应用ZooKeeper为例，则

Example Request:

https://api.qingcloud.com/iaas/?action=AddClusterNodes
&cluster=cl-q1witcdk
&node_count=2
&node_name=
&node_role=
&resource_conf=
&zone=pek3b
&COMMON_PARAMS

Example Response:

{
  "action":"AddClusterNodesResponse",
  "cluster_id":"cl-q1witcdk",
  "job_id":"j-kzpol0l3k1l",
  "new_node_ids":[
    "cln-2x5w6l81",
    "cln-b9gis6au"
  ],
  "ret_code":0
}

Development_docs: AssociateEipToClusterNode

Mon, 01 Jan 0001 00:00:00 +0000

为集群节点绑定一个公网IP。绑定公网IP需要应用本身支持，即应用的mustache配置文件中角色的advanced_actions定义了associate_eip。可以通过 API DescribeAppVersions 来查看应用的配置文件是否包含此配置，也可以通过 API DescribeClusters 来查看集群的角色是否支持此操作。

注意：绑定公网IP会给集群绑定默认的防火墙。

Request Parameters

Parameter name	Type	Description	Required
eip	String	公网IP的ID	Yes
cluster_node	String	集群节点ID	Yes

公共参数

Response Elements

Name	Type	Description
action	String	响应动作
job_id	String	执行任务的 Job ID
ret_code	Integer	执行成功与否，0 表示成功，其他值则为错误代码

Example Request:

https://api.qingcloud.com/iaas/?action=AssociateEipToClusterNode
&cluster_node=cln-jmrv7xfv
&eip=eip-ek3scgap
&zone=test
&COMMON_PARAMS

Example Response:

{
  "action":"AssociateEipToClusterNodeResponse",
  "job_id":"j-olda0tqkyyc",
  "ret_code":0
}

Development_docs: CeaseClusters

Mon, 01 Jan 0001 00:00:00 +0000

彻底删除集群，可以是一个或者多个集群。

注意：集群彻底删除后，不可恢复，请谨慎操作

Request Parameters

Parameter name	Type	Description	Required
clusters.n	String	将要启动的集群ID	Yes

公共参数

Response Elements

Name	Type	Description
action	String	响应动作
job_id	String	执行任务的 Job ID
ret_code	Integer	执行成功与否，0 表示成功，其他值则为错误代码

Example Request:

https://api.qingcloud.com/iaas/?&action=CeaseClusters
&clusters.1=cl-2gi2b3oc
&zone=pek3b
&COMMON_PARAMS

Example Response:

{
  "action":"CeaseClustersResponse",
  "job_id":"j-1br9d0839v1",
  "ret_code":0
}

Development_docs: ChangeClusterVxnet

Mon, 01 Jan 0001 00:00:00 +0000

切换集群的网络，前提是集群必须支持此操作，即应用的mustache配置文件中角色的advanced_actions定义了change_vxnet。可以通过 API DescribeAppVersions 来查看应用的配置文件是否包含此配置，也可以通过 API DescribeClusters 来查看集群的角色是否支持此操作。

Request Parameters

Parameter name	Type	Description	Required
cluster	String	集群ID	Yes
vxnet	String	集群即将加入的网络的ID	Yes
roles.n	String	集群的角色	No
private_ips.n.node_id	String	节点ID	No
private_ips.n.private_ip	String	节点对应的私有IP	No

公共参数

Response Elements

Name	Type	Description
action	String	响应动作
job_id	String	执行任务的 Job ID
ret_code	Integer	执行成功与否，0 表示成功，其他值则为错误代码

Example

以应用ZooKeeper为例

Example Request:

https://api.qingcloud.com/iaas/?action=ChangeClusterVxnet
&cluster=cl-q1witcdk
&vxnet=vxnet-iuy3lnd
&private_ips.1.node_id=cln-nqop00oj
&private_ips.1.private_ip=192.168.1.4
&private_ips.2.node_id=cln-oruuckuo
&private_ips.2.private_ip=192.168.1.2
&private_ips.3.node_id=cln-veb7g8nx
&private_ips.3.private_ip=192.168.1.3
&zone=pek3b
&COMMON_PARAMS

Example Response:

{
  "action":"ChangeClusterVxnetResponse",
  "ret_code":0,
  "cluster_id":"cl-q1witcdk",
  "vxnet_id":"vxnet-vzvzkno",
  "job_id":"j-72j4zto5q7x"
}

Development_docs: DeleteClusterNodes

Mon, 01 Jan 0001 00:00:00 +0000

删除集群的一个或多个节点，前提是集群支持增加节点的操作，可以通过　查看应用是否支持。

Request Parameters

Parameter name	Type	Description	Required
cluster	String	集群的ID	Yes
nodes.n	String	将要删除的集群节点的ID	Yes
force	Integer	是否强制删除，1表示强制删除，0表示否，默认为0	No

Response Elements

Name	Type	Description
action	String	响应动作
cluster_id	String	集群ID
deleted_node_ids	Array	删除的集群节点ID
job_id	String	执行任务的 Job ID
ret_code	Integer	执行成功与否，0 表示成功，其他值则为错误代码

Example

以应用ZooKeeper为例

Example Request:

https://api.qingcloud.com/iaas/?
action=DeleteClusterNodes
&cluster=cl-q1witcdk
&force=0
&nodes.1=cln-2x5w6l81
&nodes.2=cln-yrlus78f
&zone=pek3b
&COMMON_PARAMS

Example Response:

{
  "action":"DeleteClusterNodesResponse",
  "deleted_node_ids":[
    "cln-2x5w6l81",
    "cln-yrlus78f"
  ],
  "cluster_id":"cl-q1witcdk",
  "job_id":"j-qgn3a6cegfe",
  "ret_code":0
}

Development_docs: DeleteClusters

Mon, 01 Jan 0001 00:00:00 +0000

删除一个或多个集群

销毁集群的前提，是此集群已建立租用信息（租用信息是在创建集群成功后，几秒钟内系统自动建立的）。所以正在创建的集群，以及刚刚创建成功但还没有建立租用信息的集群，是不能被销毁的。。

Request Parameters

Parameter name	Type	Description	Required
cluster.n	String	一个或多个集群ID	Yes
direct_cease	Integer	是否直接彻底销毁集群，如果指定`1`则不会进入回收站直接销毁，默认为`0`	No

Response Elements

Name	Type	Description
action	String	响应动作
job_id	Dict	执行任务的 Job ID，格式为`{"cl-zydsaee":"j-baoidfsa"}`
ret_code	Integer	执行成功与否，0 表示成功，其他值则为错误代码

Example

Example Request:

https://api.qingcloud.com/iaas/?action=DeleteClusters
&clusters.1=cl-11esmufq
&zone=pek3a
&COMMON_PARAMS

Example Response:

{
  "action":"DeleteClustersResponse",
  "job_ids":{
    "cl-11esmufq":"j-bt9myvtwqt8"
  },
  "ret_code":0
}

Development_docs: DeployAppVersion

Mon, 01 Jan 0001 00:00:00 +0000

部署指定应用版本的集群

当你部署应用时，集群会先进入pending状态，创建完成后，集群变成active状态。你可以使用DescribeClusters检查集群状态。

此API需要你传递一个JSON格式的conf参数，对于不同的应用，此参数格式会有不同，请结合DescribeAppVersions 来确定conf参数的格式。

Request Parameters

Parameter name	Type	Description	Required
version_id	String	将要部署应用的版本ID	Yes
conf	String	集群的配置信息(转义并去除空格的JSON格式)	Yes
debug	Integer	集群是否为开发测试集群。此项针对开发者，如果开发者完成应用上传，部署开发的应用指定debug值可以跳过服务费计费	No

公共参数

Response Elements

Name	Type	Description
action	String	响应动作
node_ids	Array	集群的节点ID
app_id	String	应用ID
app_version	String	应用的版本ID
node_count	Integer	集群节点的数量
cluster_name	String	集群的名称
cluster_id	String	集群ID
vxnet_id	String	集群所在的网络ID
job_id	String	执行任务的 Job ID
ret_code	Integer	执行成功与否，0 表示成功，其他值则为错误代码

Example

以应用Tomcat Cluster为例，请使用DescribeAppVersions来查看应用的config.json和cluster.json.mustache配置文件，以此来确定conf的具体值。通过DescribeAppVersions获得的 Tomcat Cluster 应用的 config.json 配置文件如下。我们需要注意每项的范围(range值)，确保我们传递的值都在config.json定义的range中；还需要注意其中 required 属性为 true 的项，这些是我们必须向后端传递的值

{
    "type": "array",
    "properties": [
        {
            "key": "cluster",
            "description": "Tomcat cluster with Session Replication",
            "type": "array",
            "properties": [
                {
                    "key": "name",
                    "label": "Name",
                    "description": "The name of the Tomcat cluster service",
                    "type": "string",
                    "default": "Tomcat Cluster",
                    "required": "no"
                },
                {
                    "key": "description",
                    "label": "Description",
                    "description": "The description of the Tomcat cluster service",
                    "type": "string",
                    "default": "",
                    "required": "no"
                },
                {
                    "key": "vxnet",
                    "label": "vxnet",
                    "description": "Choose a vxnet to join",
                    "type": "string",
                    "default": "",
                    "required": "yes"
                },
                {
                    "key": "redis_service",
                    "label": "Redis",
                    "description": "Choose a Redis to use and input database number in service properties section below, leave empty if you choose not to use it",
                    "type": "service",
                    "tag": [
                        "Redis",
                        "redis"
                    ],
                    "limits": {
                        "app-zydumbxo": [
                            "appv-q1uwklp7"
                        ]
                    },
                    "default": "",
                    "required": "no"
                },
                {
                    "key": "mysql_service",
                    "label": "MySql",
                    "description": "Choose a MySql to use and related MySql infomation in service properties section below, leave empty if you choose not to use it",
                    "type": "service",
                    "tag": [
                        "MySql",
                        "mysql"
                    ],
                    "limits": {
                        "app-00r26u27": [
                            "appv-le9cpyc6"
                        ]
                    },
                    "default": "",
                    "required": "no"
                },
                {
                    "key": "tomcat_nodes",
                    "label": "Tomcat Nodes",
                    "description": "Tomcat node properties",
                    "type": "array",
                    "properties": [
                        {
                            "key": "loadbalancer",
                            "label": "loadbalancer",
                            "description": "Choose a loadbalancer service (When you create loadbalancer, you need to select the Internet type. Loadbalancer listener need to enable Session Sticky. Listener protocol should be http)",
                            "type": "loadbalancer",
                            "port": 8080,
                            "default": [],
                            "required": "yes"
                        },
                        {
                            "key": "cpu",
                            "label": "CPU",
                            "description": "CPUs of each node",
                            "type": "integer",
                            "default": 1,
                            "range": [
                                1,
                                2,
                                4,
                                8
                            ],
                            "required": "yes"
                        },
                        {
                            "key": "memory",
                            "label": "Memory",
                            "description": "memory of each node",
                            "type": "integer",
                            "default": 2048,
                            "range": [
                                2048,
                                4096,
                                8192
                            ],
                            "required": "yes"
                        },
                        {
                            "key": "instance_class",
                            "label": "Instance Class",
                            "description": "The instance type for the cluster to run, such as high performance, high performance plus",
                            "type": "integer",
                            "default": 0,
                            "range": [
                                0,
                                1
                            ],
                            "required": "yes"
                        },
                        {
                            "key": "count",
                            "label": "Node Count",
                            "description": "Number of nodes for the cluster to create",
                            "type": "integer",
                            "default": 2,
                            "range": [
                                1,
                                2,
                                3,
                                4,
                                5,
                                6,
                                7,
                                8,
                                9
                            ],
                            "required": "yes"
                        },
                        {
                            "key": "volume_size",
                            "label": "Volume Size",
                            "description": "The volume size for each node",
                            "type": "integer",
                            "default": 10,
                            "required": "no"
                        }
                    ]
                },
                {
                    "key": "log_node",
                    "label": "Log Server Node",
                    "description": "Log server to collect all log files from all Tomcat nodes",
                    "type": "array",
                    "properties": [
                        {
                            "key": "cpu",
                            "label": "CPU",
                            "description": "CPUs of each node",
                            "type": "integer",
                            "default": 1,
                            "range": [
                                1,
                                2,
                                4,
                                8
                            ],
                            "required": "yes"
                        },
                        {
                            "key": "memory",
                            "label": "Memory",
                            "description": "memory of each node",
                            "type": "integer",
                            "default": 2048,
                            "range": [
                                2048,
                                4096,
                                8192
                            ],
                            "required": "yes"
                        },
                        {
                            "key": "instance_class",
                            "label": "Instance Class",
                            "description": "The instance type for the cluster to run, such as high performance, high performance plus",
                            "type": "integer",
                            "default": 0,
                            "range": [
                                0,
                                1
                            ],
                            "required": "yes"
                        },
                        {
                            "key": "volume_size",
                            "label": "Volume Size",
                            "description": "The volume size for this log server",
                            "type": "integer",
                            "default": 10,
                            "required": "no"
                        }
                    ]
                }
            ]
        },
        {
            "key": "env",
            "description": "Tomcat cluster service properties",
            "type": "array",
            "properties": [
                {
                    "key": "tomcat_user",
                    "label": "User name to access Tomcat manager GUI",
                    "description": "User name to access Tomcat manager GUI, avoid to set it as 'tomcat' because it's already predefined with role 'manager_script'",
                    "type": "string",
                    "default": "qingAdmin",
                    "pattern": "^(?!.*?[tT][oO][mM][cC][aA][tT]).*$",
                    "required": "yes"
                },
                {
                    "key": "tomcat_pwd",
                    "label": "Password to access Tomcat manager",
                    "description": "Password to access Tomcat manager GUI and the user 'tomcat' with role 'manager_script', the default password is 'qing0pwd'",
                    "type": "password",
                    "changeable": true,
                    "default": "qing0pwd",
                    "required": "yes"
                },
                {
                    "key": "tomcat_encoding",
                    "label": "Tomcat character encoding",
                    "description": "Tomcat character encoding, this value will be set in javax.servlet.request.encoding and file.encoding when launching Tomcat, also set in URIEncoding in server.xml",
                    "type": "string",
                    "default": "UTF-8",
                    "required": "yes"
                },
                {
                    "key": "tomcat_log_level",
                    "label": "Tomcat logging level",
                    "description": "The logging level of log4j within Tomcat scope, settting 'INFO' as default value",
                    "type": "string",
                    "default": "INFO",
                    "range": [
                        "OFF",
                        "FATAL",
                        "ERROR",
                        "WARN",
                        "INFO",
                        "DEBUG",
                        "ALL"
                    ],
                    "required": "yes"
                },
                {
                    "key": "tomcat_log_packages",
                    "label": "Tomcat logging packages",
                    "description": "Packages to include in the logging, separated by comma. Tomcat defines loggers by Engine and Host names. For example: log4j.logger.org.apache.catalina.core.ContainerBase.[Catalina].[localhost],log4j.logger.org.apache.catalina.session",
                    "type": "string",
                    "default": "",
                    "required": "no"
                },
                {
                    "key": "threadpool_maxThreads",
                    "label": "The max number of active threads",
                    "description": "The max number of active threads in Tomcat shared thread pool",
                    "type": "string",
                    "default": "200",
                    "required": "yes"
                },
                {
                    "key": "threadpool_minSpareThreads",
                    "label": "The minimum number of kept alive threads",
                    "description": "The minimum number of threads always kept alive in Tomcat shared thread pool",
                    "type": "string",
                    "default": "25",
                    "required": "yes"
                },
                {
                    "key": "threadpool_maxIdleTime",
                    "label": "The number of milliseconds before an idle thread shutsdown",
                    "description": "The number of milliseconds before an idle thread shutsdown, unless the number of active threads are less or equal to minSpareThreads",
                    "type": "string",
                    "default": "60000",
                    "required": "yes"
                },
                {
                    "key": "java_opts",
                    "label": "Java runtime properties",
                    "description": "Java runtime properties when running Tomcat, leave empty if you accept our default JVM heap size setting(1/4 memory as xms, and 1/2 memory as xmx). Note: our default setting will not take effect if you input any value in this area, the validaton of JAVA_OPTS should be handled by you ahead of time, otherwise Tomcat server may fail to start",
                    "type": "string",
                    "default": "",
                    "required": "no"
                },
                {
                    "key": "war_source",
                    "label": "How to get WAR file",
                    "description": "Choose a way to upload WAR to Tomcat server, the default way is using Tomcat manager UI or command, the other option is QingStor. Note: Tomcat manager could only deploy WAR to single node, we monitor that deployment and copy the deployed WAR file to watched folder of Tomcat FarmWarDeployer, which will distribute this file to other nodes",
                    "type": "string",
                    "changeable": true,
                    "default": "tomcat_manager",
                    "range": [
                        "tomcat_manager",
                        "qingstor"
                    ],
                    "required": "yes"
                },
                {
                    "key": "redis_db_num",
                    "label": "Redis database number",
                    "description": "Redis Database Number, leave empty if you choose not to use Redis database",
                    "type": "string",
                    "default": "0",
                    "required": "no"
                },
                {
                    "key": "access_key_id",
                    "label": "access_key_id",
                    "description": "access_key_id to access QingStor service for web application(WAR) deployment, leave empty if you chooose to use Tomcat Manager",
                    "type": "string",
                    "changeable": true,
                    "default": "",
                    "required": "no"
                },
                {
                    "key": "secret_access_key",
                    "label": "secret_access_key",
                    "description": "secret_access_key to access QingStor service for web application(WAR) deployment, leave empty if you chooose to use Tomcat Manager",
                    "type": "password",
                    "changeable": true,
                    "default": "",
                    "required": "no"
                },
                {
                    "key": "zone",
                    "label": "zone",
                    "description": "Zone of bucket for web application(WAR) deployment, leave empty if you chooose to use Tomcat Manager",
                    "type": "string",
                    "changeable": true,
                    "default": "pek3a",
                    "range": [
                        "pek3a",
                        "sh1a"
                    ],
                    "required": "no"
                },
                {
                    "key": "bucket",
                    "label": "bucket",
                    "description": "Bucket name for web application(WAR) deployment, leave empty if you chooose to use Tomcat Manager",
                    "type": "string",
                    "changeable": true,
                    "default": "",
                    "required": "no"
                },
                {
                    "key": "war_name",
                    "label": "war name",
                    "description": "The web application(WAR) file Name, leave empty if you chooose to use Tomcat Manager",
                    "type": "string",
                    "default": "",
                    "required": "no"
                },
                {
                    "key": "mysql_db_name",
                    "label": "MySql database name",
                    "description": "MySql Database Name, leave empty if you choose not to use MySql database",
                    "type": "string",
                    "default": "mysql",
                    "required": "no"
                },
                {
                    "key": "jdbc_dsname",
                    "label": "Datasoure name of Tomcat JDBC connection pool",
                    "description": "Datasoure name of Tomcat JDBC connection pool to connect MySql database",
                    "type": "string",
                    "default": "TestDB",
                    "required": "no"
                },
                {
                    "key": "jdbc_maxActive",
                    "label": "The maximum number of active database connections",
                    "description": "The maximum number of active database connections that can be allocated from this pool at the same time",
                    "type": "string",
                    "default": "100",
                    "required": "no"
                },
                {
                    "key": "jdbc_maxIdle",
                    "label": "The maximum number of kept database connections",
                    "description": "The maximum number of database connections that should be kept in the pool at all times",
                    "type": "string",
                    "default": "30",
                    "required": "no"
                },
                {
                    "key": "jdbc_maxWait",
                    "label": "The maximum number of milliseconds before a database connection timeout",
                    "description": "The maximum number of milliseconds that the pool will wait (when there are no available connections) for a database connection to be returned before throwing an exception",
                    "type": "string",
                    "default": "30000",
                    "required": "no"
                }
            ]
        }
    ]
}

所以，我们需要提供的conf的格式为

{
    "cluster": {
        "name": "Tomcat_Cluster",
        "description": "",
        "tomcat_nodes": {
            "loadbalancer": [
                {
                    "listener": "lbl-wdplf9gh",
                    "port": 8080,
                    "policy": ""
                }
            ],
            "cpu": 1,
            "memory": 2048,
            "instance_class": 0,
            "count": 2,
            "volume_size": 10
        },
        "log_node": {
            "cpu": 1,
            "memory": 2048,
            "instance_class": 0,
            "volume_size": 10
        },
        "vxnet": "vxnet-iuy3lnd",
        "global_uuid": "93242219542648944"
    },
    "version": "appv-gva21mw0",
    "env": {
        "tomcat_user": "qingAdmin",
        "tomcat_pwd": "qing0pwd",
        "tomcat_encoding": "UTF-8",
        "tomcat_log_level": "INFO",
        "threadpool_maxThreads": "200",
        "threadpool_minSpareThreads": "25",
        "threadpool_maxIdleTime": "60000",
        "war_source": "tomcat_manager",
        "tomcat_log_packages": "",
        "java_opts": "",
        "redis_db_num": "0",
        "access_key_id": "",
        "zone": "pek3a",
        "bucket": "",
        "war_name": "",
        "mysql_db_name": "mysql",
        "jdbc_dsname": "TestDB",
        "jdbc_maxActive": "100",
        "jdbc_maxIdle": "30",
        "jdbc_maxWait": "30000"
    }
}

需要注意环境变量env内，accesskey类型的数据，在conf中需要将值转换为key为access_key_id的字典。例如env内有如下内容：

{
  "key": "access_key",
  "label": "access_key_id",
  "description": "access key ID",
  "type": "accesskey",
  "required": "yes"
}

则conf的env内，该数据的格式应该如下：

{
  "access_key":{
    "access_key_id":""
  }
}

在发送API请求前，我们需要将conf 去除空格换行后进行 urlencode，否则空白字符会后端设别的参数值会不完整，最终请求如下

Example Request:

https://api.qingcloud.com/iaas/?
action=DeployAppVersion
conf=%7B%22cluster%22%3A%7B%22name%22%3A%22Tomcat_Cluster%22%2C%22description%22%3A%22%22%2C%22tomcat_nodes%22%3A%7B%22loadbalancer%22%3A%5B%7B%22listener%22%3A%22lbl-wdplf9gh%22%2C%22port%22%3A8080%2C%22policy%22%3A%22%22%7D%5D%2C%22cpu%22%3A1%2C%22memory%22%3A2048%2C%22instance_class%22%3A0%2C%22count%22%3A2%2C%22volume_size%22%3A10%7D%2C%22log_node%22%3A%7B%22cpu%22%3A1%2C%22memory%22%3A2048%2C%22instance_class%22%3A0%2C%22volume_size%22%3A10%7D%2C%22vxnet%22%3A%22vxnet-iuy3lnd%22%2C%22global_uuid%22%3A%2293242219542648944%22%7D%2C%22version%22%3A%22appv-gva21mw0%22%2C%22env%22%3A%7B%22tomcat_user%22%3A%22qingAdmin%22%2C%22tomcat_pwd%22%3A%22qing0pwd%22%2C%22tomcat_encoding%22%3A%22UTF-8%22%2C%22tomcat_log_level%22%3A%22INFO%22%2C%22threadpool_maxThreads%22%3A%22200%22%2C%22threadpool_minSpareThreads%22%3A%2225%22%2C%22threadpool_maxIdleTime%22%3A%2260000%22%2C%22war_source%22%3A%22tomcat_manager%22%2C%22tomcat_log_packages%22%3A%22%22%2C%22java_opts%22%3A%22%22%2C%22redis_db_num%22%3A%220%22%2C%22access_key_id%22%3A%22%22%2C%22zone%22%3A%22pek3a%22%2C%22bucket%22%3A%22%22%2C%22war_name%22%3A%22%22%2C%22mysql_db_name%22%3A%22mysql%22%2C%22jdbc_dsname%22%3A%22TestDB%22%2C%22jdbc_maxActive%22%3A%22100%22%2C%22jdbc_maxIdle%22%3A%2230%22%2C%22jdbc_maxWait%22%3A%2230000%22%7D%7D
&version_id=appv-gva21mw0
&zone=pek3a
&COMMOM_PARAMS

Example Response:

{
  "vxnet_id":"vxnet-iuy3lnd",
  "ret_code":0,
  "node_ids":[
    "cln-n9ujbr2z",
    "cln-pgnwwgos",
    "cln-w2h3rs7y"
  ],
  "app_id":"app-jwq1fzqo",
  "cluster_name":"Tomcat_Cluster",
  "cluster_id":"cl-bgb7my01",
  "action":"CreateClusterResponse",
  "node_count":3,
  "app_version":"appv-gva21mw0",
  "job_id":"j-q7hez3rqxke"
}

Development_docs: DescribeApps

Mon, 01 Jan 0001 00:00:00 +0000

接口描述

获取一个或多个应用的信息。

您可以根据应用 ID，名称，标签等作为过滤条件，来获取应用信息。

请求参数

参数名	类型	描述	是否必填
app	String	应用 ID	否
app_name	String	应用名称	否
category	String	类别，如：database、 bigdata、 container、 shield	否
tags	Array	标签数组	否
app_type	String	应用类型，如：web、 image、 cluster、 license、 sass，默认 web	否
verbose	Integer	是否返回冗长的信息，若为 1，则返回应用相关其他信息字段，默认为 0	否
search_word	String	关键字（匹配应用名称，描述，摘要）	否
offset	Integer	数据偏移量，默认 0	否
limit	Integer	返回数据长度，默认 20，最大 100	否
sort_key	String	结果排序的列	否
reverse	Integer	是否逆序，1 为逆序，0 为正序	否

公共参数

返回数据

公共参数：

名称	类型	描述
action	String	响应动作
total_count	Integer	应用总数量
app_set	Array	应用集合
ret_code	Integer	执行成功与否，0 表示成功，其他值则为错误代码

APP 信息：

名称	类型	描述
app_name	String	应用名称
cover_img	String	封面图片地址
app_id	String	应用 ID
edition	Object	系列信息
create_time	String	创建时间
screenshots	Array	截图地址列表
category	String	类别
app_type	String	应用类型
status_time	String	状态时间
status	String	应用状态
abstraction	String	应用摘要
description	String	应用描述
tags	Array	标签列表
visibility	String	可见范围（公开、私有）
icon	String	图表地址
contact	String	开发者联系方式
company_url	String	开发者公司主页

示例

请求示例：

https://api.qingcloud.com/iaas/?action=DescribeApps
&app=app-00r26u27
&limit=20
&app_type=cluster

返回示例：

{
  "action":"DescribeAppsResponse",
  "total_count":1,
  "app_set":[
    {
      "company_url":"//m.websorachi.com/",
      "app_id":"app-00r26u27",
      "edition":[
        {
          "edition_id":"default",
          "name":"default",
          "description":"default"
        }
      ],
      "create_time":"2017-04-20T13:55:32Z",
      "screenshots":[
        "ca-35yq08gp",
        "ca-xl65n015",
        "ca-he8rh81t",
        "ca-mp0e587w",
        "ca-qifdpo2y",
        "ca-hq6ycrk9"
      ],
      "app_name":"QingCloud MySQL Plus",
      "category":"database",
      "app_type":"cluster",
      "screenshot_links":[
        "https://pek3a.qingstor.com/attachment-4-appcenter/public/ca-35yq08gp",
        "https://pek3a.qingstor.com/attachment-4-appcenter/public/ca-xl65n015",
        "https://pek3a.qingstor.com/attachment-4-appcenter/public/ca-he8rh81t",
        "https://pek3a.qingstor.com/attachment-4-appcenter/public/ca-mp0e587w",
        "https://pek3a.qingstor.com/attachment-4-appcenter/public/ca-qifdpo2y",
        "https://pek3a.qingstor.com/attachment-4-appcenter/public/ca-hq6ycrk9"
      ],
      "status_time":"2021-12-21T16:04:39Z",
      "status":"active",
      "abstraction":"\u91d1\u878d\u7ea7\u5f3a\u4e00\u81f4\u6027\u3001\u4e3b\u4ece\u79d2\u7ea7\u5207\u6362\u3001\u53cc\u5f15\u64ce\u652f\u6301\u7684 MySQL \u96c6\u7fa4",
      "description":"- QingCloud MySQL Plus \u662f\u91d1\u878d\u7ea7\u9ad8\u53ef\u9760\u7684 MySQL \u96c6\u7fa4\uff1b\n- \u63d0\u4f9b\u4e86 InnoDB \u548c TokuDB \u4e24\u5927\u4e8b\u52a1\u5f15\u64ce\uff1b\n- \u4e3b\u4ece\u5f00\u542f Semi-sync\uff0c\u4e25\u683c\u4fdd\u8bc1\u8282\u70b9\u95f4\u7684\u6570\u636e\u4e00\u81f4\u6027\uff1b\n- \u4f7f\u7528 Raft \u534f\u8bae\u7ba1\u7406\u96c6\u7fa4\u4e3b\u4ece\u8282\u70b9\uff0c\u6545\u969c\u65f6\u53ef\u5b9e\u73b0\u79d2\u7ea7\u4e3b\u4ece\u5207\u6362\uff0c\u4fdd\u969c\u4e1a\u52a1\u8fde\u7eed\u6027\uff1b\n- \u96c6\u7fa4\u4e3a\u4e00\u4e3b\u591a\u4ece\u67b6\u6784\uff0c\u9ed8\u8ba4\u4e24\u4e2a\u4ece\u8282\u70b9\uff0c\u6700\u5927\u652f\u6301\u516d\u4e2a\u4ece\u8282\u70b9\u3002",
      "tags":[],
      "icon":"ca-j0r9swvj",
      "contact":"",
      "cover_img":"",
      "icon_link":"https://pek3a.qingstor.com/attachment-4-appcenter/public/ca-j0r9swvj"
    }
  ],
  "ret_code":0
}

Development_docs: DescribeAppVersionAttachments

Mon, 01 Jan 0001 00:00:00 +0000

获取应用版本的配置文件。

Request Parameters

Parameter name	Type	Description	Required
content_keys.n	String	应用配置文件的名称，即 `config.json, cluster.json.mustache, locale/en.json, locale/zh-cn.json`，默认值为`config.json`	No
attachment_ids.n	String	应用的配置文件ID，可以根据 DescribeAppVersions 获得	Yes
version_id	String	应用版本的ID	Yes

Response Elements

Name	Type	Description
action	String	响应动作
total_count	Integer	应用版本附件的总数量
attachment_set	Array	附件的详细信息，具体信息见下列 Reponse Item
ret_code	Integer	执行成功与否，0 表示成功，其他值则为错误代码

Response Item

Name	Type	Description
category	String	状态，active，suspended
attachment_id	String	应用版本描述
resource_id	String	应用版本的ID
attachment_content	String	附件的具体信息，即开发者上传的应用配置文件
resource_type	String	资源类型

Example

下列返回结果为应用ZooKeeper

Example Request:

https://api.qingcloud.com/iaas/?action=DescribeAppVersionAttachments
&attachment_ids.1=ca-nx8rerlv
&content_keys.1=config.json
&content_keys.2=cluster.json.mustache
&content_keys.3=locale%2Fzh-cn.json
&content_keys.4=locale%2Fen.json
&version_id=appv-70gegwmp
&zone=pek3b
&COMMON_PARAMS

Example Response:

{
  "action":"DescribeAppVersionAttachmentsResponse",
  "total_count":1,
  "attachment_set":[
    {
      "category":"resource_kit",
      "attachment_id":"ca-nx8rerlv",
      "sub_category":"",
      "resource_id":"appv-70gegwmp",
      "filename":"zk-3.4.9.tar.gz",
      "filesize":2390,
      "owner":"usr-XqlPq3qV",
      "attachment_type":"archive",
      "resource_type":"app_version",
      "attachment_content":{
        "locale/en.json":"{\n    \"Name\": \"Name\",\n    \"Description\": \"Description\",\n    \"The name of the ZooKeeper service\": \"The name of the ZooKeeper service\",\n    \"The description of the ZooKeeper service\": \"The description of the ZooKeeper service\",\n    \"VxNet\": \"VxNet\",\n    \"Choose a vxnet to join\": \"Choose a vxnet to join\",\n    \"CPU\": \"CPU\",\n    \"CPUs of each node\": \"CPUs of each node\",\n    \"Memory\": \"Memory\",\n    \"Memory of each node (in MiB)\": \"Memory of each node (in MiB)\",\n\t\"Volume Size\": \"Volume Size\",\n\t\"Instance Class\": \"Instance Class\",\n    \"The volume size for each node\": \"The volume size for each node\",\n\t\"ZooKeeper Node\": \"ZooKeeper Node\",\n\t\"Node Count\": \"Node Count\",\n    \"count\": \"count\",\n\t\"znode_count\": \"count\",\n    \"Number of nodes for the cluster to create\": \"Number of nodes for the cluster to create\",\n    \"instance class\": \"instance class\",\n    \"The instance type for the cluster to run, such as high performance, high performance plus\": \"The instance type for the cluster to run, such as high performance, high performance plus\",\n    \"zk_node\": \"zk_node\",\n    \"latency\": \"latency\",\n\t\"throughput\": \"throughput\",\n    \"connections\": \"connections\",\n    \"znode\": \"znode\",\n    \"mode\": \"mode (L:Leader,F:Flower,S:Standalone)\",\n\t\"min\": \"min\",\n\t\"avg\": \"avg\",\n\t\"max\": \"max\",\n\t\"received\": \"received\",\n\t\"sent\": \"sent\",\n\t\"active\": \"active\",\n\t\"outstanding\": \"outstanding\"\n}\n\n",
        "cluster.json.mustache":"{\n    \"name\": {{cluster.name}},\n    \"description\": {{cluster.description}},\n    \"vxnet\": {{cluster.vxnet}},\n    \"nodes\": [{\n        \"container\": {\n            \"type\": \"kvm\",\n            \"zone\": \"pek3a\",\n            \"image\": \"img-svm7yple\"\n        },\n        \"count\": {{cluster.zk_node.count}},\n        \"cpu\": {{cluster.zk_node.cpu}},\n        \"memory\": {{cluster.zk_node.memory}},\n\t\t\"instance_class\": {{cluster.zk_node.instance_class}},\n        \"volume\": {\n            \"size\": {{cluster.zk_node.volume_size}}\n        },\n        \"server_id_upper_bound\": 255,\n        \"services\": {\n            \"start\": {\n                \"cmd\": \"/opt/zookeeper/bin/zkServer.sh start;/opt/zookeeper/bin/rest.sh start\"\n            },\n            \"stop\": {\n                \"cmd\": \"/opt/zookeeper/bin/rest.sh stop;/opt/zookeeper/bin/zkServer.sh stop\"\n            }\n        },\n\t\t\"advanced_actions\": [\"change_vxnet\", \"scale_horizontal\"],\n\t\t\"vertical_scaling_policy\": \"sequential\"\n    }],\n\t\"endpoints\": {\n\t\t\"client\": {\n\t\t\t\"port\":\t2181,\n\t\t\t\"protocol\":\t\"tcp\"\n\t\t},\n\t\t\"rest\": {\n\t\t\t\"port\":\t9998,\n\t\t\t\"protocol\":\t\"tcp\"\n\t\t}\n\t},\n\t\"health_check\":\t{\n\t\t\"enable\": true,\n\t\t\"interval_sec\": 60,\n\t\t\"timeout_sec\": 10,\n\t\t\"action_timeout_sec\": 30,\n\t\t\"healthy_threshold\": 2,\n\t\t\"unhealthy_threshold\": 2,\n\t\t\"check_cmd\": \"echo srvr | nc 127.0.0.1 2181\",\n\t\t\"action_cmd\": \"/opt/zookeeper/bin/restart-server.sh\"\n\t},\n\t\"monitor\": {\n        \"enable\": true,\n        \"cmd\": \"/opt/zookeeper/bin/get-monitor.sh\",\n        \"items\": {\n            \"mode\": {\n                \"unit\": \"\",\n                \"value_type\": \"str\",\n                \"statistics_type\": \"latest\",\n                \"enums\": [\"L\", \"F\", \"S\"]\n            },\n\t\t\t\"min\": {\n                \"unit\": \"ms\",\n                \"value_type\": \"int\",\n                \"statistics_type\": \"min\",\n\t\t\t\t\"scale_factor_when_display\": 1\n            },\n\t\t\t\"avg\": {\n                \"unit\": \"ms\",\n                \"value_type\": \"int\",\n                \"statistics_type\": \"avg\",\n\t\t\t\t\"scale_factor_when_display\": 1\n            },\n\t\t\t\"max\": {\n                \"unit\": \"ms\",\n                \"value_type\": \"int\",\n                \"statistics_type\": \"max\",\n\t\t\t\t\"scale_factor_when_display\": 1\n            },\n\t\t\t\"received\": {\n                \"unit\": \"count\",\n                \"value_type\": \"int\",\n                \"statistics_type\": \"latest\",\n\t\t\t\t\"scale_factor_when_display\": 1\n            },\n\t\t\t\"sent\": {\n                \"unit\": \"count\",\n                \"value_type\": \"int\",\n                \"statistics_type\": \"latest\",\n\t\t\t\t\"scale_factor_when_display\": 1\n            },\n\t\t\t\"active\": {\n                \"unit\": \"count\",\n                \"value_type\": \"int\",\n                \"statistics_type\": \"latest\",\n\t\t\t\t\"scale_factor_when_display\": 1\n            },\n\t\t\t\"outstanding\": {\n                \"unit\": \"count\",\n                \"value_type\": \"int\",\n                \"statistics_type\": \"latest\",\n\t\t\t\t\"scale_factor_when_display\": 1\n            },\n\t\t\t\"znode\": {\n                \"unit\": \"znode_count\",\n                \"value_type\": \"int\",\n                \"statistics_type\": \"latest\",\n\t\t\t\t\"scale_factor_when_display\": 1\n            }\n        },\n\t\t\"groups\": {\n\t\t\t\"latency\":\t[\"min\", \"avg\", \"max\"],\n\t\t\t\"throughput\": [\"received\", \"sent\"],\n            \"connections\": [\"active\", \"outstanding\"]\n\t\t},\n        \"display\": [\"mode\", \"latency\", \"throughput\", \"connections\", \"znode\"],\n        \"alarm\": [\"avg\"]\n    }\n}\n",
        "locale/zh-cn.json":"{\n    \"Name\": \"\u540d\u79f0\",\n    \"Description\": \"\u63cf\u8ff0\",\n    \"The name of the ZooKeeper service\": \"ZooKeeper \u670d\u52a1\u540d\u79f0\",\n    \"The description of the ZooKeeper service\": \"ZooKeeper \u670d\u52a1\u63cf\u8ff0\",\n    \"VxNet\": \"\u79c1\u6709\u7f51\u7edc\",\n    \"Choose a vxnet to join\": \"\u9009\u62e9\u8981\u52a0\u5165\u7684\u79c1\u6709\u7f51\u7edc\",\n    \"CPU\": \"CPU\",\n    \"CPUs of each node\": \"\u6bcf\u4e2a\u8282\u70b9\u7684 CPU \u6570\u91cf\",\n    \"Memory\": \"\u5185\u5b58\",\n    \"Memory of each node (in MiB)\": \"\u6bcf\u4e2a\u8282\u70b9\u7684\u5185\u5b58\u6570\u91cf\uff08\u5355\u4f4d\uff1aMiB\uff09\",\n\t\"Instance Class\": \"\u4e3b\u673a\u7c7b\u578b\",\n\t\"ZooKeeper Node\": \"ZooKeeper \u8282\u70b9\",\n\t\"Node Count\": \"\u8282\u70b9\u6570\u91cf\",\n    \"count\": \"\u6b21\",\n\t\"znode_count\": \"\u4e2a\",\n    \"Number of nodes for the cluster to create\": \"\u8981\u521b\u5efa\u7684\u8282\u70b9\u6570\u91cf\",\n\t\"Volume Size\": \"\u5b58\u50a8\u5bb9\u91cf\",\n    \"The volume size for each node\": \"\u6bcf\u4e2a\u8282\u70b9\u7684\u5b58\u50a8\u5bb9\u91cf\",\n    \"instance class\": \"\u5b9e\u4f8b\u7c7b\u578b\",\n    \"The instance type for the cluster to run, such as high performance, high performance plus\": \"\u8282\u70b9\u5b9e\u4f8b\u7c7b\u578b\uff0c\u6bd4\u5982\u6027\u80fd\u578b\u4e0e\u8d85\u9ad8\u6027\u80fd\u578b\u3002\",\n    \"zk_node\": \"ZooKeeper \u8282\u70b9\",\n\t\"latency\": \"\u54cd\u5e94\u5ef6\u8fdf\u65f6\u95f4\",\n\t\"throughput\": \"\u541e\u5410\u91cf\",\n    \"connections\": \"\u8fde\u63a5\u6570\",\n    \"znode\": \"\u8282\u70b9\u6570\u91cf\",\n    \"mode\": \"\u89d2\u8272 (L:Leader,F:Flower,S:Standalone)\",\n\t\"min\": \"\u6700\u5c0f\u54cd\u5e94\u5ef6\u8fdf\u65f6\u95f4\",\n\t\"avg\": \"\u5e73\u5747\u54cd\u5e94\u5ef6\u8fdf\u65f6\u95f4\",\n\t\"max\": \"\u6700\u5927\u54cd\u5e94\u5ef6\u8fdf\u65f6\u95f4\",\n\t\"received\": \"\u8bf7\u6c42\u63a5\u6536\u6570\",\n\t\"sent\": \"\u53d1\u9001\u54cd\u5e94\u6570\",\n\t\"active\": \"\u6d3b\u8dc3\u8fde\u63a5\u6570\",\n\t\"outstanding\": \"\u5f85\u5904\u7406\u8fde\u63a5\u6570\",\n    \"client\": \"\u5ba2\u6237\u7aef\"\n}\n\n",
        "config.json":"{\n    \"type\": \"array\",\n    \"properties\": [{\n        \"key\": \"cluster\",\n        \"description\": \"ZooKeeper release 3.4.9 cluster properties\",\n        \"type\": \"array\",\n        \"properties\": [{\n            \"key\": \"name\",\n            \"label\": \"Name\",\n            \"description\": \"The name of the ZooKeeper service\",\n            \"type\": \"string\",\n            \"default\": \"ZooKeeper\",\n            \"required\": \"no\"\n        }, {\n            \"key\": \"description\",\n            \"label\": \"Description\",\n            \"description\": \"The description of the ZooKeeper service\",\n            \"type\": \"string\",\n            \"default\": \"\",\n            \"required\": \"no\"\n        }, {\n            \"key\": \"vxnet\",\n            \"label\": \"VxNet\",\n            \"description\": \"Choose a vxnet to join\",\n            \"type\": \"string\",\n            \"default\": \"\",\n            \"required\": \"yes\"\n        }, {\n            \"key\": \"zk_node\",\n            \"label\": \"ZooKeeper Node\",\n            \"description\": \"role-based node properties\",\n            \"type\": \"array\",\n            \"properties\": [{\n                \"key\": \"cpu\",\n                \"label\": \"CPU\",\n                \"description\": \"CPUs of each node\",\n                \"type\": \"integer\",\n                \"default\": 1,\n                \"range\": [\n                    1,\n                    2,\n                    4,\n                    8\n                ],\n                \"required\": \"yes\"\n            }, {\n                \"key\": \"memory\",\n                \"label\": \"Memory\",\n                \"description\": \"memory of each node (in MiB)\",\n                \"type\": \"integer\",\n                \"default\": 2048,\n                \"range\": [\n                    1024,\n                    2048,\n                    4096,\n                    8192,\n                    16384,\n                    32768\n                ],\n                \"required\": \"yes\"\n            }, {\n                \"key\": \"instance_class\",\n                \"label\": \"Instance Class\",\n                \"description\": \"The instance type for the cluster to run\uff0csuch as high performance\uff0chigh performance plus\",\n                \"type\": \"integer\",\n                \"default\": 0,\n                \"range\": [0, 1],\n                \"required\": \"yes\"\n            }, {\n                \"key\": \"count\",\n                \"label\": \"Node Count\",\n                \"description\": \"Number of nodes for the cluster to create\",\n                \"type\": \"integer\",\n                \"default\": 3,\n                \"range\": [\n                    1,\n                    3,\n                    5,\n                    7,\n                    9\n                ],\n                \"required\": \"yes\"\n            }, {\n\t\t\t\t\"key\": \"volume_size\",\n\t\t\t\t\"label\": \"Volume Size\",\n\t\t\t\t\"description\": \"The volume size for each node\",\n\t\t\t\t\"type\":\t\"integer\",\n\t\t\t\t\"default\": 10,\n\t\t\t\t\"required\": \"yes\"\n\t\t\t}]\n        }]\n    }]\n}\n"
      }
    }
  ],
  "ret_code":0
}

Development_docs: DescribeAppVersions

Mon, 01 Jan 0001 00:00:00 +0000

获取一个或多个应用版本的信息

可根据应用版本ID，状态，应用ID，标签等作为过滤条件，来获取应用信息。

Request Parameters

Parameter name	Type	Description	Required
app_ids.n	String	应用ID，可以是一个或多个。app_ids和version_ids两者必须至少有一个	No
version_ids.n	String	应用版本ID，可以是一个或多个。app_ids和version_ids两者必须至少有一个	No
name	String	应用的名称	No
sort_key	String	结果排序的列	No
owner	String	按照用户账户过滤，只返回指定账户的资源	No
verbose	Integer	是否返回冗长的信息，若为1，则返回集群相关其它资源信息	No
offset	Integer	数据偏移量，默认为0	No
limit	Integer	返回数据长度，默认为20，最大100	No
reverse	Integer	是否逆序，1为逆序，0为正序	No

公共参数

Response Elements

Name	Type	Description
action	String	响应动作
total_count	Integer	应用版本的总数量
version_set	Array	应用的版本集合
ret_code	Integer	执行成功与否，0 表示成功，其他值则为错误代码

Response Item

Name	Type	Description
status	String	状态，active，suspended
description	String	应用版本描述
resource_kit	String	应用的配置文件ID
version_id	String	应用版本的ID
app_id	String	应用ID
create_time	TimeStamp	应用版本的创建时间
visibility	String	应用版本的可见范围，public即为所有人可见，private为仅自己可见
name	String	版本的名称
console_id	String	版本的console ID

Example

下列返回结果为应用ZooKeeper

Example Request:

https://api.qingcloud.com/iaas/?action=DescribeAppVersions
&app_ids.1=app-tg3lbp0a
&limit=20
&COMMON_PARAMS

Example Response:

{
  "action":"DescribeAppVersionsResponse",
  "total_count":1,
  "version_set":[
    {
      "status":"active",
      "description":"\u6b64\u7248\u672c\u63d0\u4f9b\u7684\u662f\u539f\u751f Apache ZooKeeper 3.4.9 \u53d1\u884c\u7248\uff0c\u540c\u65f6\u63d0\u4f9b ZooKeeper REST \u670d\u52a1",
      "resource_kit":"ca-nx8rerlv",
      "version_id":"appv-70gegwmp",
      "app_id":"app-tg3lbp0a",
      "create_time":"2017-04-21T02:34:24Z",
      "visibility":"public",
      "status_time":"2017-04-21T02:34:24Z",
      "console_id":"qingcloud",
      "name":"QingCloud 1.0 - ZooKeeper 3.4.9"
    }
  ],
  "ret_code":0
}

Development_docs: DescribeClusterDisplayTabs

Mon, 01 Jan 0001 00:00:00 +0000

获取集群display tabs的信息，前提需要集群所属的应用配置了Display tabs，可以通过查看应用是否配置display tabs

Request Parameters

Parameter name	Type	Description	Required
cluster	String	集群ID	Yes
display_tabs	String	display tabs的名称	Yes

公共参数

Response Elements

Name	Type	Description
action	String	响应动作
display_tabs	Dict	JSON格式的 display tabs 返回，`label`和`data`表示返回的标题和结果
job_id	String	执行任务的 Job ID
ret_code	Integer	执行成功与否，0 表示成功，其他值则为错误代码

Example

以应用 Redis Cluster 为例，获取名称为 roles 的display tabs信息

Example Request:

https://api.qingcloud.com/iaas/?
action=DescribeClusterDisplayTabs
&cluster=cl-2gi2b3oc
&display_tabs=roles
&zone=pek3b
&COMMON_PARAMS

Example Response:

{
  "action":"DescribeClusterDisplayTabsResponse",
  "display_tabs":{
    "labels":[
      "ip",
      "role"
    ],
    "data":[
      [
        "192.168.0.13",
        "Master"
      ],
      [
        "192.168.0.14",
        "Master"
      ],
      [
        "192.168.0.9",
        "Master"
      ],
      [
        "192.168.0.10",
        "Slave"
      ],
      [
        "192.168.0.11",
        "Slave"
      ],
      [
        "192.168.0.12",
        "Slave"
      ]
    ]
  },
  "ret_code":0
}

Development_docs: DescribeClusterEnvironment

Mon, 01 Jan 0001 00:00:00 +0000

获取集群某类角色节点的环境变量

Request Parameters

Parameter name	Type	Description	Required
cluster	String	集群ID	Yes
role	String	将要获取环境变量的角色，可留空	No

公共参数

Response Elements

Name	Type	Description
action	String	响应动作
config	Dict	JSON格式的集群环境变量信息，包含了环境变量的描述，类型，范围，其中 `default` 值为集群生效的环境变量值
job_id	String	执行任务的 Job ID，格式为`{"cln-ssdfawx":"j-kdlsafda"}`
ret_code	Integer	执行成功与否，0 表示成功，其他值则为错误代码

Example

以应用Redis Cluster为例，获取应用部署集群的环境变量

Example Request:

https://api.qingcloud.com/iaas/?
&action=DescribeClusterEnvironment
&cluster_id=cl-2gi2b3oc
&zone=pek3b
&COMMON_PARAMS

Example Response:

{
  "action":"DescribeClusterEnvironmentResponse",
  "config":{
    "type":"array",
    "description":"Redis service properties",
    "key":"env",
    "properties":[
      {
        "description":"Max memory percent Redis can make use of.",
        "min":0,
        "default":60,
        "max":95,
        "required":"no",
        "label":"maxmemory-percent",
        "key":"maxmemory-percent",
        "type":"integer"
      },
      {
        "description":"Require clients to issue AUTH <PASSWORD> before processing any other commands.",
        "default":"*********",
        "required":"no",
        "label":"requirepass",
        "key":"requirepass",
        "type":"password"
      },
      {
        "description":"Enable config and save commands(strongly not recommended to enable this)",
        "default":0,
        "required":"no",
        "label":"enable-config",
        "range":[
          0,
          1
        ],
        "key":"enable-config",
        "type":"integer"
      },
      {
        "description":"Active rehashing uses 1 millisecond every 100 milliseconds of CPU time in order to help rehashing the main Redis hash table",
        "default":"yes",
        "required":"no",
        "label":"activerehashing",
        "range":[
          "yes",
          "no"
        ],
        "key":"activerehashing",
        "type":"string"
      },
      {
        "description":"The Append Only File is an alternative persistence mode that provides much better durability.",
        "default":"yes",
        "required":"no",
        "label":"appendonly",
        "range":[
          "yes",
          "no"
        ],
        "key":"appendonly",
        "type":"string"
      },
      {
        "description":"It tells the Operating System to actually write data on disk instead of waiting for more data in the output buffer.",
        "default":"everysec",
        "required":"no",
        "label":"appendfsync",
        "range":[
          "everysec",
          "no",
          "always"
        ],
        "key":"appendfsync",
        "type":"string"
      },
      {
        "description":"Hashes are encoded using a memory efficient data structure when they have a small number of entries",
        "default":1024,
        "required":"no",
        "label":"hash-max-ziplist-entries",
        "key":"hash-max-ziplist-entries",
        "type":"integer"
      },
      {
        "description":"Hashes are encoded using a memory efficient data structure when they have a small number of entries, and the biggest entry does not exceed a given threshold",
        "default":64,
        "required":"no",
        "label":"hash-max-ziplist-value",
        "key":"hash-max-ziplist-value",
        "type":"integer"
      },
      {
        "description":"It samples different operations at runtime in order to collect data related to possible sources of latency of a Redis instance.",
        "default":0,
        "required":"no",
        "label":"latency-monitor-threshold",
        "key":"latency-monitor-threshold",
        "type":"integer"
      },
      {
        "description":"Small lists are encoded in a special way in order to save a lot of space.",
        "default":512,
        "required":"no",
        "label":"list-max-ziplist-entries",
        "key":"list-max-ziplist-entries",
        "type":"integer"
      },
      {
        "description":"Small lists are encoded in a special way in order to save a lot of space.",
        "default":64,
        "required":"no",
        "label":"list-max-ziplist-value",
        "key":"list-max-ziplist-value",
        "type":"integer"
      },
      {
        "description":"Set the max number of connected clients at the same time.",
        "default":65000,
        "required":"no",
        "label":"maxclients",
        "key":"maxclients",
        "type":"integer"
      },
      {
        "description":"The eviction policy to remove keys when the memory limit is reached.",
        "default":"volatile-lru",
        "required":"no",
        "label":"maxmemory-policy",
        "range":[
          "volatile-lru",
          "allkeys-lru",
          "volatile-random",
          "allkeys-random",
          "volatile-ttl",
          "noeviction"
        ],
        "key":"maxmemory-policy",
        "type":"string"
      },
      {
        "description":"LRU and minimal TTL algorithms are not precise algorithms but approximated algorithms (in order to save memory), using this to tune it for speed or accuracy.",
        "default":3,
        "required":"no",
        "label":"maxmemory-samples",
        "key":"maxmemory-samples",
        "type":"integer"
      },
      {
        "description":"A master stops accepting writes if there are less than N slaves connected, having a lag less or equal than M seconds.",
        "default":10,
        "required":"no",
        "label":"min-slaves-max-lag",
        "key":"min-slaves-max-lag",
        "type":"integer"
      },
      {
        "description":"A master stops accepting writes if there are less than N slaves connected, having a lag less or equal than M seconds.",
        "default":0,
        "required":"no",
        "label":"min-slaves-to-write",
        "key":"min-slaves-to-write",
        "type":"integer"
      },
      {
        "description":"It prevents fsync() from being called in the main process while a BGSAVE or BGREWRITEAOF is in progress.",
        "default":"yes",
        "required":"no",
        "label":"no-appendfsync-on-rewrite",
        "range":[
          "yes",
          "no"
        ],
        "key":"no-appendfsync-on-rewrite",
        "type":"string"
      },
      {
        "description":"It selects the events that Redis will notify among a set of classes.",
        "default":"",
        "required":"no",
        "label":"notify-keyspace-events",
        "key":"notify-keyspace-events",
        "type":"string"
      },
      {
        "description":"Set the replication backlog size.",
        "default":1048576,
        "required":"no",
        "label":"repl-backlog-size",
        "key":"repl-backlog-size",
        "type":"integer"
      },
      {
        "description":"It configures the amount of seconds that need to elapse, starting from the time the last slave disconnected, for the backlog buffer to be freed.",
        "default":3600,
        "required":"no",
        "label":"repl-backlog-ttl",
        "key":"repl-backlog-ttl",
        "type":"integer"
      },
      {
        "description":"It is the replication timeout.",
        "default":60,
        "required":"no",
        "label":"repl-timeout",
        "key":"repl-timeout",
        "type":"integer"
      },
      {
        "description":"It sets the limit in the size of the set in order to use this special memory saving encoding.",
        "default":512,
        "required":"no",
        "label":"set-max-intset-entries",
        "key":"set-max-intset-entries",
        "type":"integer"
      },
      {
        "description":"It logs queries that exceeded a specified execution time.",
        "default":-1,
        "required":"no",
        "label":"slowlog-log-slower-than",
        "key":"slowlog-log-slower-than",
        "type":"integer"
      },
      {
        "description":"It logs queries with the length of the slow log.",
        "default":128,
        "required":"no",
        "label":"slowlog-max-len",
        "key":"slowlog-max-len",
        "type":"integer"
      },
      {
        "description":"TCP keepalive between server and client.",
        "default":0,
        "required":"no",
        "label":"tcp-keepalive",
        "key":"tcp-keepalive",
        "type":"integer"
      },
      {
        "description":"Close the connection after a client is idle for N seconds (0 to disable).",
        "default":0,
        "required":"no",
        "label":"timeout",
        "key":"timeout",
        "type":"integer"
      },
      {
        "description":"Sorted sets are specially encoded in order to save a lot of space.",
        "default":128,
        "required":"no",
        "label":"zset-max-ziplist-entries",
        "key":"zset-max-ziplist-entries",
        "type":"integer"
      },
      {
        "description":"Sorted sets are specially encoded in order to save a lot of space.",
        "default":64,
        "required":"no",
        "label":"zset-max-ziplist-value",
        "key":"zset-max-ziplist-value",
        "type":"integer"
      },
      {
        "description":"Max execution time of a Lua script in milliseconds.",
        "default":5000,
        "required":"no",
        "label":"lua-time-limit",
        "key":"lua-time-limit",
        "type":"integer"
      }
    ]
  },
  "ret_code":0
}

Development_docs: DescribeClusterJobs

Mon, 01 Jan 0001 00:00:00 +0000

获取一个或多个集群操作日志

可根据应用ID，日志ID，动作，状态来获取日志列表。如果不指定任何过滤条件，默认返回你触发的所有操作日志。如果指定不存在的日志ID，或非法状态值，则会返回错误信息。

Request Parameters

Parameter name	Type	Description	Required
app	String	应用ID	Yes
jobs.n	String	操作日志ID	No
status.n	String	日志状态: pending, working, failed, successful	No
verbose	Integer	是否返回冗长的信息，目前 verbose 只支持为 0。	No
offset	Integer	数据偏移量，默认为0	No
limit	Integer	返回数据长度，默认为20，最大100	No

公共参数

Response Elements

Name	Type	Description
action	String	响应动作
job_set	Array	JSON 格式的日志数据列表，每项参数可见下面 Response Item
total_count	Integer	根据过滤条件得到的日志总数
ret_code	Integer	执行成功与否，0 表示成功，其他值则为错误代码

Response Item

Name	Type	Description
job_id	String	日志ID
create_time	TimeStamp	日志创建时间，为UTC时间，格式可参见 ISO8601.
directive	String
resource_ids	String	此操作日志所涉及的资源信息，多个资源以空格分隔
owner	String	日志提供者ID
status	String	日志状态，有效值为 pending, working, failed, successful pending：等待被执行 working：执行中 failed：执行失败 successful：执行成功
status_time	TimeStamp	日志最近一次状态变更时间，为UTC时间，格式可参见 ISO8601.
resource_ids	String	资源ID，一个或多个
resources	Dict	操作资源的ID，格式为`{"clusters":["cl-ddssvafd"]}`

Example

以应用ZooKeeper为例

Example Request:

https://api.qingcloud.com/iaas/?action=DescribeClusterJobs
&app=app-tg3lbp0a
&jobs.1=j-etkt94ebqra
&limit=1
&zone=pek3a
&COMMON_PARAMS

Example Response:

{
  "action":"DescribeClusterJobsResponse",
  "total_count":1,
  "job_set":[
    {
      "status":"successful",
      "job_id":"j-etkt94ebqra",
      "directive":"{\"sender\":{\"lang\":\"en\",\"user_id\":\"system\",\"console_id\":\"system\",\"root_user_id\":\"system\",\"role\":\"global_admin\",\"privilege\":10,\"channel\":\"internal\"},\"zone\":\"pek3a\",\"expires\":\"2018-03-04T05:38:58Z\",\"action\":\"CeaseResources\",\"clusters\":[\"cl-xi3aoihf\"],\"resource_ids\":[\"cl-xi3aoihf\"]}",
      "job_action":"CeaseResources",
      "create_time":"2018-03-04T05:37:58Z",
      "owner":"system",
      "status_time":"2018-03-04T05:38:05Z",
      "error_codes":"",
      "resource_ids":"cl-xi3aoihf",
      "resources":{
        "clusters":[
          "cl-xi3aoihf"
        ]
      },
      "extras":{}
    }
  ],
  "ret_code":0
}

Development_docs: DescribeClusterNodes

Mon, 01 Jan 0001 00:00:00 +0000

获取集群的节点信息

Request Parameters

Parameter name	Type	Description	Required
cluster	String	集群ID	Yes
cluster_nodes.n	String	集群节点ID	No
role	String	集群节点角色	No
verbose	Integer	是否返回冗长的信息，目前 verbose 只支持为 0。	No
offset	Integer	数据偏移量，默认为0	No
limit	Integer	返回数据长度，默认为20，最大100	No
reverse	Integer	是否逆序，1为逆序，0为正序	No

公共参数

Response Elements

Name	Type	Description
action	String	响应动作
total_count	Integer	节点的总数量
node_set	Array	JSON格式的节点列表
ret_code	Integer	执行成功与否，0 表示成功，其他值则为错误代码

Response Item

https://docs.qingcloud.com/appcenter/docs/specifications/specifications.html

Name	Type	Description
app_id	String	应用ID
node_id	String	节点ID
group_id	Integer	节点所在的 Group ID
cluster_id	String	集群ID
vxnet_id	String	节点所在网络ID
private_ip	String	节点的私有IP地址
role	String	节点的角色
name	String	节点名称
memory	Integer	节点的内存大小，单位MB
app_version	String	应用版本ID
status	String	节点的状态，active
storage_size	Integer	节点的存储大小，单位GB
image_id	String	节点的镜像ID
eip	String	节点绑定的公网或基础网络IP
volume_type	Integer	节点存储类型，具体参加开发者文档
instance_id	String	节点的云服务器ID
instance_type	String	节点的云服务器类型
security_group	String	节点绑定的防火墙ID
cpu	Integer	节点的CPU
health_status	String	节点的健康状态，healthy或unhealthy
env	String	JSON格式的环境变量值，具体参见开发者文档mustache
vertical_scaling_policy	String	节点纵向扩容配置，sequential表示依次扩容，parallel表示同时扩容
advanced_actions	String	节点支持的操作，change_vxnet表示切换私网，scael_horizontal表示横向扩容
agent_installed	boolen	节点是否安装开·云app官方版下载的agent
user_access	Integer	节点是否支持用户VNC登录，0表示不支持
gpu_class	Integer	节点是否支持gpu，0表示不支持，1表示支持
gpu	Integer	节点的gpu数量，0表示当前节点没有gpu
single_node_repl	String
backup_policy	String	备份策略
incremental_backup_supported	boolen	是否支持增量备份
resource_class	Integer	节点的资源类型
hypervisor	Integer	节点的虚拟化类型，当前支持kvm
health_check	String	JSON格式的健康检查配置
monitor	String	JSON格式的数据监控配置
init_service	String	JSON格式的初始化命令，具体参见开发者文档
start_service	String	JSON格式的启动命令，具体参见开发者文档
stop_service	String	JSON格式的停止命令，具体参见开发者文档
restart_service	String	JSON格式的重启命令,具体参见开发者文档
scale_in_service	String	JSON格式的删除节点命令，具体参见开发者文档
scale_out_service	String	JSON格式的增加节点命令，具体参见开发者文档
destroy_service	String	JSON格式的销毁命令，具体参见开发者文档
restore_service	String	JSON格式的停止命令，具体参见开发者文档
delete_snapshot_service	String	JSON格式的删除备份命令，具体参见开发者文档
custom_metadata_script	String	JSON格式的自定义metadata脚本，具体参见开发者文档
display_tabs	String	JSON格式的display tabs命令，具体参见开发者文档
backup_service	String	JSON格式的备份命令，具体参见开发者文档
create_time	TimeStamp	日志创建时间，为UTC时间，格式可参见 ISO8601.

Example

以应用ZooKeeper创建的集群为例

Example Request:

https://api.qingcloud.com/iaas/?action=DescribeClusterNodes
&cluster=cl-q1witcdk
&limit=20
&reverse=1
&zone=pke3b
&COMMON_PARAMS

Example Response:

{
  "action":"DescribeClusterNodesResponse",
  "total_count":3,
  "node_set":[
    {
      "passphraseless":"",
      "vertical_scaling_policy":"sequential",
      "vxnet_id":"vxnet-pmefzgi",
      "destroy_service":null,
      "custom_service":null,
      "app_id":"app-tg3lbp0a",
      "advanced_actions":"change_vxnet,scale_horizontal",
      "agent_installed":true,
      "stop_service":{
        "cmd":"/opt/zookeeper/bin/rest.sh stop;/opt/zookeeper/bin/zkServer.sh stop",
        "order":0
      },
      "user_access":0,
      "create_time":"2018-03-04T06:00:15Z",
      "cluster_id":"cl-q1witcdk",
      "private_ip":"192.168.0.3",
      "upgrade_service":null,
      "gpu_class":0,
      "restore_service":null,
      "monitor":{
        "enable":true,
        "items":{
          "received":{
            "scale_factor_when_display":1,
            "statistics_type":"latest",
            "value_type":"int",
            "unit":"count"
          },
          "avg":{
            "scale_factor_when_display":1,
            "statistics_type":"avg",
            "value_type":"int",
            "unit":"ms"
          },
          "outstanding":{
            "scale_factor_when_display":1,
            "statistics_type":"latest",
            "value_type":"int",
            "unit":"count"
          },
          "max":{
            "scale_factor_when_display":1,
            "statistics_type":"max",
            "value_type":"int",
            "unit":"ms"
          },
          "min":{
            "scale_factor_when_display":1,
            "statistics_type":"min",
            "value_type":"int",
            "unit":"ms"
          },
          "mode":{
            "value_type":"str",
            "enums":[
              "L",
              "F",
              "S"
            ],
            "statistics_type":"latest",
            "unit":""
          },
          "active":{
            "scale_factor_when_display":1,
            "statistics_type":"latest",
            "value_type":"int",
            "unit":"count"
          },
          "znode":{
            "scale_factor_when_display":1,
            "statistics_type":"latest",
            "value_type":"int",
            "unit":"znode_count"
          },
          "sent":{
            "scale_factor_when_display":1,
            "statistics_type":"latest",
            "value_type":"int",
            "unit":"count"
          }
        },
        "alarm":[
          "avg"
        ],
        "cmd":"/opt/zookeeper/bin/get-monitor.sh",
        "groups":{
          "connections":[
            "active",
            "outstanding"
          ],
          "latency":[
            "min",
            "avg",
            "max"
          ],
          "throughput":[
            "received",
            "sent"
          ]
        },
        "display":[
          "mode",
          "latency",
          "throughput",
          "connections",
          "znode"
        ]
      },
      "single_node_repl":"",
      "health_status":"healthy",
      "role":"",
      "incremental_backup_supported":false,
      "env":null,
      "memory":2048,
      "status_time":"2018-03-04T06:02:04Z",
      "restart_service":null,
      "app_version":"appv-70gegwmp",
      "status":"active",
      "health_check":{
        "enable":true,
        "timeout_sec":10,
        "healthy_threshold":2,
        "interval_sec":60,
        "unhealthy_threshold":2,
        "check_cmd":"echo srvr | nc 127.0.0.1 2181",
        "action_cmd":"/opt/zookeeper/bin/restart-server.sh",
        "action_timeout_sec":30
      },
      "scale_in_service":null,
      "transition_status":"",
      "storage_size":10,
      "server_id_upper_bound":255,
      "image_id":"img-svm7yple",
      "init_service":null,
      "repl":"rpp-00000000",
      "gpu":0,
      "name":"",
      "eip":"",
      "start_service":{
        "cmd":"/opt/zookeeper/bin/zkServer.sh start;/opt/zookeeper/bin/rest.sh start",
        "order":0
      },
      "resource_class":0,
      "hypervisor":"kvm",
      "delete_snapshot_service":null,
      "volume_type":0,
      "instance_id":"i-blny8gpg",
      "instance_type":"",
      "scale_out_service":null,
      "node_id":"cln-35iuqdjz",
      "custom_metadata_script":null,
      "security_group":"",
      "alarm_status":"",
      "backup_policy":null,
      "group_id":1,
      "backup_service":null,
      "cpu":1,
      "display_tabs":null
    },
    {
      "passphraseless":"",
      "vertical_scaling_policy":"sequential",
      "vxnet_id":"vxnet-pmefzgi",
      "destroy_service":null,
      "custom_service":null,
      "app_id":"app-tg3lbp0a",
      "advanced_actions":"change_vxnet,scale_horizontal",
      "agent_installed":true,
      "stop_service":{
        "cmd":"/opt/zookeeper/bin/rest.sh stop;/opt/zookeeper/bin/zkServer.sh stop",
        "order":0
      },
      "user_access":0,
      "create_time":"2018-03-04T06:00:15Z",
      "cluster_id":"cl-q1witcdk",
      "private_ip":"192.168.0.2",
      "upgrade_service":null,
      "gpu_class":0,
      "restore_service":null,
      "monitor":{
        "enable":true,
        "items":{
          "received":{
            "scale_factor_when_display":1,
            "statistics_type":"latest",
            "value_type":"int",
            "unit":"count"
          },
          "avg":{
            "scale_factor_when_display":1,
            "statistics_type":"avg",
            "value_type":"int",
            "unit":"ms"
          },
          "outstanding":{
            "scale_factor_when_display":1,
            "statistics_type":"latest",
            "value_type":"int",
            "unit":"count"
          },
          "max":{
            "scale_factor_when_display":1,
            "statistics_type":"max",
            "value_type":"int",
            "unit":"ms"
          },
          "min":{
            "scale_factor_when_display":1,
            "statistics_type":"min",
            "value_type":"int",
            "unit":"ms"
          },
          "mode":{
            "value_type":"str",
            "enums":[
              "L",
              "F",
              "S"
            ],
            "statistics_type":"latest",
            "unit":""
          },
          "active":{
            "scale_factor_when_display":1,
            "statistics_type":"latest",
            "value_type":"int",
            "unit":"count"
          },
          "znode":{
            "scale_factor_when_display":1,
            "statistics_type":"latest",
            "value_type":"int",
            "unit":"znode_count"
          },
          "sent":{
            "scale_factor_when_display":1,
            "statistics_type":"latest",
            "value_type":"int",
            "unit":"count"
          }
        },
        "alarm":[
          "avg"
        ],
        "cmd":"/opt/zookeeper/bin/get-monitor.sh",
        "groups":{
          "connections":[
            "active",
            "outstanding"
          ],
          "latency":[
            "min",
            "avg",
            "max"
          ],
          "throughput":[
            "received",
            "sent"
          ]
        },
        "display":[
          "mode",
          "latency",
          "throughput",
          "connections",
          "znode"
        ]
      },
      "single_node_repl":"",
      "health_status":"healthy",
      "role":"",
      "incremental_backup_supported":false,
      "env":null,
      "memory":2048,
      "status_time":"2018-03-04T06:01:58Z",
      "restart_service":null,
      "app_version":"appv-70gegwmp",
      "status":"active",
      "health_check":{
        "enable":true,
        "timeout_sec":10,
        "healthy_threshold":2,
        "interval_sec":60,
        "unhealthy_threshold":2,
        "check_cmd":"echo srvr | nc 127.0.0.1 2181",
        "action_cmd":"/opt/zookeeper/bin/restart-server.sh",
        "action_timeout_sec":30
      },
      "scale_in_service":null,
      "transition_status":"",
      "storage_size":10,
      "server_id_upper_bound":255,
      "image_id":"img-svm7yple",
      "init_service":null,
      "repl":"rpp-00000000",
      "gpu":0,
      "name":"",
      "eip":"",
      "start_service":{
        "cmd":"/opt/zookeeper/bin/zkServer.sh start;/opt/zookeeper/bin/rest.sh start",
        "order":0
      },
      "resource_class":0,
      "hypervisor":"kvm",
      "delete_snapshot_service":null,
      "volume_type":0,
      "instance_id":"i-x6uksame",
      "instance_type":"",
      "scale_out_service":null,
      "node_id":"cln-oruuckuo",
      "custom_metadata_script":null,
      "security_group":"",
      "alarm_status":"",
      "backup_policy":null,
      "group_id":2,
      "backup_service":null,
      "cpu":1,
      "display_tabs":null
    },
    {
      "passphraseless":"",
      "vertical_scaling_policy":"sequential",
      "vxnet_id":"vxnet-pmefzgi",
      "destroy_service":null,
      "custom_service":null,
      "app_id":"app-tg3lbp0a",
      "advanced_actions":"change_vxnet,scale_horizontal",
      "agent_installed":true,
      "stop_service":{
        "cmd":"/opt/zookeeper/bin/rest.sh stop;/opt/zookeeper/bin/zkServer.sh stop",
        "order":0
      },
      "user_access":0,
      "create_time":"2018-03-04T06:00:15Z",
      "cluster_id":"cl-q1witcdk",
      "private_ip":"192.168.0.4",
      "upgrade_service":null,
      "gpu_class":0,
      "restore_service":null,
      "monitor":{
        "enable":true,
        "items":{
          "received":{
            "scale_factor_when_display":1,
            "statistics_type":"latest",
            "value_type":"int",
            "unit":"count"
          },
          "avg":{
            "scale_factor_when_display":1,
            "statistics_type":"avg",
            "value_type":"int",
            "unit":"ms"
          },
          "outstanding":{
            "scale_factor_when_display":1,
            "statistics_type":"latest",
            "value_type":"int",
            "unit":"count"
          },
          "max":{
            "scale_factor_when_display":1,
            "statistics_type":"max",
            "value_type":"int",
            "unit":"ms"
          },
          "min":{
            "scale_factor_when_display":1,
            "statistics_type":"min",
            "value_type":"int",
            "unit":"ms"
          },
          "mode":{
            "value_type":"str",
            "enums":[
              "L",
              "F",
              "S"
            ],
            "statistics_type":"latest",
            "unit":""
          },
          "active":{
            "scale_factor_when_display":1,
            "statistics_type":"latest",
            "value_type":"int",
            "unit":"count"
          },
          "znode":{
            "scale_factor_when_display":1,
            "statistics_type":"latest",
            "value_type":"int",
            "unit":"znode_count"
          },
          "sent":{
            "scale_factor_when_display":1,
            "statistics_type":"latest",
            "value_type":"int",
            "unit":"count"
          }
        },
        "alarm":[
          "avg"
        ],
        "cmd":"/opt/zookeeper/bin/get-monitor.sh",
        "groups":{
          "connections":[
            "active",
            "outstanding"
          ],
          "latency":[
            "min",
            "avg",
            "max"
          ],
          "throughput":[
            "received",
            "sent"
          ]
        },
        "display":[
          "mode",
          "latency",
          "throughput",
          "connections",
          "znode"
        ]
      },
      "single_node_repl":"",
      "health_status":"healthy",
      "role":"",
      "incremental_backup_supported":false,
      "env":null,
      "memory":2048,
      "status_time":"2018-03-04T06:01:59Z",
      "restart_service":null,
      "app_version":"appv-70gegwmp",
      "status":"active",
      "health_check":{
        "enable":true,
        "timeout_sec":10,
        "healthy_threshold":2,
        "interval_sec":60,
        "unhealthy_threshold":2,
        "check_cmd":"echo srvr | nc 127.0.0.1 2181",
        "action_cmd":"/opt/zookeeper/bin/restart-server.sh",
        "action_timeout_sec":30
      },
      "scale_in_service":null,
      "transition_status":"",
      "storage_size":10,
      "server_id_upper_bound":255,
      "image_id":"img-svm7yple",
      "init_service":null,
      "repl":"rpp-00000000",
      "gpu":0,
      "name":"",
      "eip":"",
      "start_service":{
        "cmd":"/opt/zookeeper/bin/zkServer.sh start;/opt/zookeeper/bin/rest.sh start",
        "order":0
      },
      "resource_class":0,
      "hypervisor":"kvm",
      "delete_snapshot_service":null,
      "volume_type":0,
      "instance_id":"i-aib1f523",
      "instance_type":"",
      "scale_out_service":null,
      "node_id":"cln-yrlus78f",
      "custom_metadata_script":null,
      "security_group":"",
      "alarm_status":"",
      "backup_policy":null,
      "group_id":3,
      "backup_service":null,
      "cpu":1,
      "display_tabs":null
    }
  ],
  "ret_code":0
}

Development_docs: DescribeClusters

Mon, 01 Jan 0001 00:00:00 +0000

获取一个或多个集群的信息

可根据集群ID，状态，应用ID，应用版本ID，类型，私网ID，标签等作为过滤条件，来获取集群列表。如果不指定任何过滤条件，则返回你所拥有的所有集群。

Request Parameters

Parameter name	Type	Description	Required
clusters.n	String	集群ID	Yes
apps.n	String	集群所属的应用ID，一个或多个	No
scope	String	集群的类型，可选类型为app,cfgmgmt，默认为app类型
app_versions.n	String	集群所属的应用版本ID，一个或多个	No
cluster_name	String	集群的名称	No
link	String	集群的外部依赖，格式如`{"limits": {"app-d8yrwihf":["v1-1", "v1-2"], "app_id2": []}`	No
external_cluster_id	String	集群依赖集群ID	No
status.n	String	集群状态: active,suspended,deleted,ceased	No
vxnet	String	网络ID	No
auto_scale_step	String	自动伸缩选项配置: volume_size，count	No
tags.n	String	按照标签ID过滤，只返回已绑定某标签的资源	No
owner	String	按照用户账户过滤，只返回指定账户的资源	No
verbose	Integer	是否返回冗长的信息，若为1，则返回集群相关其它资源信息	No
offset	Integer	数据偏移量，默认为0	No
limit	Integer	返回数据长度，默认为20，最大100	No
reverse	Integer	是否逆序，1为逆序，0为正序	No
zone	String	区域ID，注意要小写	No

公共参数

Response Elements

Name	Type	Description
action	String	响应动作
total_count	Integer	集群的总数量
cluster_set	Array	集群的集合，为Cluster格式
job_id	String	执行任务的 Job ID
ret_code	Integer	执行成功与否，0 表示成功，其他值则为错误代码

Cluster的格式

Name	Type	Description
global_uuid	String	集群全局uuid
auto_backup_time	Integer	-1表示为设置自动备份
health_check_enablement	Dict	是否设置了健康检查，格式为`{"roleA": true, "roleB": false}`，如应用只有一个角色，则格式为`{"":true}`
app_id	String	集群所属应用的ID
custom_service	Dict	集群的Custom Service配置
advanced_actions	Dict	集群支持的操作，格式为`{"roleA": ["change_vxnet", "scale_horizontal"]}`, `change_vxnet`表示支持切换私网，`scale_horizontal`表示支持横向伸缩
console_id	String	集群所在的console ID
create_time	String	集群的创建时间
cluster_id	String	集群的ID
owner	String	集群的所有者ID
upgrade_time	String	集群升级的时间
incremental_backup_supported	String	集群是否支持增量备份
display_tabs	Dict	集群的display tabs配置，具体参见开发者文档
cluster_type	Integer	0表示为AppCenter2.0集群，1表示为AppCenter1.0集群
security_group_id	String	集群绑定的防火墙ID
upgrade_status	String	集群升级操作的状态
node_count	Integer	集群的节点数量
app_version	String	集群所属的应用版本ID
role_count	Dict	集群分角色的节点数量，格式为`{"roleA": 2, "roleB": 1}`
status	String	集群当前的状态，为 active，deleted, ceased, suspended
description	String	集群的描述信息
tags	Array	集群的tag信息，如果有绑定的话
app_info	Dict	集群所属的APP信息，格式为`{"app_name":"ZooKeeper", "app_id":"app-dddcsdfs", "icon":"ca-iwsdfsf"}`
transition_status	String	集群的中间状态，为creating,updating,deleting,ceasing
root_user_id	String	集群所属用户的主账号ID
name	String	集群的名称
roles	Array	集群节点角色
lastest_snapshot_time	String	最新的备份的时间
vxnet	Dict	集群所在的网络信息，格式为`{"vxnet_name": "zoo", "vxnet_type": 1, "vxnet_id": "vxnet-diasfd", "vpc_router_id": "rtr-23145adf"}`，vxnet_type为网络的类型，1表示为私有网络，vpc_router_id表示网络所在VPC的ID
auto_scale_step	Dict	集群各角色各项配置参数的自动伸缩步长值，格式为`{"master": {"count": 1}, "slave": {"volume_size": 20}}`，count的值表示该角色每次自动伸缩的节点数量，volume_size的值表示该角色每次自动伸缩的磁盘大小
backup_policy	String	集群备份的策略，具体参考开发者文档
endpoints	Dict	集群的endpoints设置，具体参考开发者文档
app_version_info	Dict	集群所属的应用版本信息，格式为`{ "status_time":"2017-04-21T02:34:24Z", "upgrade_policy":[], "resource_kit":"ca-nx8rerlv", "version_id":"appv-70gegwmp", "name":"QingCloud 1.0 - ZooKeeper 3.4.9" }`

Example

下列返回结果为应用ZooKeeper所创建的集群

Example Request:

https://api.qingcloud.com/iaas/?action=DescribeClusters
&clusters.1=cl-q1witcdk
&limit=20
&reverse=1
&scope=app
&zone=pek3a
&COMMON_PARAMS

Example Response:

{
  "action":"DescribeClustersResponse",
  "total_count":1,
  "cluster_set":[
    {
      "auto_backup_time":-1,
      "health_check_enablement":{
        "":true
      },
      "custom_service":{},
      "app_id":"app-tg3lbp0a",
      "advanced_actions":{
        "":"change_vxnet,scale_horizontal"
      },
      "upgrade_policy":[],
      "create_time":"2018-03-04T06:00:15Z",
      "cluster_id":"cl-q1witcdk",
      "owner":"usr-NzTfAWek",
      "upgrade_time":"2018-03-04T06:00:15Z",
      "incremental_backup_supported":false,
      "display_tabs":{},
      "sub_code":0,
      "add_links":null,
      "security_group_id":"",
      "upgrade_status":"",
      "status_time":"2018-03-04T06:02:26Z",
      "node_count":3,
      "app_version":"appv-70gegwmp",
      "role_count":{
        "":3
      },
      "status":"active",
      "description":"",
      "tags":[],
      "app_info":{
        "app_name":"ZooKeeper on QingCloud",
        "app_id":"app-tg3lbp0a",
        "icon":"ca-iwg9qvsx"
      },
      "transition_status":"",
      "partner_access":false,
      "name":"ZooKeeper",
      "roles":[
        ""
      ],
      "auto_scale_step":{
        "":{
          "count":1,
          "volume_size":20
        }
      },
      "lastest_snapshot_time":null,
      "vxnet":{
        "vxnet_name":"",
        "vxnet_type":1,
        "vxnet_id":"vxnet-pmefzgi",
        "vpc_router_id":"rtr-bk8fnw71"
      },
      "debug":false,
      "backup_policy":null,
      "endpoints":{
        "client":{
          "protocol":"tcp",
          "port":2181
        },
        "rest":{
          "protocol":"tcp",
          "port":9998
        }
      },
      "backup":{
        "":false
      },
      "app_version_info":{
        "status_time":"2017-04-21T02:34:24Z",
        "upgrade_policy":[],
        "resource_kit":"ca-nx8rerlv",
        "version_id":"appv-70gegwmp",
        "name":"QingCloud 1.0 - ZooKeeper 3.4.9"
      }
    }
  ],
  "ret_code":0
}

Development_docs: DissociateEipFromClusterNode

Mon, 01 Jan 0001 00:00:00 +0000

为集群节点解绑公网IP，如果集群中没有节点绑定公网IP，则集群防火墙会默认删除。

Request Parameters

Parameter name	Type	Description	Required
eips.n	String	将要解绑的公网IP的ID，可以通过_DescribeClusterNodes_获取节点绑定的公网IP的ID	Yes

公共参数

Response Elements

Name	Type	Description
action	String	响应动作
job_id	String	执行任务的 Job ID
ret_code	Integer	执行成功与否，0 表示成功，其他值则为错误代码

Example Request:

https://api.qingcloud.com/iaas/?action=DissociateEipFromClusterNode
&eips.1=eip-ek3scgap
&zone=pek3b
&COMMON_PARAMS

Example Response:

{
  "action":"DissociateEipFromClusterNodeResponse",
  "job_id":"j-7vr4wbltzn9",
  "ret_code":0
}

Development_docs: GetClusterMonitor

Mon, 01 Jan 0001 00:00:00 +0000

获取集群节点的监控数据

为减少数据传输，在保持数据结构清晰的前提下，我们对监控数据做了压缩，在解析返回数据时要留意。详细说明参见监控数据压缩说明

Request Parameters

Parameter name	Type	Description	Required
version_id	String	集群应用版本ID	No
app_id	String	集群应用ID	No
resource	String	集群节点ID	Yes
role	String	节点角色	No
step	String	监控数据时间间隔，例如 1m, 5m, 15m, 30m, 1h, 2h, 1d	Yes
start_time	TimeStamp	监控数据的开始 UTC 时间，格式为 2011-07-11T11:07:00Z 或 2011-07-11T11:07:00.520Z	Yes
end_time	TimeStamp	监控数据的结束 UTC 时间，格式为 2011-07-11T11:07:00Z 或 2011-07-11T11:07:00.520Z	Yes
meters.n	String	监控数据的类型， stats 表示获取开发者定义的监控数据 cpu 表示节点CPU使用率 memory 表示节点内存使用率 disk-us-volume 表示节点硬盘使用率 disk-iops-volume 表示节点硬盘IOPS disk-volume 表示节点硬盘吞吐量	Yes

公共参数

Response Elements

Name	Type	Description
action	String	响应动作
meter_set	Dict	监控数据集合
resource_id	String	节点ID
job_id	String	执行任务的 Job ID
ret_code	Integer	执行成功与否，0 表示成功，其他值则为错误代码

监控数据集说明

节点的 cpu，memory 监控值表示 “使用的千分比”，若要计算百分比请先将值除以10 。比如 API 返回的 cpu 监控数据值是 56，表示资源使用百分比为5.6% 。
磁盘监控数据
- 盘吞吐量的监控数据单位是 B/s, 每组数据都包括两个值 [读, 写]。
- 磁盘 IOPS 的监控数据单位就是 IOPS, 每组数据也包括两个值 [读, 写]。
- 磁盘使用率的监控数据是类似这种格式 /|18|3319|15816 ，以 | 分隔表示 “mount 的路径”, “使用百分比”, “已使用空间（MB）”, “剩余可用空间（MB）”

Example

以应用ZooKeeper为例

Example Request:

https://api.qingcloud.com/iaas/?action=GetClusterMonitor
&end_time=2018-03-04T07%3A44%3A06.159Z
&meters.1=stats
&resource=cln-veb7g8nx
&start_time=2018-03-03T07%3A44%3A06.159Z
&step=5m
&zone=pek3b
&COMMON_PARAMS

Example Response:

{
  "action":"GetClusterMonitorResponse",
  "meter_set":[
    {
      "data_set":[
        [
          1520145900,
          "healthy|1|0|0|0|follower|0|22|21|4"
        ],
        "healthy|1|0|0|0|follower|0|13|12|4",
        "healthy|1|0|0|0|follower|0|8|7|4",
        "healthy|1|0|0|0|follower|0|44|43|4",
        "healthy|1|0|0|0|follower|0|89|88|4",
        "healthy|1|0|0|0|follower|0|134|133|4",
        "healthy|1|0|0|0|follower|0|179|178|4",
        "healthy|1|0|0|0|follower|0|224|223|4",
        "healthy|1|0|0|0|follower|0|269|268|4",
        "healthy|1|0|0|0|follower|0|314|313|4",
        "healthy|1|0|0|0|follower|0|359|358|4",
        "healthy|1|0|0|0|follower|0|404|403|4"
      ],
      "meter_info":{
        "items":{
          "received":{
            "scale_factor_when_display":1,
            "value_type":"int",
            "unit":"count"
          },
          "avg":{
            "scale_factor_when_display":1,
            "value_type":"int",
            "unit":"ms"
          },
          "outstanding":{
            "scale_factor_when_display":1,
            "value_type":"int",
            "unit":"count"
          },
          "max":{
            "scale_factor_when_display":1,
            "value_type":"int",
            "unit":"ms"
          },
          "min":{
            "scale_factor_when_display":1,
            "value_type":"int",
            "unit":"ms"
          },
          "mode":{
            "enums":[
              "L",
              "F",
              "S"
            ],
            "value_type":"str",
            "unit":""
          },
          "active":{
            "scale_factor_when_display":1,
            "value_type":"int",
            "unit":"count"
          },
          "znode":{
            "scale_factor_when_display":1,
            "value_type":"int",
            "unit":"znode_count"
          },
          "sent":{
            "scale_factor_when_display":1,
            "value_type":"int",
            "unit":"count"
          }
        },
        "alarm":[
          "avg"
        ],
        "cmd":"/opt/zookeeper/bin/get-monitor.sh",
        "display":[
          "mode",
          "latency",
          "throughput",
          "connections",
          "znode"
        ],
        "groups":{
          "connections":[
            "active",
            "outstanding"
          ],
          "latency":[
            "min",
            "avg",
            "max"
          ],
          "throughput":[
            "received",
            "sent"
          ]
        }
      },
      "meter_id":"stats"
    }
  ],
  "ret_code":0,
  "resource_id":"cln-veb7g8nx"
}

Development_docs: RecoverClusters

Mon, 01 Jan 0001 00:00:00 +0000

从回收站恢复集群

Request Parameters

Parameter name	Type	Description	Required
clusters.n	String	待恢复的集群ID	Yes
zone	String	区域ID，注意id需要小写	Yes

公共参数

Response Elements

Name	Type	Description
action	String	响应动作
node_ids	Array	集群的节点ID
app_id	String	应用ID
app_version	String	应用的版本ID
node_count	Integer	集群节点的数量
cluster_name	String	集群的名称
cluster_id	String	集群ID
vxnet_id	String	集群所在的网络ID
job_id	String	执行任务的 Job ID
ret_code	Integer	执行成功与否，0 表示成功，其他值则为错误代码

Example

以应用ZooKeeper为例

Example Request:

https://api.qingcloud.com/iaas/?action=RecoverClusters
&clusters.1=cl-q1witcdk
&zone=pek3b
&COMMON_PARAMS

Example Response:

{
  "vxnet_id":"vxnet-iuy3lnd",
  "ret_code":0,
  "node_ids":[
    "cln-hk5zf06w"
  ],
  "app_id":"app-tg3lbp0a",
  "cluster_name":"ZooKeeper",
  "cluster_id":"cl-kwy18xe7",
  "action":"CreateClusterResponse",
  "node_count":1,
  "app_version":"appv-70gegwmp",
  "job_id":"j-lvilrk89641"
}

Development_docs: ResizeCluster

Mon, 01 Jan 0001 00:00:00 +0000

纵向扩容集群，即改变集群节点的配置。前提是应用支持扩容，可以通过　查看应用节点的配置。

Request Parameters

Parameter name	Type	Description	Required
cluster	String	集群ID	Yes
memory	Integer	节点将要增加或减小到的内存，单位MB	No
cpu	Integer	节点将要增加或减小到的cpu数量	No
gpu	Integer	节点将要增加或减小到的gpu数量	No
storage	Integer	节点将要增加到的存储大小，单位GB	No
node_role	String	节点的角色，如应用未配置节点角色，可留空	No

公共参数

Response Elements

Name	Type	Description
action	String	响应动作
memory	Integer	扩容后的节点内存，单位MB
cpu	Integer	扩容后的节点cpu数量
gpu	Integer	扩容后的节点gpu数量
storage	Integer	扩容后的节点存储大小，单位GB
job_id	String	执行任务的 Job ID
ret_code	Integer	执行成功与否，0 表示成功，其他值则为错误代码

Example

以应用ZooKeeper为例

Example Request:

https://api.qingcloud.com/iaas/?action=ResizeCluster
&cluster=cl-q1witcdk
&cpu=2
&memory=4096
&storage_size=20
&zone=pek3b
&COMMON_PARAMS

Example Response:

{
  "job_id":"j-7l8mrrvlvxa",
  "ret_code":0,
  "storage_size":20,
  "cluster_id":"cl-q1witcdk",
  "memory":4096,
  "action":"ResizeClusterResponse",
  "gpu":0,
  "cpu":2
}

Development_docs: RestartClusterService

Mon, 01 Jan 0001 00:00:00 +0000

重启集群服务，前提是应用定义了restart_service。

Request Parameters

Parameter name	Type	Description	Required
cluster	String	将要重启服务的集群ID	Yes
role	String	重启的集群角色	No

公共参数

Response Elements

Name	Type	Description
action	String	响应动作
cluster_id	String	集群ID
job_id	String	执行任务的 Job ID
ret_code	Integer	执行成功与否，0 表示成功，其他值则为错误代码

Example

以应用QingCloud MySQL Plus为例

Example Request:

https://api.qingcloud.com/iaas/?action=RestartClusterService
&cluster=cl-95av0jxo
&zone=pek3b
&COMMON_PARAMS

Example Response:

{
  "action":"RestartClusterServiceResponse",
  "cluster_id":"cl-95av0jxo",
  "job_id":"j-itxd749281a",
  "ret_code":0
}

Development_docs: StartClusters

Mon, 01 Jan 0001 00:00:00 +0000

启动处于关闭状态的集群，可以是一个或者多个集群。

Request Parameters

Parameter name	Type	Description	Required
clusters.n	String	将要启动的集群ID	Yes

公共参数

Response Elements

Name	Type	Description
action	String	响应动作
job_id	String	执行任务的 Job ID，格式为`{"cln-ssdfawx":"j-kdlsafda"}`
ret_code	Integer	执行成功与否，0 表示成功，其他值则为错误代码

Example

以应用ZooKeeper为例

Example Request:

https://api.qingcloud.com/iaas/?&action=StartClusters
&clusters.1=cl-q1witcdk
&zone=pek3b
&COMMON_PARAMS

Example Response:

{
  "action":"StartClustersResponse",
  "job_ids":{
    "cl-q1witcdk":"j-m430f0i8ldu"
  },
  "ret_code":0
}

Development_docs: StopClusters

Mon, 01 Jan 0001 00:00:00 +0000

关闭处于活跃状态的集群，可以是一个或者多个集群。

Request Parameters

Parameter name	Type	Description	Required
clusters.n	String	将要启动的集群ID	Yes

公共参数

Response Elements

Name	Type	Description
action	String	响应动作
job_id	String	执行任务的 Job ID，格式为`{"cln-ssdfawx":"j-kdlsafda"}`
ret_code	Integer	执行成功与否，0 表示成功，其他值则为错误代码

Example

以应用ZooKeeper为例

Example Request:

https://api.qingcloud.com/iaas/?&action=StopClusters
&clusters.1=cl-q1witcdk
&zone=pek3b
&COMMON_PARAMS

Example Response:

{
  "action":"StopClustersResponse",
  "job_ids":{
    "cl-q1witcdk":"j-m430f0i8ldu"
  },
  "ret_code":0
}

Development_docs: UpdateClusterEnvironment

Mon, 01 Jan 0001 00:00:00 +0000

修改集群或集群某类角色节点的环境变量。集群的环境变量可以通过查看。

Request Parameters

Parameter name	Type	Description	Required
cluster	String	集群ID	Yes
role	String	将要修改的角色，如集群未配置角色，可留空	No
env	String	JSON格式的环境变量，例如 `{"key": "value"}`	Yes

公共参数

Response Elements

Name	Type	Description
action	String	响应动作
cluster_id	String	集群的ID
role	String	修改变量的角色
updated_env	Dict	JSON格式的修改结果，参见下面示例
job_id	String	执行任务的 Job ID，格式为`{"cln-ssdfawx":"j-kdlsafda"}`
ret_code	Integer	执行成功与否，0 表示成功，其他值则为错误代码

Example

以应用Redis Cluster为例，修改 max-maxmemory 和 hash-max-ziplist-entries

Example Request:

https://api.qingcloud.com/iaas/?action=UpdateClusterEnvironment
&cluster=cl-2gi2b3oc
&env=%7B%22maxmemory-percent%22%3A60%2C%22hash-max-ziplist-entries%22%3A1024%7D
&zone=pek3b
&COMMON_PARAMS

Example Response:

{
  "job_id":"j-e6jdaxk1tat",
  "ret_code":0,
  "updated_env":[
    {
      "role":"master",
      "env":{
        "hash-max-ziplist-entries":1024,
        "maxmemory-percent":60
      }
    }
  ],
  "cluster_id":"cl-2gi2b3oc",
  "action":"UpdateClusterEnvironmentResponse",
  "role":"master"
}