文档首页/ 应用服务网格 ASM/ API参考/ API/ 灰度发布/ 获取灰度发布任务详情 - GetReleaseByName
更新时间:2026-02-02 GMT+08:00
分享

获取灰度发布任务详情 - GetReleaseByName

功能介绍

该API用于获取灰度发布任务详情

调用方法

请参见如何调用API

授权信息

账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权,具体权限要求请参见权限和授权项
  • 如果使用身份策略授权,需具备如下身份策略权限。

    授权项

    访问级别

    资源类型(*为必须)

    条件键

    别名

    依赖的授权项

    asm:mesh:getRelease

    Read

    mesh *

    • g:EnterpriseProjectId

    • g:ResourceTag/<tag-key>

    -

    -

URI

GET /v2/meshes/{mesh_id}/namespaces/{namespace}/releases/{release_id}

表1 路径参数

参数

是否必选

参数类型

描述

mesh_id

String

网格ID。

namespace

String

命名空间。

release_id

String

灰度发布任务ID。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

调用接口的认证方式分为Token和AK/SK两种,如果您使用的Token方式,此参数为必填,请填写Token的值。

响应参数

状态码:200

表3 响应Body参数

参数

参数类型

描述

kind

String

API类型,固定值“Release”,该值不可修改

apiVersion

String

API版本,固定值“asm/v2”,该值不可修改

metadata

ReleaseMetadata object

网格灰度发布任务的基本信息,为集合类的元素类型,包含一组由不同名称定义的属性

spec

ReleaseSpec object

网格灰度发布任务属性

status

ReleaseStatus object

网格灰度发布任务状态

表4 ReleaseMetadata

参数

参数类型

描述

meshID

String

灰度发布任务所属的网格ID

name

String

灰度发布任务名称。

命名规则:以小写字母开头,由小写字母、数字、中划线(-)组成,长度范围4-64位,且不能以中划线(-)结尾

uid

String

灰度发布任务ID,资源唯一标识,创建成功后自动生成,填写无效

namespace

String

灰度发布任务所属的命名空间

表5 ReleaseSpec

参数

参数类型

描述

serviceName

String

网格灰度发布任务对应的服务名称

clusterID

String

网格灰度发布任务对应的集群ID

deploymentName

String

网格灰度发布任务对应的工作负载名称

version

String

网格灰度发布任务对应的版本号

type

String

网格灰度发布任务类型

grayDeployments

Array of GrayWorkload objects

网格灰度发布任务的灰度工作负载模板

表6 GrayWorkload

参数

参数类型

描述

clusterID

String

灰度工作负载所在的集群ID

template

Object

灰度工作负载,参考Deployment | Kubernetes

表7 ReleaseStatus

参数

参数类型

描述

phase

String

网格灰度发布任务阶段

startTime

String

网格灰度发布任务启动时间

updateTime

String

网格灰度发布任务更新时间

deployment

Object

网格灰度发布任务原始工作负载,参考Deployment | Kubernetes

grayDeployments

Array of objects

网格灰度发布任务创建的灰度工作负载,参考Deployment | Kubernetes

状态码:400

表8 响应Body参数

参数

参数类型

描述

errorCode

String

错误码

errorMsg

String

错误描述

状态码:404

表9 响应Body参数

参数

参数类型

描述

errorCode

String

错误码

errorMsg

String

错误描述

请求示例

响应示例

状态码

状态码

描述

200

获取灰度发布任务详情成功

400

参数有误,获取灰度发布任务详情失败

404

未找到对应的灰度发布任务

错误码

请参见错误码

相关文档