产品与服务

解决方案

定价

文档

云市场

开发者

了解金山云

招标公告

热门搜索

云服务器弹性IP 对象存储 IAM 账号管理账单

控制台

备案

全部文档

当前文档

热搜词推荐

云服务器虚拟私有网络边缘节点计算对等连接

暂无内容

如果没有找到您期望的内容，请尝试其他搜索词

文档中心

容器服务(KCE)

查看更多结果

未找到含当前关键字的文档标题

页面目录

全部展开全部收起

产品更新动态

未找到含该关键词的产品

文档中心

容器服务(KCE)

API文档（新）

托管Prometheus

查询Prometheus实例

请求参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。

参数名称	类型	必填	描述

Action	String	是	公共参数，本接口取值：DescribePrometheusInstance。
Version	String	是	公共参数，本接口取值：2023-03-06。
InstanceId.N	String	否	实例id，若不填，则默认查询该地域下的所有实例
Marker	Int	否	分页标识，单次调用未返回全部实例时，标记下次调用的返回值的起点，默认值是0
MaxResults	Int	否	单次调用所返回的最大实例数目，默认20，最大100
Search	String	否	模糊匹配，可匹配字段：InstanceName（实例名称）

返回参数

参数名称	类型	描述

RequestId	String	请求id
Marker	Int	分页标识，如果调用未返回全部实例，标记下次调用的返回值的起点，如果已返回全部实例，则其值为0
TotalCount	Int	实例数量
InstanceSet	Object[]	实例信息
InstanceId	String	实例id
InstanceName	String	实例名称
InstanceStatus	String	实例状态: Creating：创建中 Running：运行中 Updating 更新中 Deleting：删除中 Error：异常
CreateTime	String	实例创建时间
ChargeType	String	实例计费方式
DataRetentionTime	Int	数据存储时长
AuthToken	String	数据写入需要的 Token
RemoteWriteUrl	String	Prometheus Remote Write 的地址
HttpApiUrl	String	Prometheus HTTP Api 的地址
GrafanaEnabled	Boolean	是否开启了 Grafana： false：未开启 true：已开启
GrafanaInternalUrl	String	Grafana 内网访问地址
GrafanaInternetEnabled	Boolean	Grafana 是否开启了公网访问: true: 开启 false: 不开启
GrafanaInternetUrl	String	Grafana 公网访问地址
GrafanaWhiteList	String[]	Grafana 公网访问白名单数组

请求示例

curl -X GET|POST
'http://kce.api.ksyun.com/?Action=DescribePrometheusInstance&Version=2023-03-06'
-H 'authorization: xxx, SignedHeaders=content-type;host;x-amz-date, Signature=xxx'
-H 'cache-control: no-cache'
-H 'content-type: application/x-www-form-urlencoded'
-H 'host: kce.api.ksyun.com'
-H 'x-amz-date: 20170720T022802Z'
-d 'InstanceId.N=xxx&Marker=xxx&MaxResults=xxx&Search=xxx'

返回示例

JSON格式

{

"RequestId":"45084d39-xxxx-468b-a6a1-e8fa36b22fe7",

"Marker":0,

"TotalCount":1,

"InstanceSet":[

{

"InstanceId":"xxxx05641f87xxxx98e908d7b1a83xxx",

"InstanceName":"xxxxx",

"InstanceStatus":"Creating",

"CreateTime":"2023-10-27 16:48:20",

"ChargeType":"DailyVolume",

"DataRetentionTime":15,

"AuthToken":"",

"RemoteWriteUrl":"",

"HttpApiUrl":"",

"GrafanaEnabled":false,

"GrafanaInternalUrl":"",

"GrafanaInternetEnabled":false,

"GrafanaInternetUrl":"",

"GrafanaWhiteList":[

]

}

]

}

错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码

上一篇：创建Prometheus实例

下一篇：更新Prometheus实例

纯净模式常规模式

纯净模式

点击可全屏预览文档内容