基本信息

Action

DescribeClusterEnvironment

Path

/iaas

Method

GET

请求参数

此接口除公共参数外，还包含以下参数。关于公共参数的更多信息，请参见前文内容。

参数名 类型 是否必须 描述

app_id

String

是

集群 ID

返回数据

此接口除公共返回参数外，还包含以下返回参数。关于公共返回参数的更多信息，请参见前文内容。

参数名 类型 是否必须 描述

config

Array

否

环境配置

config.description

String

否

参数描述

config.key

String

否

环境参数键

config.properties

Array

否

参数属性

config.properties.changeable

String

否

是否可被修改

config.properties.description

String

否

属性描述

config.properties.key

String

否

参数键

config.properties.range

String

否

可选范围

config.properties.required

String

否

是否必填

config.properties.type

String

否

属性

config.type

String

否

环境参数类型

请求示例

{
  "action": "DescribeClusterEnvironment",
  "cluster_id": "cl-2kogt3ly",
  "zone": "pek3"
}

返回示例

{
  "action": "DescribeClusterEnvironmentResponse",
  "config": {
    "description": "Application configuration properties",
    "key": "env",
    "properties": [
      {
        "changeable": 否,
        "default": "MySQL-8.0",
        "description": "",
        "key": "mysqlversion",
        "label": "MySQLVersion",
        "range": [
          "MySQL-5.6",
          "MySQL-5.7",
          "MySQL-8.0"
        ],
        "required": "yes",
        "system": true,
        "type": "string"
      },
      {
        "default": 3306,
        "description": "The mysql will restart if modified",
        "key": "port",
        "label": "Port",
        "max": 8000,
        "min": 3306,
        "required": "no",
        "type": "integer"
      }
    ],
    "type": "array"
  },
  "ret_code": 0,
  "trace_id": "nSh4XWLB"
}