文档首页/ 资源编排服务 RFS/ API参考/ API/ 资源编排-模块管理/ 列举私有模块版本
更新时间：2025-08-11 GMT+08:00
查看PDF
分享

列举私有模块版本

功能介绍

列举私有模块版本（ListPrivateModuleVersions）

列举所选择的私有模块中所有的模块版本信息。

  • 可以使用sort_key和sort_dir两个关键字对返回结果按创建时间（create_time）进行排序。给予的sort_key和sort_dir数量须一致，否则返回400。如果未给予sort_key和sort_dir，则默认按照创建时间降序排序。

  • 如果module_name和module_id同时存在，则资源编排服务会检查是否两个匹配，如果不匹配则会返回400。

  • 如果模块不存在则返回404。

  • 支持分页返回。如果响应中存在next_marker，则表示实际总输出比当前响应中包含的输出多。在对请求的后续调用中，在请求参数中使用此值，以获取输出的下一部分。您应该重复此操作，直到next_marker响应元素返回为null

ListPrivateModuleVersions返回的只有摘要信息（具体摘要信息见ListPrivateModuleVersionsResponseBody），如果用户需要详细的模块版本元数据请调用ShowPrivateModuleVersionMetadata

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

URI

GET /v1/private-modules/{module_name}/versions

表1 路径参数

参数

是否必选

参数类型

描述

module_name

是

String

私有模块（private-module）的名字。此名字在domain_id+region下应唯一，可以使用中文、大小写英文、数字、下划线、中划线。首字符需为中文或者英文，区分大小写。
表2 Query参数

参数

是否必选

参数类型

描述

module_id

否

String

私有模块（private-module）的唯一Id。

此Id由资源编排服务在生成模块的时候生成，为UUID。

由于私有模块名称仅仅在同一时间下唯一，即用户允许先生成一个叫HelloWorld的私有模块，删除，再重新创建一个同名私有模块。

对于团队并行开发，用户可能希望确保，当前我操作的私有模块就是我认为的那个，而不是其他队友删除后创建的同名私有模块。因此，使用Id就可以做到强匹配。

资源编排服务保证每次创建的私有模块所对应的Id都不相同，更新不会影响Id。如果给予的module_id和当前模块的Id不一致，则返回400

sort_key

否

Array of strings

排序字段，仅支持给予create_time

sort_dir

否

Array of strings

指定升序还是降序

  • asc - 升序

  • desc - 降序

marker

否

String

分页标记。当一页无法返回所有结果，上一次的请求将返回next_marker以指引还有更多页数，用户可以将next_marker中的值放到此处以查询下一页的信息。此marker只能用于与上一请求指定的相同参数的请求。不指定时默认从第一页开始查询。

limit

否

Integer

每页返回的最多结果数量

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

Client-Request-Id

是

String

用户指定的，对于此请求的唯一Id，用于定位某个请求，推荐使用UUID

响应参数

状态码：200

表4 响应Body参数

参数

参数类型

描述

versions

Array of PrivateModuleVersionSummary objects

私有模块版本的列表。默认以创建时间升序排序。

page_info

PageInfo object

分页信息
表5 PrivateModuleVersionSummary

参数

参数类型

描述

module_name

String

私有模块（private-module）的名字。此名字在domain_id+region下应唯一，可以使用中文、大小写英文、数字、下划线、中划线。首字符需为中文或者英文，区分大小写。

module_id

String

私有模块（private-module）的唯一Id。

此Id由资源编排服务在生成模块的时候生成，为UUID。

由于私有模块名仅在同一时间下唯一，即允许用户先生成一个叫HelloWorld的私有模块，删除，再重新创建一个同名私有模块。

对于团队并行开发，用户可能希望确保，当前我操作的私有模块就是我以为的那个，而不是其他队友删除后创建的同名私有模块。因此，使用Id就可以做到强匹配。

资源编排服务保证每次创建的私有模块所对应的Id都不相同，更新不会影响Id。如果给予的module_id和当前模块的Id不一致，则返回400

module_version

String

模块的版本号。版本号必须遵循语义化版本号（Semantic Version），为用户自定义

version_description

String

模块版本（module version）的描述。可用于客户识别并管理模块的版本。注意：模块版本为不可更新（immutable），即描述不可更新，如果需要更新，请删除后重建

create_time

String

私有模块（private-module）版本的生成时间，格式为YYYY-MM-DDTHH:mm:ss.SSSZ，精确到毫秒，UTC时区，即，如1970-01-01T00:00:00.000Z。
表6 PageInfo

参数

参数类型

描述

next_marker

String

向后分页标识符。如果存在，则表示实际总输出比当前响应中包含的输出多。在对请求的后续调用中，在请求参数中使用此值，以获取输出的下一部分。您应该重复此操作，直到next_marker响应元素返回为null。

previous_marker

String

向前分页标识符。

current_count

Integer

本页显示的条目数量。

状态码：400

表7 响应Body参数

参数

参数类型

描述

error_code

String

响应码

error_msg

String

响应消息

encoded_authorization_message

String

包含有关未经授权请求的信息。

details

Array of Detail objects

权限拒绝时服务返回的详细错误信息。
表8 Detail

参数

参数类型

描述

error_code

String

响应码

error_msg

String

响应消息

状态码：401

表9 响应Body参数

参数

参数类型

描述

error_code

String

响应码

error_msg

String

响应消息

encoded_authorization_message

String

包含有关未经授权请求的信息。

details

Array of Detail objects

权限拒绝时服务返回的详细错误信息。
表10 Detail

参数

参数类型

描述

error_code

String

响应码

error_msg

String

响应消息

状态码：403

表11 响应Body参数

参数

参数类型

描述

error_code

String

响应码

error_msg

String

响应消息

encoded_authorization_message

String

包含有关未经授权请求的信息。

details

Array of Detail objects

权限拒绝时服务返回的详细错误信息。
表12 Detail

参数

参数类型

描述

error_code

String

响应码

error_msg

String

响应消息

状态码：404

表13 响应Body参数

参数

参数类型

描述

error_code

String

响应码

error_msg

String

响应消息

encoded_authorization_message

String

包含有关未经授权请求的信息。

details

Array of Detail objects

权限拒绝时服务返回的详细错误信息。
表14 Detail

参数

参数类型

描述

error_code

String

响应码

error_msg

String

响应消息

状态码：429

表15 响应Body参数

参数

参数类型

描述

error_code

String

响应码

error_msg

String

响应消息

encoded_authorization_message

String

包含有关未经授权请求的信息。

details

Array of Detail objects

权限拒绝时服务返回的详细错误信息。
表16 Detail

参数

参数类型

描述

error_code

String

响应码

error_msg

String

响应消息

状态码：500

表17 响应Body参数

参数

参数类型

描述

error_code

String

响应码

error_msg

String

响应消息

encoded_authorization_message

String

包含有关未经授权请求的信息。

details

Array of Detail objects

权限拒绝时服务返回的详细错误信息。
表18 Detail

参数

参数类型

描述

error_code

String

响应码

error_msg

String

响应消息

请求示例

  • 获取名为my_module的私有模块下的所有版本，以创建时间降序排序

    GET https://{endpoint}/v1/private-modules/my_module/versions

  • 获取名为my_module的私有模块下的所有版本，以创建时间降序排序

    GET https://{endpoint}/v1/private-modules/my_module/versions?sort_key=create_time&sort_dir=desc

  • 获取名为my_module的私有模块下的所有版本，以创建时间升序排序

    GET https://{endpoint}/v1/private-modules/my_module/versions?sort_key=create_time&sort_dir=asc

响应示例

状态码：200

列举私有模块版本成功

{
  "versions" : [ {
    "module_name" : "test-limit_vpc_resource-module20241211160209172862",
    "module_id" : "fd0e12bc-a1a4-4cac-8cbe-b023c389736b",
    "module_version" : "1.0.1",
    "create_time" : "2024-12-11T08:03:57.747Z"
  }, {
    "module_name" : "test-limit_vpc_resource-module20241211160209172862",
    "module_id" : "fd0e12bc-a1a4-4cac-8cbe-b023c389736b",
    "module_version" : "1.0.0",
    "version_description" : "My First Hello World Module Version Description",
    "create_time" : "2024-12-11T08:03:37.417Z"
  } ],
  "page_info" : {
    "current_count" : 2,
    "next_marker" : null,
    "previous_marker" : "zxc1oHc08HcCmypYGTsOoRcvoHUvHRUAW5NOSnc1oHc08HcCPZrwP5NOeTlRiukJgtGxeujJeuGwGIihaIUCmypYGTsOtqvKPr2xmH8fPqpGWyQ0axGwGZp9aqvx8pQ7m5FvGTsJiKk7gtNFiuaxetdRCks="
  }
}

状态码

状态码

描述

200

列举私有模块版本成功

400

用户请求非法

401

用户身份认证失败

403

用户无权限调用此API

404

模块不存在

429

请求数量过多

500

服务器内部错误

相关文档