1. 接口描述
接口请求域名： monitor.tencentcloudapi.com 。
查看外部集群注册命令
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeExternalClusterRegisterCommand。 |
| Version | 是 | String | 公共参数，本接口取值：2018-07-24。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| InstanceId | 是 | String | 实例 ID 示例值：prom-abcd |
| ClusterId | 是 | String | 集群 ID 示例值：ecls-abcd |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Command | String | 注册命令 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查看外部集群注册命令
输入示例
POST / HTTP/1.1
Host: monitor.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeExternalClusterRegisterCommand
<公共请求参数>
{
"InstanceId": "prom-abcd",
"ClusterId": "ecls-abcd"
}输出示例
{
"Response": {
"Command": "\n---\napiVersion: v1\nkind: Namespace\nmetadata:\n name: prom-abcd\n---\napiVersion: v1\nkind: ServiceAccount\nmetadata:\n name: proxy-agent-installer\n namespace: prom-abcd\n---\napiVersion: rbac.authorization.k8s.io/v1\nkind: ClusterRoleBinding\nmetadata:\n name: install-proxy-agent\nroleRef:\n apiGroup: rbac.authorization.k8s.io\n kind: ClusterRole\n name: cluster-admin\nsubjects:\n- kind: ServiceAccount\n name: proxy-agent-installer\n namespace: prom-abcd\n---\napiVersion: batch/v1\nkind: Job\nmetadata:\n name: proxy-agent-installer\n namespace: prom-abcd\nspec:\n backoffLimit: 5\n ttlSecondsAfterFinished: 60\n template:\n spec:\n tolerations:\n - operator: Exists\n serviceAccountName: proxy-agent-installer\n containers:\n - name: installer\n image: ccr.ccs.tencentyun.com/cloudmonitor/agent-installer:v0.0.3\n args:\n - upgrade \n - tmp\n - ./\n - --install\n - -n\n - prom-abcd\n - --set\n - proxyAgent.enabled=true\n - --set \n - proxyAgent.instanceId=prom-abcd\n - --set\n - proxyAgent.instanceToken=token\n - --set\n - proxyAgent.clusterId=ecls-abcd\n - --set\n - proxyAgent.clusterType=external\n - --set\n - proxyAgent.serverAddress=1.1.1.1:8008\n - --set\n - proxyAgent.image=ccr.ccs.tencentyun.com/cloudmonitor/multi-proxy:v1.0.12\n - --set\n - kubeStateMetrics.enabled=true\n - --set\n - kubeStateMetrics.image=ccr.ccs.tencentyun.com/cloudmonitor/tmp-kube-state-metrics:v2.6.0-shard\n - --set\n - nodeExporter.enabled=true\n - --set\n - nodeExporter.image=ccr.ccs.tencentyun.com/tkeimages/node-exporter:v1.3.1\n restartPolicy: Never\n",
"RequestId": "r3mh2ud5r9568u-e4n3tdamu8uqkwvfu"
}
}5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| InvalidParameter | 参数错误。 |
