全部产品
Search

搜索本产品

    数字证书管理服务：ListWorkerResource - 获取部署任务下的Worker任务列表

    文档中心

    数字证书管理服务：ListWorkerResource - 获取部署任务下的Worker任务列表

    更新时间：Sep 20, 2024

    阿里云支持批量部署证书，因此一个部署任务中可能对应多个云产品子任务（Worker），对应每个产品中的资源实例，您可通过该接口查看Worker任务详细信息。

    调试

    您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

    授权信息

    下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

    • 操作：是指具体的权限点。
    • 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
    • 资源类型：是指操作中支持授权的资源类型。具体说明如下：
      • 对于必选的资源类型，用背景高亮的方式表示。
      • 对于不支持资源级授权的操作，用全部资源表示。
    • 条件关键字：是指云产品自身定义的条件关键字。
    • 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
    操作访问级别资源类型条件关键字关联操作
    yundun-cert:ListWorkerResourcelist
    • 全部资源
      *
      无
    		无

    请求参数

    名称类型必填描述示例值
    JobIdlong是

    部署任务 ID。此处 ID 为 CreateDeploymentJob 返回的任务 ID。也可通过 ListDeploymentJob 接口获取。

    		8888
    Statusstring否

    Worker 任务状态。

    枚举值：
    • rollback：回滚中。
    • rollback_error：回滚失败。
    • success：部署成功。
    • rollback_success：回滚成功。
    • pending：待部署。
    • scheduling：调度中。
    • processing：部署中。
    • error：部署失败。
    • editing：编辑中。
    		editing
    CloudProductstring否

    部署任务中对应的云产品。

    		NLB
    CurrentPageinteger否

    分页查询时，设置当前页面的页码。默认值为 1。

    		1
    ShowSizeinteger否

    分页，设置每页展示的任务个数，默认 50。

    		50

    返回参数

    名称类型描述示例值
    object

    OpenApiPaginationResponse。

    Totallong

    查询到的符合条件的总数。

    		8
    CurrentPageinteger

    分页，当前页，默认 1。

    		1
    ShowSizeinteger

    分页查询时，每页展示的任务个数。默认值为 50。

    		50
    Dataarray<object>

    请求接口返回的数据。

    object

    具体对象。

    Idlong

    Worker 任务 ID。

    		22487
    GmtCreatestring

    Worker 任务创建时间（秒，时间戳格式）。

    		1680228896000
    GmtModifiedstring

    Worker 任务最后修订时间（秒，时间戳格式）。

    		1681956830000
    UserIdlong

    Worker 任务所归属的阿里云账号 ID。

    		166688437******
    JobIdlong

    Worker 所属的部署任务 ID（JobId）

    		8888
    OrderIdlong

    Worker 任务订单 ID，与证书订单 ID 一致。

    说明 返回 CertId，则该参数不返回。
    		9349278
    CertIdlong

    Worker 任务对应的证书 ID，与证书 ID 一致。

    		12073663
    CertDomainstring

    Worker 任务对应的证书域名。

    		www.example.com
    CertInstanceIdstring

    Worker 任务证书实例 ID。

    		lsn-jzk2h0xz5dmynuphb8@1883
    CertNamestring

    Worker 任务对应的证书名称。

    		testCertName
    ResourceIdlong

    Worker 任务对应的云产品资源 ID。

    		1286999
    CloudProductstring

    Worker 任务中云资源所属云产品。

    • CDN：内容分发网络（仅中国站）
    • SLB：传统型负载均衡 CLB（仅中国站）
    • DCDN：全站加速（仅中国站）
    • DDOS：DDos 防护（仅中国站）
    • LIVE：视频直播（仅中国站）
    • webHosting：云虚拟主机（仅中国站）
    • VOD：视频点播（仅中国站）
    • CR：容器镜像服务（仅中国站）
    • ALB：应用负载均衡
    • APIGateway：API 网关
    • FC：函数计算
    • GA：全球加速
    • MSE：微服务引擎
    • NLB：网络型负载均衡
    • OSS：对象存储
    • SAE：Serverless 应用引擎
    • TencentCDN：腾讯 CDN
    • WAF：Web 应用防火墙
    		SLB
    ResourceCertIdlong

    Worker 任务云产品资源原绑定证书 ID。

    		123
    ResourceDomainstring

    Worker 任务云产品资源原绑定域名。

    		www.example.com
    RegionIdstring

    Worker 任务云产品资源的地域 ID。

    		cn-hangzhou
    CloudRegionstring

    Worker 任务云产品资源原始地域 ID（云厂商的 RegionID）。仅多云部署会返回。

    		cn-hangzhou
    InstanceIdstring

    Worker 任务云产品中的资源实例 ID。

    说明 仅部署 SLB、NLB、ALB 和 GA 才会返回该参数。
    		cas-cn-0pp118nuu40b
    ListenerIdstring

    Worker 任务云产品中资源的监听 ID。

    说明 仅部署 SLB、NLB、ALB 和 GA 才会返回该参数。
    		lsn-lhl8y7s1e1ngc3m3zz@81
    Portinteger

    Worker 任务云产品中资源的监听端口。

    说明 仅部署 SLB、NLB、ALB 和 GA 才会返回该参数。
    		4431
    DefaultResourceboolean

    Worker 任务云产品资源是否为”默认资源“。

    • true：默认资源
    • false：非默认资源
    说明 仅部署 SLB、NLB、ALB 和 GA 才会返回该参数。
    		true
    CloudNamestring

    Worker 任务云产品资源所属云厂商。

    说明 部署至阿里云的云产品默认不返回该参数。
    		aliyun
    NamespaceIdstring

    Serverless 应用引擎命名空间 ID。仅部署 Serverless 应用引擎返回。

    		32fed52a-4bf7-44f6-955f-e82ada68ef18
    Statusstring

    部署任务 Worker 状态。

    • editing：编辑中
    • pending：待部署
    • scheduling：调度中
    • processing：部署中
    • error：部署失败
    • success：部署成功
    • rollback：回滚中
    • rollback_success：回滚成功
    • rollback_error：回滚失败
    		editing
    RequestIdstring

    本次调用请求的 ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。

    		3E50D480-9765-5CFD-9650-9BACCECA5135

    示例

    正常返回示例

    JSON格式

    {
  "Total": 8,
  "CurrentPage": 1,
  "ShowSize": 50,
  "Data": [
    {
      "Id": 22487,
      "GmtCreate": "1680228896000",
      "GmtModified": "1681956830000",
      "UserId": 0,
      "JobId": 8888,
      "OrderId": 9349278,
      "CertId": 12073663,
      "CertDomain": "www.example.com",
      "CertInstanceId": "lsn-jzk2h0xz5dmynuphb8@1883",
      "CertName": "testCertName",
      "ResourceId": 1286999,
      "CloudProduct": "SLB",
      "ResourceCertId": 123,
      "ResourceDomain": "www.example.com",
      "RegionId": "cn-hangzhou",
      "CloudRegion": "cn-hangzhou",
      "InstanceId": "cas-cn-0pp118nuu40b",
      "ListenerId": "lsn-lhl8y7s1e1ngc3m3zz@81",
      "Port": 4431,
      "DefaultResource": true,
      "CloudName": "aliyun",
      "NamespaceId": "32fed52a-4bf7-44f6-955f-e82ada68ef18",
      "Status": "editing"
    }
  ],
  "RequestId": "3E50D480-9765-5CFD-9650-9BACCECA5135"
}

    错误码

    访问错误中心查看更多错误码。