获取网格服务列表 - GetServiceAggregations
功能介绍
该API用户获取网格内的服务列表。
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
- 如果使用身份策略授权，需具备如下身份策略权限。
URI
GET /v3/meshes/{mesh_id}/namespaces/{namespace}
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
mesh_id | 是 | String | 网格ID。 |
namespace | 是 | String | 命名空间。 |
请求参数
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
X-Auth-Token | 是 | String | 调用接口的认证方式分为Token和AK/SK两种，如果您使用的Token方式，此参数为必填，请填写Token的值。 |
响应参数
状态码：200
参数 | 参数类型 | 描述 |
|---|---|---|
items | Array of ServiceAggregation objects | 网格服务列表 |
参数 | 参数类型 | 描述 |
|---|---|---|
service | Object | 服务信息，参考Service | Kubernetes |
clusters | Array of objects | 服务相关的集群信息，参考CCE Cluster |
deployments | Array of objects | 服务相关的工作负载信息，参考Deployment | Kubernetes |
ASMStyled | ASMStyled object | 服务是否支持ASM Console能力 |
entries | Array of ServiceAddress objects | 服务入口信息 |
release | Release object | 网格服务对应的灰度发布任务 |
参数 | 参数类型 | 描述 |
|---|---|---|
traffic_manage | String | 是否支持ASM Console流量治理能力，如果值为NotMatch则不支持 |
security | String | 是否支持ASM Console服务安全能力，如果值为NotMatch则不支持 |
gateway_route | String | 是否支持ASM Console网关路由能力，如果值为NotMatch则不支持 |
参数 | 参数类型 | 描述 |
|---|---|---|
host | String | 网格服务主机 |
protocol | String | 网格服务协议 |
port | String | 网格服务端口 |
targetPort | String | 网格服务目标端口 |
accessType | String | 网格服务访问类型 |
prefix | String | 网格服务的路由前缀 |
sniHosts | Array of strings | 网格服务的sni hosts |
参数 | 参数类型 | 描述 |
|---|---|---|
kind | String | API类型，固定值“Release”，该值不可修改 |
apiVersion | String | API版本，固定值“asm/v2”，该值不可修改 |
metadata | ReleaseMetadata object | 网格灰度发布任务的基本信息，为集合类的元素类型，包含一组由不同名称定义的属性 |
spec | ReleaseSpec object | 网格灰度发布任务属性 |
status | ReleaseStatus object | 网格灰度发布任务状态 |
参数 | 参数类型 | 描述 |
|---|---|---|
meshID | String | 灰度发布任务所属的网格ID |
name | String | 灰度发布任务名称。 命名规则：以小写字母开头，由小写字母、数字、中划线(-)组成，长度范围4-64位，且不能以中划线(-)结尾 |
uid | String | 灰度发布任务ID，资源唯一标识，创建成功后自动生成，填写无效 |
namespace | String | 灰度发布任务所属的命名空间 |
参数 | 参数类型 | 描述 |
|---|---|---|
serviceName | String | 网格灰度发布任务对应的服务名称 |
clusterID | String | 网格灰度发布任务对应的集群ID |
deploymentName | String | 网格灰度发布任务对应的工作负载名称 |
version | String | 网格灰度发布任务对应的版本号 |
type | String | 网格灰度发布任务类型 |
grayDeployments | Array of GrayWorkload objects | 网格灰度发布任务的灰度工作负载模板 |
参数 | 参数类型 | 描述 |
|---|---|---|
phase | String | 网格灰度发布任务阶段 |
startTime | String | 网格灰度发布任务启动时间 |
updateTime | String | 网格灰度发布任务更新时间 |
deployment | Object | 网格灰度发布任务原始工作负载，参考Deployment | Kubernetes |
grayDeployments | Array of objects | 网格灰度发布任务创建的灰度工作负载，参考Deployment | Kubernetes |
状态码：500
参数 | 参数类型 | 描述 |
|---|---|---|
errorCode | String | 错误码 |
errorMsg | String | 错误描述 |
请求示例
无
响应示例
无
状态码
状态码 | 描述 |
|---|---|
200 | 正确获取到网格服务列表 |
500 | 内部错误 |
错误码
请参见错误码。
