devops-mcp-server-extension 1.0.0

package/dist/operations/flow/pipelineJob.js

@@ -0,0 +1,126 @@
+/**
+ * 流水线任务相关操作
+ * 提供按照分类获取流水线执行的任务接口
+ */
+import * as utils from "../../common/utils.js";
+import { resolveOrganizationId } from "../organization/organization.js";
+import { PipelineJobItemSchema, PipelineJobHistoryItemSchema, PipelineJobRunLogSchema } from "./types.js";
+/**
+ * 按任务分类获取流水线执行的任务
+ * @param organizationId Organization ID（组织ID）
+ * @param pipelineId Pipeline ID（流水线ID）
+ * @param category Task category, currently only supports DEPLOY（任务分类，当前仅支持DEPLOY）
+ * @returns 任务列表
+ */
+export async function listPipelineJobsByCategoryFunc(organizationId, pipelineId, category) {
+    const finalOrgId = await resolveOrganizationId(organizationId);
+    const url = utils.isRegionEdition()
+        ? `/oapi/v1/flow/pipelines/${pipelineId}/listTasksByCategory/${category}`
+        : `/oapi/v1/flow/organizations/${finalOrgId}/pipelines/${pipelineId}/listTasksByCategory/${category}`;
+    const response = await utils.yunxiaoRequest(url, {
+        method: "GET",
+    });
+    if (!Array.isArray(response)) {
+        return [];
+    }
+    return response.map(job => PipelineJobItemSchema.parse(job));
+}
+/**
+ * 获取流水线任务的执行历史
+ * @param organizationId Organization ID（组织ID）
+ * @param pipelineId Pipeline ID（流水线ID）
+ * @param category Task category, currently only supports DEPLOY（任务分类，当前仅支持DEPLOY）
+ * @param identifier Task identifier（任务标识）
+ * @param page Page number, default 1
+ * @param perPage Number of items per page, default 10, max 30
+ * @returns Job history list and pagination information
+ */
+export async function listPipelineJobHistorysFunc(organizationId, pipelineId, category, identifier, page = 1, perPage = 10) {
+    const finalOrgId = await resolveOrganizationId(organizationId);
+    const baseUrl = utils.isRegionEdition()
+        ? `/oapi/v1/flow/pipelines/getComponentsWithoutButtons`
+        : `/oapi/v1/flow/organizations/${finalOrgId}/pipelines/getComponentsWithoutButtons`;
+    const queryParams = {
+        pipelineId,
+        category,
+        identifier,
+        page,
+        perPage
+    };
+    const url = utils.buildUrl(baseUrl, queryParams);
+    const response = await utils.yunxiaoRequest(url, {
+        method: "GET",
+    });
+    const pagination = {
+        nextPage: null,
+        page: page,
+        perPage: perPage,
+        prevPage: null,
+        total: 0,
+        totalPages: 0
+    };
+    if (response && 'headers' in response) {
+        const headers = response.headers;
+        if (headers['x-next-page']) {
+            pagination.nextPage = parseInt(headers['x-next-page']);
+        }
+        if (headers['x-page']) {
+            pagination.page = parseInt(headers['x-page']);
+        }
+        if (headers['x-per-page']) {
+            pagination.perPage = parseInt(headers['x-per-page']);
+        }
+        if (headers['x-prev-page']) {
+            pagination.prevPage = parseInt(headers['x-prev-page']);
+        }
+        if (headers['x-total']) {
+            pagination.total = parseInt(headers['x-total']);
+        }
+        if (headers['x-total-pages']) {
+            pagination.totalPages = parseInt(headers['x-total-pages']);
+        }
+    }
+    const items = Array.isArray(response)
+        ? response.map(item => PipelineJobHistoryItemSchema.parse(item))
+        : [];
+    return {
+        items,
+        pagination
+    };
+}
+/**
+ * 手动运行流水线任务
+ * @param organizationId Organization ID（组织ID）
+ * @param pipelineId Pipeline ID（流水线ID）
+ * @param pipelineRunId Pipeline run instance ID（流水线运行ID）
+ * @param jobId Job ID for the pipeline run task（流水线运行任务ID）
+ * @returns Whether the operation was successful
+ */
+export async function executePipelineJobRunFunc(organizationId, pipelineId, pipelineRunId, jobId) {
+    const finalOrgId = await resolveOrganizationId(organizationId);
+    const url = utils.isRegionEdition()
+        ? `/oapi/v1/flow/pipelines/${pipelineId}/pipelineRuns/${pipelineRunId}/jobs/${jobId}/start`
+        : `/oapi/v1/flow/organizations/${finalOrgId}/pipelines/${pipelineId}/pipelineRuns/${pipelineRunId}/jobs/${jobId}/start`;
+    const response = await utils.yunxiaoRequest(url, {
+        method: "POST",
+    });
+    return Boolean(response);
+}
+/**
+ * 查询任务运行日志
+ * @param organizationId Organization ID（组织ID）
+ * @param pipelineId Pipeline ID（流水线ID）
+ * @param pipelineRunId Pipeline run instance ID（流水线运行ID）
+ * @param jobId Job ID of the pipeline run task（流水线运行任务ID）
+ * @returns Log content and metadata
+ */
+export async function getPipelineJobRunLogFunc(organizationId, pipelineId, pipelineRunId, jobId) {
+    const finalOrgId = await resolveOrganizationId(organizationId);
+    const url = utils.isRegionEdition()
+        ? `/oapi/v1/flow/pipelines/${pipelineId}/runs/${pipelineRunId}/job/${jobId}/log`
+        : `/oapi/v1/flow/organizations/${finalOrgId}/pipelines/${pipelineId}/runs/${pipelineRunId}/job/${jobId}/log`;
+    const response = await utils.yunxiaoRequest(url, {
+        method: "GET",
+    });
+    return PipelineJobRunLogSchema.parse(response);
+}

package/dist/operations/flow/resourceMember.js

@@ -0,0 +1,137 @@
+import * as utils from "../../common/utils.js";
+import { resolveOrganizationId } from "../organization/organization.js";
+import { z } from "zod";
+// 定义资源成员的Zod模式
+export const ResourceMemberSchema = z.object({
+    username: z.string().nullable().optional().describe("用户名"),
+    userId: z.string().nullable().optional().describe("用户id"),
+    role: z.string().nullable().optional().describe("用户角色"),
+});
+// 定义API请求参数的Zod模式
+export const ResourceMemberBaseSchema = z.object({
+    organizationId: z.string().describe("企业Id"),
+    resourceType: z.string().describe("资源类型 pipeline 流水线 hostGroup 主机组"),
+    resourceId: z.string().describe("资源Id"),
+});
+export const DeleteResourceMemberSchema = ResourceMemberBaseSchema.extend({
+    userId: z.string().describe("用户Id"),
+});
+export const UpdateResourceMemberSchema = ResourceMemberBaseSchema.extend({
+    roleName: z.string().describe("角色部署组 hostGroup: user(成员，使用权限) admin(管理员，使用编辑权限) 流水线 pipeline: admin(管理员，查看、运行、编辑权限) member(运行权限) viewer(查看权限)"),
+    userId: z.string().describe("用户id"),
+});
+export const CreateResourceMemberSchema = ResourceMemberBaseSchema.extend({
+    roleName: z.string().describe("角色部署组 hostGroup: user(成员，使用权限) admin(管理员，使用编辑权限) owner(拥有者，所有权限)  流水线 pipeline: owner(拥有者，所有权限) admin(管理员，查看、运行、编辑权限) member(运行权限) viewer(查看权限)"),
+    userId: z.string().describe("用户id"),
+});
+export const UpdateResourceOwnerSchema = ResourceMemberBaseSchema.extend({
+    newOwnerId: z.string().describe("新拥有者用户Id"),
+});
+/**
+ * 删除资源成员
+ * @param organizationId 企业Id
+ * @param resourceType 资源类型 pipeline 流水线 hostGroup 主机组
+ * @param resourceId 资源Id
+ * @param userId 用户Id
+ * @returns 是否成功
+ */
+export async function deleteResourceMemberFunc(organizationId, resourceType, resourceId, userId) {
+    const finalOrgId = await resolveOrganizationId(organizationId);
+    const url = utils.isRegionEdition()
+        ? `/oapi/v1/flow/resourceMembers/resourceTypes/${resourceType}/resourceIds/${resourceId}`
+        : `/oapi/v1/flow/organizations/${finalOrgId}/resourceMembers/resourceTypes/${resourceType}/resourceIds/${resourceId}`;
+    const queryParams = { userId };
+    const fullUrl = utils.buildUrl(url, queryParams);
+    const response = await utils.yunxiaoRequest(fullUrl, {
+        method: "DELETE",
+    });
+    return Boolean(response);
+}
+/**
+ * 获取资源成员列表
+ * @param organizationId 企业Id
+ * @param resourceType 资源类型 pipeline 流水线 hostGroup 主机组
+ * @param resourceId 资源Id
+ * @returns 资源成员列表
+ */
+export async function listResourceMembersFunc(organizationId, resourceType, resourceId) {
+    const finalOrgId = await resolveOrganizationId(organizationId);
+    const url = utils.isRegionEdition()
+        ? `/oapi/v1/flow/resourceMembers/resourceTypes/${resourceType}/resourceIds/${resourceId}`
+        : `/oapi/v1/flow/organizations/${finalOrgId}/resourceMembers/resourceTypes/${resourceType}/resourceIds/${resourceId}`;
+    const response = await utils.yunxiaoRequest(url, {
+        method: "GET",
+    });
+    if (Array.isArray(response)) {
+        return response.map(item => ResourceMemberSchema.parse(item));
+    }
+    // 如果响应不是数组，但包含数据，尝试解析单个对象
+    try {
+        return [ResourceMemberSchema.parse(response)];
+    }
+    catch {
+        return [];
+    }
+}
+/**
+ * 更新资源成员
+ * @param organizationId 企业Id
+ * @param resourceType 资源类型 pipeline 流水线 hostGroup 主机组
+ * @param resourceId 资源Id
+ * @param roleName 角色
+ * @param userId 用户id
+ * @returns 是否成功
+ */
+export async function updateResourceMemberFunc(organizationId, resourceType, resourceId, roleName, userId) {
+    const finalOrgId = await resolveOrganizationId(organizationId);
+    const url = utils.isRegionEdition()
+        ? `/oapi/v1/flow/resourceMembers/resourceTypes/${resourceType}/resourceIds/${resourceId}`
+        : `/oapi/v1/flow/organizations/${finalOrgId}/resourceMembers/resourceTypes/${resourceType}/resourceIds/${resourceId}`;
+    const queryParams = { roleName, userId };
+    const fullUrl = utils.buildUrl(url, queryParams);
+    const response = await utils.yunxiaoRequest(fullUrl, {
+        method: "PUT",
+    });
+    return Boolean(response);
+}
+/**
+ * 插入资源成员
+ * @param organizationId 企业Id
+ * @param resourceType 资源类型 pipeline 流水线 hostGroup 主机组
+ * @param resourceId 资源Id
+ * @param roleName 角色
+ * @param userId 用户id
+ * @returns 是否成功
+ */
+export async function createResourceMemberFunc(organizationId, resourceType, resourceId, roleName, userId) {
+    const finalOrgId = await resolveOrganizationId(organizationId);
+    const url = utils.isRegionEdition()
+        ? `/oapi/v1/flow/resourceMembers/resourceTypes/${resourceType}/resourceIds/${resourceId}`
+        : `/oapi/v1/flow/organizations/${finalOrgId}/resourceMembers/resourceTypes/${resourceType}/resourceIds/${resourceId}`;
+    const queryParams = { roleName, userId };
+    const fullUrl = utils.buildUrl(url, queryParams);
+    const response = await utils.yunxiaoRequest(fullUrl, {
+        method: "POST",
+    });
+    return Boolean(response);
+}
+/**
+ * 移交资源对象拥有者
+ * @param organizationId 企业Id
+ * @param resourceType 资源类型 pipeline 流水线 hostGroup 主机组
+ * @param resourceId 资源Id
+ * @param newOwnerId 新拥有者用户Id
+ * @returns 是否成功
+ */
+export async function updateResourceOwnerFunc(organizationId, resourceType, resourceId, newOwnerId) {
+    const finalOrgId = await resolveOrganizationId(organizationId);
+    const url = utils.isRegionEdition()
+        ? `/oapi/v1/flow/resourceMembers/resourceTypes/${resourceType}/resourceIds/${resourceId}/transfer/owner`
+        : `/oapi/v1/flow/organizations/${finalOrgId}/resourceMembers/resourceTypes/${resourceType}/resourceIds/${resourceId}/transfer/owner`;
+    const queryParams = { newOwnerId };
+    const fullUrl = utils.buildUrl(url, queryParams);
+    const response = await utils.yunxiaoRequest(fullUrl, {
+        method: "POST",
+    });
+    return Boolean(response);
+}

package/dist/operations/flow/serviceConnection.js

@@ -0,0 +1,27 @@
+import * as utils from "../../common/utils.js";
+import { resolveOrganizationId } from "../organization/organization.js";
+import { ServiceConnectionSchema } from "./types.js";
+/**
+ * 获取服务连接列表
+ * @param organizationId 组织ID
+ * @param serviceConnectionType 服务连接类型
+ * @returns 服务连接列表
+ */
+export async function listServiceConnectionsFunc(organizationId, serviceConnectionType) {
+    const finalOrgId = await resolveOrganizationId(organizationId);
+    const baseUrl = utils.isRegionEdition()
+        ? `/oapi/v1/flow/serviceConnections`
+        : `/oapi/v1/flow/organizations/${finalOrgId}/serviceConnections`;
+    // 构建查询参数
+    const queryParams = {
+        sericeConnectionType: serviceConnectionType // 注意：API文档中拼写为 sericeConnectionType
+    };
+    const url = utils.buildUrl(baseUrl, queryParams);
+    const response = await utils.yunxiaoRequest(url, {
+        method: "GET",
+    });
+    if (!Array.isArray(response)) {
+        return [];
+    }
+    return response.map(item => ServiceConnectionSchema.parse(item));
+}

package/dist/operations/flow/tag.js

@@ -0,0 +1,191 @@
+import * as utils from "../../common/utils.js";
+import { resolveOrganizationId } from "../organization/organization.js";
+import { z } from "zod";
+// 定义标签和标签分类的Zod模式
+export const TagGroupSchema = z.object({
+    id: z.number().int().nullable().optional().describe("标签分类 id"),
+    name: z.string().nullable().optional().describe("标签分类名称"),
+    creatorAccountId: z.string().nullable().optional().describe("创建人"),
+    modifierAccountId: z.string().nullable().optional().describe("更新人"),
+});
+export const TagSchema = z.object({
+    id: z.number().int().nullable().optional().describe("标签 id"),
+    name: z.string().nullable().optional().describe("标签名称"),
+    color: z.string().nullable().optional().describe("标签颜色"),
+    creatorAccountId: z.string().nullable().optional().describe("创建人"),
+    modifierAccountId: z.string().nullable().optional().describe("更新人"),
+});
+export const TagGroupWithTagsSchema = TagGroupSchema.extend({
+    flowTagList: z.array(TagSchema).nullable().optional().describe("标签列表"),
+});
+// 定义API请求参数的Zod模式
+export const BaseTagSchema = z.object({
+    organizationId: z.string().describe("企业Id"),
+});
+export const CreateTagSchema = BaseTagSchema.extend({
+    name: z.string().describe("标签名称"),
+    color: z.string().describe("#1F9AEF 蓝色; #E63A3A 红色; #FA8C15 黄色; #15AD31 绿色; #7978E5 紫色; #8C8C8C 灰色"),
+    flowTagGroupId: z.number().int().describe("标签分类 id"),
+});
+export const CreateTagGroupSchema = BaseTagSchema.extend({
+    name: z.string().describe("标签分类名称"),
+});
+export const DeleteTagGroupSchema = BaseTagSchema.extend({
+    id: z.number().int().describe("标签分类 id"),
+});
+export const UpdateTagGroupSchema = DeleteTagGroupSchema.extend({
+    name: z.string().describe("标签分类名称"),
+});
+export const DeleteTagSchema = BaseTagSchema.extend({
+    id: z.number().int().describe("标签 id"),
+});
+export const UpdateTagSchema = DeleteTagSchema.extend({
+    name: z.string().describe("标签名称"),
+    color: z.string().describe("#1F9AEF 蓝色; #E63A3A 红色; #FA8C15 黄色; #15AD31 绿色; #7978E5 紫色; #8C8C8C 灰色"),
+    flowTagGroupId: z.number().int().describe("标签分类 id"),
+});
+export const GetTagGroupSchema = DeleteTagGroupSchema;
+/**
+ * 创建标签
+ * @param organizationId 企业Id
+ * @param name 标签名称
+ * @param color 标签颜色
+ * @param flowTagGroupId 标签分类 id
+ * @returns 标签 id
+ */
+export async function createTagFunc(organizationId, name, color, flowTagGroupId) {
+    const finalOrgId = await resolveOrganizationId(organizationId);
+    const url = utils.isRegionEdition()
+        ? `/oapi/v1/flow/tags`
+        : `/oapi/v1/flow/organizations/${finalOrgId}/tags`;
+    const queryParams = { name, color, flowTagGroupId };
+    const fullUrl = utils.buildUrl(url, queryParams);
+    const response = await utils.yunxiaoRequest(fullUrl, {
+        method: "POST",
+    });
+    return Number(response);
+}
+/**
+ * 创建标签分类
+ * @param organizationId 企业Id
+ * @param name 标签分类名称
+ * @returns 标签分类 id
+ */
+export async function createTagGroupFunc(organizationId, name) {
+    const finalOrgId = await resolveOrganizationId(organizationId);
+    const url = utils.isRegionEdition()
+        ? `/oapi/v1/flow/tagGroups`
+        : `/oapi/v1/flow/organizations/${finalOrgId}/tagGroups`;
+    const queryParams = { name };
+    const fullUrl = utils.buildUrl(url, queryParams);
+    const response = await utils.yunxiaoRequest(fullUrl, {
+        method: "POST",
+    });
+    return Number(response);
+}
+/**
+ * 获取流水线分类列表
+ * @param organizationId 企业Id
+ * @returns 流水线分类列表
+ */
+export async function listTagGroupsFunc(organizationId) {
+    const finalOrgId = await resolveOrganizationId(organizationId);
+    const url = utils.isRegionEdition()
+        ? `/oapi/v1/flow/tagGroups`
+        : `/oapi/v1/flow/organizations/${finalOrgId}/tagGroups`;
+    const response = await utils.yunxiaoRequest(url, {
+        method: "GET",
+    });
+    if (Array.isArray(response)) {
+        return response.map(item => TagGroupSchema.parse(item));
+    }
+    return [];
+}
+/**
+ * 删除标签分类
+ * @param organizationId 企业Id
+ * @param id 标签分类 id
+ * @returns 是否成功
+ */
+export async function deleteTagGroupFunc(organizationId, id) {
+    const finalOrgId = await resolveOrganizationId(organizationId);
+    const url = utils.isRegionEdition()
+        ? `/oapi/v1/flow/tagGroups/${id}`
+        : `/oapi/v1/flow/organizations/${finalOrgId}/tagGroups/${id}`;
+    const response = await utils.yunxiaoRequest(url, {
+        method: "DELETE",
+    });
+    return Boolean(response);
+}
+/**
+ * 更新标签分类
+ * @param organizationId 企业Id
+ * @param id 标签分类 id
+ * @param name 标签分类名称
+ * @returns 是否成功
+ */
+export async function updateTagGroupFunc(organizationId, id, name) {
+    const finalOrgId = await resolveOrganizationId(organizationId);
+    const url = utils.isRegionEdition()
+        ? `/oapi/v1/flow/tagGroups/${id}`
+        : `/oapi/v1/flow/organizations/${finalOrgId}/tagGroups/${id}`;
+    const queryParams = { name };
+    const fullUrl = utils.buildUrl(url, queryParams);
+    const response = await utils.yunxiaoRequest(fullUrl, {
+        method: "PUT",
+    });
+    return Boolean(response);
+}
+/**
+ * 获取标签分类
+ * @param organizationId 企业Id
+ * @param id 标签分类 id
+ * @returns 标签分类
+ */
+export async function getTagGroupFunc(organizationId, id) {
+    const finalOrgId = await resolveOrganizationId(organizationId);
+    const url = utils.isRegionEdition()
+        ? `/oapi/v1/flow/tagGroups/${id}`
+        : `/oapi/v1/flow/organizations/${finalOrgId}/tagGroups/${id}`;
+    const response = await utils.yunxiaoRequest(url, {
+        method: "GET",
+    });
+    return TagGroupWithTagsSchema.parse(response);
+}
+/**
+ * 删除标签
+ * @param organizationId 企业Id
+ * @param id 标签 id
+ * @returns 是否成功
+ */
+export async function deleteTagFunc(organizationId, id) {
+    const finalOrgId = await resolveOrganizationId(organizationId);
+    const url = utils.isRegionEdition()
+        ? `/oapi/v1/flow/tags/${id}`
+        : `/oapi/v1/flow/organizations/${finalOrgId}/tags/${id}`;
+    const response = await utils.yunxiaoRequest(url, {
+        method: "DELETE",
+    });
+    return Boolean(response);
+}
+/**
+ * 更新标签
+ * @param organizationId 企业Id
+ * @param id 标签 id
+ * @param name 标签名称
+ * @param color 标签颜色
+ * @param flowTagGroupId 标签分类 id
+ * @returns 是否成功
+ */
+export async function updateTagFunc(organizationId, id, name, color, flowTagGroupId) {
+    const finalOrgId = await resolveOrganizationId(organizationId);
+    const url = utils.isRegionEdition()
+        ? `/oapi/v1/flow/tags/${id}`
+        : `/oapi/v1/flow/organizations/${finalOrgId}/tags/${id}`;
+    const queryParams = { name, color, flowTagGroupId };
+    const fullUrl = utils.buildUrl(url, queryParams);
+    const response = await utils.yunxiaoRequest(fullUrl, {
+        method: "PUT",
+    });
+    return Boolean(response);
+}