接口URL:/csm/v1/open/cluster/show_namespace
Content-Type:text/plain
请求方式:GET
URI参数说明:
参数名 | 示例值 | 参数类型 | 是否必填 | 参数描述 |
---|---|---|---|---|
service_mesh_id | e779bd8***** | String | 是 | 服务网格id |
cluster_id | kjye******* | String | 是 | 集群id |
show_labels | false | Boolean | 否 | 是否同时返回命名空间的标签 |
请求体参数说明:
参数名 | 示例值 | 参数类型 | 是否必填 | 参数描述 |
---|---|---|---|---|
无请求参数KEY/VALUE类型 |
返回参数说明:
参数名 | 示例值 | 参数类型 | 参数描述 |
---|---|---|---|
code | CSM_2000 | String | 错误码 |
message | SUCCESS | String | 错误提示信息 |
returnObj | Object | Object | API返回数据体,接口如果没有返回字段时也可能可能返回{}或[] |
statusCode | 2000 | Integer | 调用错误时返回的错误编码 |
表returnObj
参数名 | 示例值 | 参数类型 | 参数描述 |
---|---|---|---|
namespaceList | array | Array[NameSpaceInfo] | 集群命名空间列表 |
表NameSpaceInfo
参数名 | 示例值 | 参数类型 | 参数描述 |
---|---|---|---|
labels | {"istio-injection": "enabled"} | map[string]string | 命名空间标签,仅当show_labels为true时有值 |
name | default | string | 命名空间名称 |
返回示例:成功
{
"statusCode": 2000,
"message": "SUCCESS",
"code": "CSM_2000",
"returnObj": {
"namespaceList": [
{
"name": "default",
"labels": {
"istio-injection": "enabled",
"kubernetes.io/metadata.name": "default"
}
},
{
"name": "istio-ingress",
"labels": {
"kubernetes.io/metadata.name": "istio-ingress"
}
},
{
"name": "istio-system",
"labels": {
"istio-injection": "enabled",
"kubernetes.io/metadata.name": "istio-system"
}
},
{
"name": "opa-istio",
"labels": {
"kubernetes.io/metadata.name": "opa-istio"
}
},
{
"name": "test",
"labels": {
"istio-injection": "enabled",
"kubernetes.io/metadata.name": "test"
}
}
]
}
}
返回示例:失败(详见接口失败示例章节)