# Alibaba Cloud Devops 2020 API > Alibaba Cloud Devops 2020 API on Apizie: 242 endpoints (Adds one or more members to a group, Adds relations to a pipeline, Add members to a code repository, using the Alibaba Cloud account ID (aliyunPk) as the identity. You can…, Create a code repository Webhook, …) returned as clean JSON through one API key. Send your own provider key in the x-upstream-key header. Call it over REST at https://zieapi.vercel.app/v1/cloud:aliyun-devops/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month. - Project key: `cloud:aliyun-devops` - Category: Cloud - Status: byok - Source: https://api.alibabacloud.com/product/devops - Page: https://zieapi.vercel.app/api/cloud/aliyun-devops - OpenAPI: https://zieapi.vercel.app/api/cloud/aliyun-devops/openapi.json Alibaba Cloud OpenAPI for Devops 2020 (devops, version 2021-06-25). Calls are signed with ACS3-HMAC-SHA256 using your AccessKey ID and secret. ## Endpoints ### Adds one or more members to a group `POST https://zieapi.vercel.app/v1/cloud:aliyun-devops/add-group-member` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://devops.cn-hangzhou.aliyuncs.com | | organizationId | string | yes | The organization ID. You can find the organization ID in your organization's URL on Alibaba Cloud DevOps. For example,… | | accessToken | string | no | The personal access token. This parameter is optional if you authenticate using an Alibaba Cloud AccessKey pair or Security Token Service… | | groupId | string | yes | The ID of the group | | accessLevel | integer | yes | The access level of the member. Valid values: `20`: reporter `30`: developer `40`: maintainer | | aliyunPks | string | yes | The Alibaba Cloud account ID of the group member. To add multiple members, separate the IDs with commas (,) | ### Adds relations to a pipeline `POST https://zieapi.vercel.app/v1/cloud:aliyun-devops/add-pipeline-relations` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://devops.cn-hangzhou.aliyuncs.com | | organizationId | string | yes | The ID of the organization. You can obtain this ID from the URL of your organization in Alibaba Cloud DevOps, for example,… | | pipelineId | string | yes | The ID of the pipeline. You can obtain this ID from the pipeline URL, for example, `https://flow.aliyun.com/pipelines/{PipelineId}/current` | | relObjectType | string | yes | The type of the related resource. The only value currently supported is `VARIABLE_GROUP`, which represents a variable group | | relObjectIds | string | yes | The IDs of the related resources. This parameter currently accepts only the IDs of variable groups. To specify multiple IDs, separate them… | ### Add members to a code repository, using the Alibaba Cloud account ID (aliyunPk) as the identity. You can… `POST https://zieapi.vercel.app/v1/cloud:aliyun-devops/add-repository-member` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://devops.cn-hangzhou.aliyuncs.com | | organizationId | string | yes | Organization identity, also known as organization ID, in string format. It can be obtained from the Alibaba Cloud DevOps access link, for… | | repositoryId | string | yes | Code repository ID | | accessLevel | integer | yes | Member permission | | aliyunPks | string | yes | Alibaba Cloud IDs of users to be added as code repository members. Multiple IDs are supported and must be separated by commas (",") | | accessToken | string | no | Personal access token. This field is not required when using Alibaba Cloud AccessKey ID and AccessKey Secret (AK+SK) or Security Token… | ### Create a code repository Webhook `POST https://zieapi.vercel.app/v1/cloud:aliyun-devops/add-webhook` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://devops.cn-hangzhou.aliyuncs.com | | organizationId | string | yes | Organization identity, also known as organization ID, in string format. It can be obtained from the Alibaba Cloud DevOps access URL, for… | | accessToken | string | no | Personal access token. This field is not required if you use Alibaba Cloud AccessKey ID and AccessKey Secret or Security Token Service… | | repositoryId | string | yes | Code repository ID | | description | string | no | Webhook description | | enableSslVerification | string | no | Use SSL authentication Valid values: true / false | | mergeRequestsEvents | string | no | Indicates whether to subscribe to merge request events. Valid values: true / false | | noteEvents | string | no | Whether to subscribe to comment management events Valid values: true / false | | pushEvents | string | no | Indicates whether to subscribe to branch push events. Valid values: true / false | | secretToken | string | no | Token used to authenticate identity, custom-defined by the User | | tagPushEvents | string | no | Indicates whether to subscribe to tag push events. Valid values: true / false | | url | string | yes | Webhook Link URL | ### Cancels a specific execution of a release stage `POST https://zieapi.vercel.app/v1/cloud:aliyun-devops/cancel-execution-release-stage` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://devops.cn-hangzhou.aliyuncs.com | | organizationId | string | no | The organization ID | | appName | string | yes | The application name | | releaseWorkflowSn | string | yes | The serial number of the release workflow | | releaseStageSn | string | yes | The serial number of the release stage | | executionNumber | string | yes | The execution number of the release stage | ### Closes a specified merge request `POST https://zieapi.vercel.app/v1/cloud:aliyun-devops/close-merge-request` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://devops.cn-hangzhou.aliyuncs.com | | organizationId | string | yes | The ID of the organization. You can find this ID in the URL of your organization page on Alibaba Cloud DevOps, for example:… | | accessToken | string | no | The personal access token. Not required if you authenticate with an Alibaba Cloud AccessKey pair or Security Token Service (STS) | | repositoryId | string | yes | The ID of the repository | | localId | string | yes | The local ID of the merge request, which is its number within the repository | ### Adds members to an application `POST https://zieapi.vercel.app/v1/cloud:aliyun-devops/create-app-members` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://devops.cn-hangzhou.aliyuncs.com | | organizationId | string | no | The organization ID | | appName | string | yes | The application name | | playerList | array | no | The members to add | | roleNames | array | no | The roles to assign to the new members | ### Create a code repository branch `POST https://zieapi.vercel.app/v1/cloud:aliyun-devops/create-branch` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://devops.cn-hangzhou.aliyuncs.com | | organizationId | string | yes | Organization identity, also known as organization ID, in string format. It can be obtained from the Alibaba Cloud DevOps access link, such… | | accessToken | string | no | Personal access token. This field is not required if you use Alibaba Cloud AccessKey ID and AccessKey Secret or Security Token Service… | | repositoryId | string | yes | Code repository ID | | branchName | string | yes | Branch name | | ref | string | yes | Source branch, indicating the branch from which a new branch is created | ### Create an application deployment `POST https://zieapi.vercel.app/v1/cloud:aliyun-devops/create-change-request` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://devops.cn-hangzhou.aliyuncs.com | | organizationId | string | no | The organization ID | | appName | string | yes | The application name | | appCodeRepoSn | string | yes | The ID of the application code repository | | autoDeleteBranchWhenEnd | string | no | Specifies whether to automatically delete the branch upon completion of the change | | branchName | string | yes | The branch name | | createBranch | string | no | Specifies whether to create a new branch | | ownerAccountId | string | no | The owner's Alibaba Cloud account ID | | ownerId | string | yes | ownerId | | title | string | yes | The title of the change request | ### Creates a check run record only `POST https://zieapi.vercel.app/v1/cloud:aliyun-devops/create-check-run` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://devops.cn-hangzhou.aliyuncs.com | | organizationId | string | yes | The organization ID. You can get the organization ID from the URL in Alibaba Cloud DevOps. Example:… | | accessToken | string | no | The personal access token. This parameter is optional if you use an AccessKey or STS temporary authorization for authentication | | repositoryIdentity | string | yes | The ID or full path of the repository | | annotations | array | no | A list of annotations. If your external system produces code quality check results, you can provide them here. The results are displayed… | | completedAt | string | no | The time the check run completed. The time must be in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ. Example: 2023-03-15T08:00:00Z | | conclusion | string | no | The conclusion of the check run. Valid values: `cancelled`: Cancelled `failure`: Failure `neutral`: Neutral. This is a success state.… | | detailsUrl | string | no | The URL to a page on an external system with full details about the check run. The platform provides a link to this URL | | externalId | string | no | The ID from an external system. An external system refers to your own check system. Use this field to store an identifier from that… | | headSha | string | yes | The commit SHA. This commit must be at the head of a branch that is the source of a merge request | | name | string | yes | The name of the check run. The name must be unique for a given repository, commit ID, and author. The maximum length is 50 characters | | output | object | no | The display information for the check run | | startedAt | string | no | The time the check run started. The time must be in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ. Example: 2023-03-15T08:00:00Z | | status | string | no | The status of the check run. Valid values: `queued`: Queued `in_progress`: In progress `completed`: Completed | ### You can add overall and inline comments to a merge request. As a best practice, limit comment threads to a… `POST https://zieapi.vercel.app/v1/cloud:aliyun-devops/create-comment` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://devops.cn-hangzhou.aliyuncs.com | | organizationId | string | yes | The ID of the organization. You can find this ID in the URL for your organization in Alibaba Cloud DevOps. The URL is in the format… | | accessToken | string | no | The personal access token. This parameter is not required if you use an AccessKey pair or a Security Token Service (STS) token for… | | repositoryIdentity | string | yes | The ID or full path of the repository | | localId | integer | yes | The sequential ID of the merge request within the repository | | commentType | string | yes | The comment type. Valid values: `GLOBAL_COMMENT`: A comment on the entire merge request. `INLINE_COMMENT`: A comment on a specific line of… | | content | string | yes | The comment content | | draft | string | no | Indicates whether the comment is a draft | | filePath | string | no | The file path. This parameter is required if `commentType` is `INLINE_COMMENT` | | fromPachSetBizId | string | no | The ID of the source patch set for comparison. This parameter is required if `commentType` is `INLINE_COMMENT`.> This value is required… | | lineNumber | integer | no | The line number in the file for an inline comment | | parentCommentBizId | string | no | The business ID of the parent comment | | patchSetBizId | string | no | The ID of the patch set associated with the merge request. This parameter is required if `commentType` is `INLINE_COMMENT`.> | | resolved | string | no | Indicates whether the comment is resolved. This parameter is required when creating a root comment (when `parentCommentBizId` is empty). | | toPatchSetBizId | string | no | The ID of the target patch set for comparison. This parameter is required if `commentType` is `INLINE_COMMENT`.> This value is required if… | ### Adds a commit status record for a specified commit `POST https://zieapi.vercel.app/v1/cloud:aliyun-devops/create-commit-status` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://devops.cn-hangzhou.aliyuncs.com | | organizationId | string | yes | The organization ID. You can find the organization ID in your Alibaba Cloud DevOps URL, for example,… | | accessToken | string | no | The personal access token. This parameter is not required if you use an Alibaba Cloud AccessKey pair or a Security Token Service (STS)… | | repositoryIdentity | string | yes | The ID or full path of the repository | | sha | string | yes | The commit SHA | | context | string | no | A string identifier to differentiate statuses from different systems. The UI displays it as a title. The default value is "default". The… | | description | string | no | A short description of the commit status. The description cannot exceed 3,000 characters | | state | string | yes | The state of the commit status. The API returns an error if you provide any value other than the following: error failure pending success | | targetUrl | string | no | A URL to associate with this status. The UI links to this URL, which typically points to a third-party system | ### Use this API to commit changes to multiple files, a common development scenario `POST https://zieapi.vercel.app/v1/cloud:aliyun-devops/create-commit-with-multiple-files` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://devops.cn-hangzhou.aliyuncs.com | | organizationId | string | yes | The ID of the organization. You can obtain this ID from the Alibaba Cloud DevOps URL, for example,… | | accessToken | string | no | The personal access token. This parameter is not required if you use an Alibaba Cloud AccessKey pair or STS temporary credentials for… | | repositoryIdentity | string | yes | The ID or full path of the repository | | actions | array | yes | An array of objects, where each object defines a file operation | | branch | string | yes | The name of the branch | | commitMessage | string | no | The commit message | ### Creates a new deploy key in a repository `POST https://zieapi.vercel.app/v1/cloud:aliyun-devops/create-deploy-key` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://devops.cn-hangzhou.aliyuncs.com | | organizationId | string | yes | The ID of the organization. You can find this ID in your Alibaba Cloud DevOps URL, which is formatted as… | | accessToken | string | no | The personal access token. This parameter is optional when authorizing with an AccessKey pair or Security Token Service (STS) | | repositoryId | string | yes | The ID of the repository | | key | string | yes | The content of the deploy key. A deploy key cannot be the same as an SSH key. For more information, see… | | title | string | yes | The title of the deploy key | ### Create a file in the code repository `POST https://zieapi.vercel.app/v1/cloud:aliyun-devops/create-file` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://devops.cn-hangzhou.aliyuncs.com | | organizationId | string | yes | Organization identity, also known as organization ID, in string format. You can obtain it from the Alibaba Cloud DevOps access link, such… | | accessToken | string | no | Personal access token. This field is not required if you use an Alibaba Cloud AccessKey pair (AK+SK) or temporary authorization through… | | repositoryId | string | yes | Code repository ID | | branchName | string | yes | Branch where the file resides | | commitMessage | string | yes | Commit message when creating the file | | content | string | yes | File content | | encoding | string | no | Codec. Optional: text or base64. Default value is text | | filePath | string | yes | File Path | ### Create a tag `POST https://zieapi.vercel.app/v1/cloud:aliyun-devops/create-flow-tag` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://devops.cn-hangzhou.aliyuncs.com | | organizationId | string | yes | Organization identity, also known as organization ID, in string format. It can be obtained from the Alibaba Cloud DevOps access link, such… | | name | string | yes | Tag Name, with a maximum length of 20 characters | | color | string | yes | #1F9AEF Blue #E63A3A Red #FA8C15 Yellow #15AD31 Green #7978E5 Purple #8C8C8C Gray | | flowTagGroupId | integer | yes | Tag categorization ID. A value of 0 indicates uncategorized | ### Create tag categorization `POST https://zieapi.vercel.app/v1/cloud:aliyun-devops/create-flow-tag-group` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://devops.cn-hangzhou.aliyuncs.com | | organizationId | string | yes | Organization identity, also known as organization ID, in string format. It can be obtained from the Alibaba Cloud DevOps access link, such… | | name | string | yes | Tag categorization name. It must be unique and contain at most 20 characters | ### You can create a host group `POST https://zieapi.vercel.app/v1/cloud:aliyun-devops/create-host-group` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://devops.cn-hangzhou.aliyuncs.com | | organizationId | string | yes | Organization identity, also known as organization ID, in string format. It can be obtained from the Alibaba Cloud DevOps access URL, for… | | type | string | yes | Host group type. Only ECS is supported for now | | envId | string | no | Environment ID | | name | string | yes | Host group name | | serviceConnectionId | integer | yes | Service connection ID | | tagIds | string | no | Tag IDs, separated by commas if multiple | | ecsType | string | no | ECS type. Only ECS_ALIYUN is supported for now | | ecsLabelKey | string | no | ECS label key | | ecsLabelValue | string | no | ECS label value | | aliyunRegion | string | no | Alibaba Cloud region | | machineInfos | string | no | aliyunRegionId: the Alibaba Cloud region where the machine is located; machineSn: the serial number of the machine; instanceName:… | ### Create a merge request `POST https://zieapi.vercel.app/v1/cloud:aliyun-devops/create-merge-request` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://devops.cn-hangzhou.aliyuncs.com | | organizationId | string | yes | The organization ID. You can find this ID in the URL for your Alibaba Cloud DevOps organization, for example,… | | accessToken | string | no | The personal access token. This parameter is not required if you authenticate by using an Alibaba Cloud AccessKey pair or Security Token… | | repositoryId | string | yes | The repository ID | | createFrom | string | yes | The source of the request. The value must be `WEB` | | description | string | no | The description of the merge request | | reviewerIds | array | no | The Alibaba Cloud account IDs of the reviewers | | sourceBranch | string | yes | The name of the source branch | | sourceProjectId | integer | yes | The ID of the source repository | | targetBranch | string | yes | The name of the target branch | | targetProjectId | integer | yes | The ID of the target repository | | title | string | yes | The title of the merge request | | workItemIds | string | no | A comma-separated string of work item IDs to associate with the merge request | ### Create an OAuthToken (This API is in internal testing and is not supported for use yet) `POST https://zieapi.vercel.app/v1/cloud:aliyun-devops/create-oauth-token` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://devops.cn-hangzhou.aliyuncs.com | | clientId | string | yes | clientId | | clientSecret | string | yes | client_secret | | code | string | no | Authorization code. Required when grantType=code | | grantType | string | yes | Authorization type: code, token | | login | string | no | The User's logon Account. Required when grant type is token | | scope | string | yes | Authorization scope Examples: User-related: read:user Repository-related: read:repo, write:repo Repository merge request-related: repo:cr,… | ### Creates a pipeline based on a YAML definition `POST https://zieapi.vercel.app/v1/cloud:aliyun-devops/create-pipeline` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://devops.cn-hangzhou.aliyuncs.com | | organizationId | string | yes | The ID of the organization. You can find this ID in the organization URL in Alibaba Cloud DevOps, for example:… | | name | string | yes | The name of the pipeline | | content | string | yes | The pipeline definition in YAML format. For syntax details, see https\://help.aliyun.com/document_detail/2249317.html | ### Create a pipeline group `POST https://zieapi.vercel.app/v1/cloud:aliyun-devops/create-pipeline-group` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://devops.cn-hangzhou.aliyuncs.com | | organizationId | string | yes | Organization identity, also known as organization ID, in string format. It can be obtained from the Alibaba Cloud DevOps access link, such… | | name | string | yes | Pipeline group name, unique within the organization | ### You can create a project `POST https://zieapi.vercel.app/v1/cloud:aliyun-devops/create-project` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://devops.cn-hangzhou.aliyuncs.com | | organizationId | string | yes | Organization identifier, also known as organization ID, in string format. It can be obtained from the Alibaba Cloud DevOps access URL, for… | | customCode | string | yes | Project code, consisting of four to six uppercase letters, unique within the organization | | name | string | yes | Project name | | scope | string | yes | Public: public Private: private | | templateIdentifier | string | yes | Project template ID, which can be obtained from the frontend project template list page. Frontend API:… | ### Creates a label for a repository `POST https://zieapi.vercel.app/v1/cloud:aliyun-devops/create-project-label` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://devops.cn-hangzhou.aliyuncs.com | | organizationId | string | yes | The organization ID. You can find this ID in the URL of your Alibaba Cloud DevOps page, for example:… | | accessToken | string | no | The personal access token. This parameter is not required if you use an Alibaba Cloud AK/SK or STS temporary authorization for… | | repositoryIdentity | string | yes | The repository ID or full path | | color | string | yes | The color of the label in hexadecimal format | | description | string | no | The description of the label | | name | string | yes | The name of the label | ### Create a protected branch `POST https://zieapi.vercel.app/v1/cloud:aliyun-devops/create-protectd-branch` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://devops.cn-hangzhou.aliyuncs.com | | organizationId | string | yes | The unique ID of the organization. You can find this ID in your browser's URL after logging in to the Alibaba Cloud DevOps platform:… | | accessToken | string | no | The personal access token. This parameter is not required if you use an Alibaba Cloud AccessKey pair or a Security Token Service (STS)… | | repositoryId | string | yes | The ID of the repository | | allowMergeRoles | array | yes | The IDs of roles allowed to merge code | | allowMergeUserIds | array | no | The IDs of users allowed to merge code | | allowPushRoles | array | no | The IDs of roles allowed to push code | | allowPushUserIds | array | no | The IDs of users allowed to push code | | branch | string | yes | The name of the protected branch | | id | integer | no | The ID of the protected branch rule | | mergeRequestSetting | object | no | The settings for code reviews before a merge | | testSettingDTO | object | no | The settings for automated status checks before a merge | ### Create a push rule `POST https://zieapi.vercel.app/v1/cloud:aliyun-devops/create-push-rule` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://devops.cn-hangzhou.aliyuncs.com | | organizationId | string | yes | The organization ID. You can get this ID from your Alibaba Cloud DevOps URL, for example:… | | accessToken | string | no | The personal access token. This parameter is not required if you authenticate by using an Alibaba Cloud AccessKey pair or STS temporary… | | repositoryId | string | yes | The repository ID | | ruleInfos | array | yes | A list of rule objects | ### Create or import a code repository. `POST https://zieapi.vercel.app/v1/cloud:aliyun-devops/create-repository` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://devops.cn-hangzhou.aliyuncs.com | | accessToken | string | no | Personal access token. This field is not required when using Alibaba Cloud AccessKey ID and AccessKey Secret (AK+SK) or Security Token… | | sync | string | no | Whether to execute repository Creation synchronously Valid values: true / false | | createParentPath | string | no | Whether to create the parent folder. Valid values: true / false | | organizationId | string | yes | Organization identifier, also known as organization ID, in string format. It can be obtained from the Alibaba Cloud DevOps URL, for… | | avatarUrl | string | no | URL of the repository profile picture | | description | string | no | Description of the repository | | gitignoreType | string | no | Type of gitignore template | | importAccount | string | no | Account used for import | | importDemoProject | string | no | Whether to import a Sample project Valid values: true / false | | importRepoType | string | no | Type of repository to import: GIT – Git repository SVN – SVN repository | | importToken | string | no | Account token used during import | | importTokenEncrypted | string | no | Transmission format of the importToken field, using plaintext or RSA encryption Valid values: text (plaintext) / rsa (RSA encryption) | | importUrl | string | no | URL of the repository to be imported (HTTP protocol), such as a GitHub repository URL | | initStandardService | string | no | Initialize standard Intelligent service. Valid values: true / false | | isCryptoEnabled | string | no | Whether encryption is enabled Valid values: true / false | | localImportUrl | string | no | Remote URL of the locally imported code repository | | name | string | yes | Name of the repository | | namespaceId | integer | no | ID of the parent path of the repository | | path | string | no | Path of the repository | | readmeType | string | no | Type of automatically created README file: EMPTY – Create only README.md USER_GUIDE – Include beginner guidance | | visibilityLevel | integer | no | Visibility level of the code repository 0 – private, visible only to repository members 10 – internal to the enterprise, visible to… | ### Create a code group `POST https://zieapi.vercel.app/v1/cloud:aliyun-devops/create-repository-group` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://devops.cn-hangzhou.aliyuncs.com | | organizationId | string | yes | The organization ID is a string that you can obtain from the Alibaba Cloud DevOps URL, such as… | | accessToken | string | no | The personal access token. This parameter is not required if you authenticate using an Alibaba Cloud access key pair or Security Token… | | avatarUrl | string | no | The URL of the avatar for the repository group | | description | string | no | The description of the repository group | | name | string | yes | The name of the repository group | | parentId | integer | yes | The parent ID. If this parameter is omitted, the repository group is created at the root level | | path | string | yes | The path of the repository group | | visibilityLevel | integer | yes | The visibility level of the repository group. `0`: private `10`: internal | ### You can insert resource members `POST https://zieapi.vercel.app/v1/cloud:aliyun-devops/create-resource-member` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://devops.cn-hangzhou.aliyuncs.com | | organizationId | string | yes | Organization identity, also known as organization ID, in string format. You can obtain it from the Alibaba Cloud DevOps access link, such… | | resourceType | string | yes | Resource type: pipeline (pipeline) or hostGroup (host group) | | accountId | string | yes | Alibaba Cloud account ID | | roleName | string | yes | Role For deployment group (hostGroup): user: member with usage permission admin: administrator with edit permission owner: owner with all… | | resourceId | string | yes | Resource ID | ### Creates a service authorization `POST https://zieapi.vercel.app/v1/cloud:aliyun-devops/create-service-auth` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://devops.cn-hangzhou.aliyuncs.com | | organizationId | string | yes | The organization ID, also referred to as the enterprise ID. This is a string value that you can obtain from the China Cloud DevOps access… | | serviceAuthType | string | yes | The service authorization type. Currently, only RAM is supported | ### Creates a service connection `POST https://zieapi.vercel.app/v1/cloud:aliyun-devops/create-service-connection` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://devops.cn-hangzhou.aliyuncs.com | | organizationId | string | yes | The organization identifier, also known as the organization ID. This is a string value that can be obtained from the China Cloud Effect… | | authType | string | yes | The service authorization type | | connectionName | string | yes | The name of the service connection | | connectionType | string | yes | The type of the service connection | | scope | string | yes | The visibility scope. Valid values: PERSON, GLOBAL, and CUSTOM | | serviceAuthId | integer | yes | The service authorization ID | ### Creates a username-and-password service credential `POST https://zieapi.vercel.app/v1/cloud:aliyun-devops/create-service-credential` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://devops.cn-hangzhou.aliyuncs.com | | organizationId | string | yes | The organization ID. You can get this ID from the URL of your organization page in Alibaba Cloud DevOps. For example:… | | name | string | yes | The service credential name | | password | string | yes | The password | | scope | string | no | The scope of the credential. For example, `PERSON` | | type | string | yes | The service credential type. The default value is `USERNAME_PASSWORD` | | username | string | yes | The username | ### You can create an iteration for a project `POST https://zieapi.vercel.app/v1/cloud:aliyun-devops/create-sprint` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://devops.cn-hangzhou.aliyuncs.com | | organizationId | string | yes | Organization identity, also known as organization ID, in string format. It can be obtained from the Alibaba Cloud DevOps access URL, such… | | endDate | string | no | End Time | | name | string | yes | Iteration name | | spaceIdentifier | string | yes | Project ID, which has the same meaning as projectId | | staffIds | array | yes | List of owners | | startDate | string | no | Start Time | ### You can create an enterprise public key `POST https://zieapi.vercel.app/v1/cloud:aliyun-devops/create-ssh-key` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://devops.cn-hangzhou.aliyuncs.com | | organizationId | string | yes | Enterprise identity, also known as enterprise ID, in string format. It can be obtained from the Alibaba Cloud DevOps access link, such as… | ### Tag a code repository `POST https://zieapi.vercel.app/v1/cloud:aliyun-devops/create-tag` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://devops.cn-hangzhou.aliyuncs.com | | organizationId | string | yes | The organization ID. You can find this ID in your Alibaba Cloud DevOps URL, for example:… | | accessToken | string | no | The personal access token. This is not required when authenticating with an Alibaba Cloud AccessKey pair (AK/SK) or temporary credentials… | | repositoryId | string | yes | The ID of the repository | | message | string | no | The message for the tag | | ref | string | yes | The reference from which the tag is created. This can be a branch name, another tag, or a commit SHA | | tagName | string | yes | The tag name | ### Create a test case in the use case library `POST https://zieapi.vercel.app/v1/cloud:aliyun-devops/create-test-case` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://devops.cn-hangzhou.aliyuncs.com | | organizationId | string | yes | Get the organization ID from the URL of your Alibaba Cloud DevOps page, for example:… | | assignedTo | string | yes | The ID of the assignee | | directoryIdentifier | string | yes | The ID of the directory | | fieldValueList | array | no | A list of custom fields | | priority | string | no | The priority of the test case | | spaceIdentifier | string | yes | The ID of the test case library | | subject | string | yes | The title of the test case | | tags | array | no | A list of tag IDs | | testcaseStepContentInfo | object | no | Contains the details of the test case steps | ### Creates an SSH key for the current user `POST https://zieapi.vercel.app/v1/cloud:aliyun-devops/create-user-key` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://devops.cn-hangzhou.aliyuncs.com | | organizationId | string | yes | The organization ID. You can get this ID from your organization's URL in Alibaba Cloud DevOps, for example,… | | accessToken | string | no | The personal access token. This parameter is not required when you authenticate by using an Alibaba Cloud AccessKey pair (AK/SK) or a… | | expireTime | string | no | The expiration time | | keyScope | string | yes | The scope of the key. Valid values: ALL and READ. ALL: Allows read and write operations, including clone, pull, and push. READ: Allows… | | publicKey | string | yes | The content of the public key | | title | string | yes | The title of the SSH key | ### You can create a variable group `POST https://zieapi.vercel.app/v1/cloud:aliyun-devops/create-variable-group` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://devops.cn-hangzhou.aliyuncs.com | | organizationId | string | yes | Organization identity, also known as organization ID, in string format. It can be obtained from the Alibaba Cloud DevOps access link, such… | | name | string | yes | Variable group name | | description | string | no | Variable group description | | variables | string | yes | JSON string containing variable information: isEncrypted (whether encrypted), name (variable name), and value (variable value) | ### Create a work item `POST https://zieapi.vercel.app/v1/cloud:aliyun-devops/create-workitem` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://devops.cn-hangzhou.aliyuncs.com | | organizationId | string | yes | Organization identifier, also known as organization ID, in string format. It can be obtained from the Alibaba Cloud DevOps access URL, for… | | assignedTo | string | yes | The account ID of the work item owner, or the username within the enterprise | | category | string | yes | Type ID of the work item, such as the ID corresponding to Bug or Task | | description | string | no | Work item content | | descriptionFormat | string | no | Content format. Supports RICHTEXT and MARKDOWN formats. The default is RICHTEXT | | fieldValueList | array | no | Custom Fields | | parent | string | no | UUID of the parent work item | | participant | array | no | Account ID of a participant | | space | string | yes | Unique identifier of the project, equivalent to projectId | | spaceIdentifier | string | yes | Same as the space field; UUID of the project ID | | spaceType | string | yes | Resource type | | sprint | array | no | Iteration to associate | | subject | string | yes | Work item title | | tracker | array | no | Account ID of a carbon copy recipient | | verifier | array | no | Account ID of a verifier | | workitemType | string | yes | Work item subtype ID | ### Create a work item comment `POST https://zieapi.vercel.app/v1/cloud:aliyun-devops/create-workitem-comment` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://devops.cn-hangzhou.aliyuncs.com | | organizationId | string | yes | Organization identity, also known as organization ID, in string format. It can be obtained from the Alibaba Cloud DevOps access link, for… | | content | string | yes | Comment content | | formatType | string | yes | Currently supports either RICHTEXT or MARKDOWN | | parentId | string | no | Parent folder ID. Pass 0 for the root directory. | | workitemIdentifier | string | yes | Work item ID, same as workItemId, which is the UUID of the work item | ### Create an API to register the estimated hours for a work item `POST https://zieapi.vercel.app/v1/cloud:aliyun-devops/create-workitem-estimate` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://devops.cn-hangzhou.aliyuncs.com | | organizationId | string | yes | Organization identifier, also known as organization ID, in string format. It can be obtained from the Alibaba Cloud DevOps access link,… | | description | string | no | Description | | recordUserIdentifier | string | yes | Recorder, represented by the user's aliyunPk | | spentTime | string | yes | Spent effort, with a maximum value of 9999 | | type | string | yes | Effort type. Obtain valid values via the effort type retrieval API. The value is the identifier of each type. | | workitemIdentifier | string | yes | Work item ID, same as workitemId | ### Log actual working hours `POST https://zieapi.vercel.app/v1/cloud:aliyun-devops/create-workitem-record` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://devops.cn-hangzhou.aliyuncs.com | | organizationId | string | yes | Organization identifier, also known as organization ID, in string format. It can be obtained from the Alibaba Cloud DevOps access link,… | | actualTime | string | yes | Actual work hours spent, with a maximum value of 9999 | | description | string | no | Description | | gmtEnd | string | yes | End Time; Start Time cannot be later than End Time | | gmtStart | string | yes | Start Time | | recordUserIdentifier | string | yes | Recorder, represented by the user's aliyunPk | | type | string | yes | Type, obtained from the API for retrieving work hour types | | workitemIdentifier | string | yes | Work item ID, that is, workitemId | ### Create work items for a project, such as requirements, defects, tasks, risks, and themes `POST https://zieapi.vercel.app/v1/cloud:aliyun-devops/create-workitem-v2` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://devops.cn-hangzhou.aliyuncs.com | | organizationId | string | yes | The organization ID. You can find this ID in the URL of your organization on Alibaba Cloud DevOps, for example,… | | assignedTo | string | yes | The assignee ID | | category | string | yes | The category of the work item. Valid values: `Req`, `Bug`, `Task`, and `Topic` | | description | string | no | The description. To upload an image, we recommend using images smaller than 1 MB. To insert an image, use the following format: \… | | fieldValueList | array | no | A list of field values. Call the Get Workitem Fields List API (https://help.aliyun.com/document_detail/460486.html) to determine the… | | parentIdentifier | string | no | The parent work item ID | | participants | array | no | A list of participant account IDs | | spaceIdentifier | string | yes | The unique identifier of the project | | sprintIdentifier | string | no | The unique identifier of the sprint | | subject | string | yes | The title of the work item | | tags | array | no | A list of unique tag identifiers | | trackers | array | no | A list of tracker account IDs | | verifier | string | no | The verifier's account ID | | versions | array | no | A list of unique version identifiers | | workitemTypeIdentifier | string | yes | The ID of the work item type. Call the Get Workitem Types API (https://help.aliyun.com/document_detail/460485.html) to get the available… | ### Deletes an app member `POST https://zieapi.vercel.app/v1/cloud:aliyun-devops/delete-app-member` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://devops.cn-hangzhou.aliyuncs.com | | organizationId | string | no | The organization ID | | appName | string | yes | The application name | | subjectType | string | no | The member type. The only supported value is User | | subjectId | string | no | The member ID. If the member type is User, this value is the member's Alibaba Cloud UID | ### Delete a code repository branch `POST https://zieapi.vercel.app/v1/cloud:aliyun-devops/delete-branch` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://devops.cn-hangzhou.aliyuncs.com | | organizationId | string | yes | Enterprise identity, also known as enterprise ID, in string format. It can be obtained from the Alibaba Cloud DevOps access link, such as… | | accessToken | string | no | Personal access token. This field is not required if you use an Alibaba Cloud AccessKey pair (AK+SK) or Security Token Service (STS)… | | repositoryId | string | yes | Code repository ID | | branchName | string | yes | Branch name | ### Delete a specified file in the code repository `POST https://zieapi.vercel.app/v1/cloud:aliyun-devops/delete-file` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://devops.cn-hangzhou.aliyuncs.com | | organizationId | string | yes | Organization identity, also known as organization ID, in string format. You can obtain it from the Alibaba Cloud DevOps access link, for… | | accessToken | string | no | Personal access token. You do not need to pass this field if you use an Alibaba Cloud AccessKey pair (AK+SK) or temporary authorization… | | repositoryId | string | yes | Code repository ID | | branchName | string | yes | Branch Name | | filePath | string | yes | File Path | | commitMessage | string | yes | Commit message when deleting the file | ### Remove tags `POST https://zieapi.vercel.app/v1/cloud:aliyun-devops/delete-flow-tag` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://devops.cn-hangzhou.aliyuncs.com | | organizationId | string | yes | Organization identity, also known as organization ID, in string format. It can be obtained from the Alibaba Cloud DevOps access link, such… | | id | string | yes | Tag ID | ### Remove tag categorization `POST https://zieapi.vercel.app/v1/cloud:aliyun-devops/delete-flow-tag-group` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://devops.cn-hangzhou.aliyuncs.com | | organizationId | string | yes | Organization identity, also known as organization ID, in string format. It can be obtained from the Alibaba Cloud DevOps access link, such… | | id | string | yes | Tag categorization ID | ### Deletes a member from a specified code group by Alibaba Cloud account ID `POST https://zieapi.vercel.app/v1/cloud:aliyun-devops/delete-group-member` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://devops.cn-hangzhou.aliyuncs.com | | organizationId | string | yes | The enterprise identifier, also known as the enterprise ID, in string format. You can obtain it from the China Yunxiao access URL, such as… | | accessToken | string | no | The personal access token. This field is not required if you use an Alibaba Cloud AK/SK pair or STS temporary authorization | | groupId | string | yes | The primary key ID of the code group | | aliyunPk | string | yes | The Alibaba Cloud account ID of the group member | | memberType | string | yes | The member type. Set this to the default value: USERS | ### You can delete a host group `POST https://zieapi.vercel.app/v1/cloud:aliyun-devops/delete-host-group` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://devops.cn-hangzhou.aliyuncs.com | | organizationId | string | yes | Organization identity, also known as organization ID, in string format. It can be obtained from the Alibaba Cloud DevOps access link, for… | | id | string | yes | Host group ID | ### You can delete a pipeline `POST https://zieapi.vercel.app/v1/cloud:aliyun-devops/delete-pipeline` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://devops.cn-hangzhou.aliyuncs.com | | organizationId | string | yes | The enterprise identity, also known as the enterprise ID, is a string that can be obtained from the Alibaba Cloud DevOps access link, such… | | pipelineId | string | yes | The pipeline ID, which can be obtained from the pipeline link, such as https://flow.aliyun.com/pipelines/【PipelineId】/current | ### Delete a pipeline group `POST https://zieapi.vercel.app/v1/cloud:aliyun-devops/delete-pipeline-group` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://devops.cn-hangzhou.aliyuncs.com | | organizationId | string | yes | The enterprise identity, also known as the enterprise ID, in string format. It can be obtained from the Alibaba Cloud DevOps access link,… | | groupId | string | yes | The pipeline group ID | ### Delete Pipeline Relations `POST https://zieapi.vercel.app/v1/cloud:aliyun-devops/delete-pipeline-relations` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://devops.cn-hangzhou.aliyuncs.com | | organizationId | string | yes | The ID of the organization, also known as the enterprise ID. It is a string that can be obtained from the China DevOps URL, for example,… | | pipelineId | string | yes | The ID of the pipeline. You can obtain it from the pipeline URL, for example, https://flow.aliyun.com/pipelines/[PipelineId]/current | | relObjectType | string | yes | The type of the associated resource. Only VARIABLE_GROUP is supported | | relObjectId | string | yes | The ID of the associated resource. Only variable group IDs are supported | ### You can delete a project `POST https://zieapi.vercel.app/v1/cloud:aliyun-devops/delete-project` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://devops.cn-hangzhou.aliyuncs.com | | organizationId | string | yes | Organization identifier, also known as organization ID, in string format. It can be obtained from the Alibaba Cloud DevOps access link,… | | identifier | string | yes | Project ID, equivalent to the spaceIdentifier and projectId fields | ### Deletes a repository label `POST https://zieapi.vercel.app/v1/cloud:aliyun-devops/delete-project-label` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://devops.cn-hangzhou.aliyuncs.com | | organizationId | string | yes | The organization ID. This ID is part of the URL used to access Alibaba Cloud DevOps. For example, in… | | accessToken | string | no | The personal access token. This parameter is not required if you use an Alibaba Cloud AccessKey pair or Security Token Service (STS) for… | | labelId | string | yes | The unique identifier of the label | | repositoryIdentity | string | yes | The ID or full path of the repository | ### Delete a protected branch in a code repository `POST https://zieapi.vercel.app/v1/cloud:aliyun-devops/delete-protected-branch` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://devops.cn-hangzhou.aliyuncs.com | | organizationId | string | yes | Organization identity, also known as organization ID, in string format. It can be obtained from the Alibaba Cloud DevOps access link, for… | | accessToken | string | no | Personal access token. This field is not required if you use an Alibaba Cloud AccessKey pair (AK+SK) or temporary authorization via… | | repositoryId | string | yes | Code repository ID | | protectedBranchId | string | yes | Protected branch rule ID | ### Deletes a specified push rule `POST https://zieapi.vercel.app/v1/cloud:aliyun-devops/delete-push-rule` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://devops.cn-hangzhou.aliyuncs.com | | organizationId | string | yes | The organization ID. You can obtain it from the URL in your browser's address bar after you log on to Alibaba Cloud DevOps. The URL has… | | accessToken | string | no | The personal access token. This parameter is not required if you use an Alibaba Cloud AccessKey pair (AccessKey ID and AccessKey secret)… | | repositoryId | string | yes | The repository ID | | pushRuleId | string | yes | The push rule ID | ### Delete a code repository. (To ensure compliance, you must specify the reason for deletion.) `POST https://zieapi.vercel.app/v1/cloud:aliyun-devops/delete-repository` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://devops.cn-hangzhou.aliyuncs.com | | organizationId | string | yes | Organization identity, also known as organization ID, in string format. You can obtain it from the Alibaba Cloud DevOps access link, for… | | accessToken | string | no | Personal access token. You do not need to provide this field if you use an Alibaba Cloud AccessKey pair (AK+SK) or Security Token Service… | | repositoryId | string | yes | Code repository ID | | reason | string | yes | Reason for deleting the code repository (Required) | ### Deletes the specified code group `POST https://zieapi.vercel.app/v1/cloud:aliyun-devops/delete-repository-group` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://devops.cn-hangzhou.aliyuncs.com | | organizationId | string | yes | The ID of the organization. You can find this ID in your browser's URL after logging in to the Alibaba Cloud DevOps console. The URL… | | accessToken | string | no | The personal access token. This parameter is not required if you use an Alibaba Cloud AccessKey pair or a Security Token Service (STS)… | | groupId | string | yes | The ID of the code group | | reason | string | yes | The reason for deleting the code group. This parameter is required | ### Deletes a member from a repository by using their Alibaba Cloud account ID `POST https://zieapi.vercel.app/v1/cloud:aliyun-devops/delete-repository-member` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://devops.cn-hangzhou.aliyuncs.com | | organizationId | string | yes | The ID of the organization. Find this ID in your organization's URL, which follows this format:… | | accessToken | string | no | The personal access token. This parameter is not required if you authenticate by using an AccessKey pair or a Security Token Service (STS)… | | repositoryId | string | yes | The ID of the repository | | aliyunPk | string | yes | The Alibaba Cloud account ID | | memberType | string | no | The member type. Valid values: `TEAMS` (department) and `USERS` (user) | ### Deletes a webhook from a code repository `POST https://zieapi.vercel.app/v1/cloud:aliyun-devops/delete-repository-webhook` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://devops.cn-hangzhou.aliyuncs.com | | organizationId | string | yes | The organization ID. You can find this ID in your organization's URL on the Alibaba Cloud DevOps platform. The URL is formatted as… | | accessToken | string | no | The personal access token. This parameter is not required when authenticating with an AccessKey or STS temporary authorization | | repositoryId | string | yes | The ID of the repository | | hookId | string | yes | The ID of the webhook | ### You can delete a resource member `POST https://zieapi.vercel.app/v1/cloud:aliyun-devops/delete-resource-member` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://devops.cn-hangzhou.aliyuncs.com | | organizationId | string | yes | Organization identity, also known as organization ID, in string format. You can obtain it from the Alibaba Cloud DevOps access link, such… | | resourceType | string | yes | Resource type pipeline: Pipeline hostGroup: Deployment group | | resourceId | string | yes | Resource ID | | accountId | string | yes | Alibaba Cloud account ID | ### Deletes a tag from a repository `POST https://zieapi.vercel.app/v1/cloud:aliyun-devops/delete-tag` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://devops.cn-hangzhou.aliyuncs.com | | organizationId | string | yes | The organization ID. Find this ID in your browser's URL when you access your organization in Alibaba Cloud DevOps:… | | accessToken | string | no | The personal access token. This parameter is not required for authentication with an AccessKey pair or Security Token Service (STS) | | repositoryId | string | yes | The repository ID | | tagName | string | yes | The tag name | ### Deletes a specified ssh key for the current user `POST https://zieapi.vercel.app/v1/cloud:aliyun-devops/delete-user-key` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://devops.cn-hangzhou.aliyuncs.com | | organizationId | string | yes | The ID of the organization. You can find the organization ID in the URL of the organization page on Alibaba Cloud DevOps. For example, in… | | accessToken | string | no | The personal access token. This parameter is not required if you use an AccessKey pair or STS temporary authorization for authentication | | keyId | string | yes | The unique ID of the ssh key | ### You can delete a variable group `POST https://zieapi.vercel.app/v1/cloud:aliyun-devops/delete-variable-group` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://devops.cn-hangzhou.aliyuncs.com | | organizationId | string | yes | Organization identity, also known as organization ID, in string format. It can be obtained from the Alibaba Cloud DevOps access link, for… | | id | string | yes | Variable group ID | ### Delete a work item `POST https://zieapi.vercel.app/v1/cloud:aliyun-devops/delete-workitem` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://devops.cn-hangzhou.aliyuncs.com | | organizationId | string | yes | Organization ID | | identifier | string | yes | Work item ID, equivalent to workitemIdentifier, workitemId, or UUID of the work item | ### Delete all comments of the current work item `POST https://zieapi.vercel.app/v1/cloud:aliyun-devops/delete-workitem-all-comment` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://devops.cn-hangzhou.aliyuncs.com | | organizationId | string | yes | Enterprise ID | | identifier | string | yes | Work item ID, equivalent to workitemId or workitemIdentifier; the UUID of the work item | ### Delete a single comment under a work item `POST https://zieapi.vercel.app/v1/cloud:aliyun-devops/delete-workitem-comment` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://devops.cn-hangzhou.aliyuncs.com | | organizationId | string | yes | Organization identifier, also known as organization ID, in string format. It can be obtained from the Alibaba Cloud DevOps access link,… | | commentId | integer | yes | Comment ID | | identifier | string | yes | Unique identifier of the work item, equivalent to workitemId or workitemIdentifier | ### Enables an existing deploy key in a repository `POST https://zieapi.vercel.app/v1/cloud:aliyun-devops/enable-deploy-key` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://devops.cn-hangzhou.aliyuncs.com | | organizationId | string | yes | The organization ID. You can obtain this ID from your organization's URL in Alibaba Cloud DevOps:… | | accessToken | string | no | The personal access token. This parameter is optional if you use an Alibaba Cloud AccessKey pair (AK/SK) or an STS token | | repositoryId | string | yes | The repository ID | | keyId | string | yes | The deploy key ID | ### Executes a release stage pipeline `POST https://zieapi.vercel.app/v1/cloud:aliyun-devops/execute-change-request-release-stage` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://devops.cn-hangzhou.aliyuncs.com | | organizationId | string | no | The organization ID | | appName | string | yes | The application name | | releaseWorkflowSn | string | yes | The unique ID for the release workflow | | releaseStageSn | string | yes | The unique ID for the release stage | | params | object | no | Parameters for the pipeline run | ### Retrieves data from the `custom_value` table for a specific enterprise in R&D Intelligence `POST https://zieapi.vercel.app/v1/cloud:aliyun-devops/export-insight-custom-value` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://devops.cn-hangzhou.aliyuncs.com | | organizationId | string | yes | The organization ID. This ID is part of the URL when you access Alibaba Cloud DevOps, for example,… | | endTime | string | yes | The end time for the query. The time range between `startTime` and `endTime` cannot exceed one year | | maxResults | integer | no | The maximum number of results to return. The maximum value is 10,000 | | nextToken | string | no | The token to retrieve the next page of results | | startTime | string | yes | The start time for the query. The time range between `startTime` and `endTime` cannot exceed one year | ### Retrieves data from the expected_work_time table in Insight for a specified organization `POST https://zieapi.vercel.app/v1/cloud:aliyun-devops/export-insight-expected-work-time` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://devops.cn-hangzhou.aliyuncs.com | | organizationId | string | yes | The organization ID. You can obtain this ID from the URL when you access Alibaba Cloud DevOps, for example:… | | endTime | string | yes | The end time for the query. The time range between the start and end times cannot exceed one year | | maxResults | integer | no | The maximum number of results to return. The maximum value is 10,000 | | nextToken | string | no | The token used to retrieve the next page of results | | startTime | string | yes | The start time for the query. The time range between the start and end times cannot exceed one year | ### Retrieves an organization's field data from DevOps Insights `POST https://zieapi.vercel.app/v1/cloud:aliyun-devops/export-insight-field` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://devops.cn-hangzhou.aliyuncs.com | | organizationId | string | yes | The organization ID. You can find it in the URL for Alibaba Cloud DevOps, such as https\://devops.aliyun.com/organization/#{organizationId} | | endTime | string | yes | The duration between the start time and end time cannot exceed one year | | maxResults | integer | no | The maximum number of entries per page | | nextToken | string | no | The pagination token | | startTime | string | yes | The duration between the start time and end time cannot exceed one year | ### Retrieves data from the space table in DevOps Insights for a specified enterprise `POST https://zieapi.vercel.app/v1/cloud:aliyun-devops/export-insight-space` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://devops.cn-hangzhou.aliyuncs.com | | organizationId | string | yes | The organization ID. You can find this ID in the URL of your organization's Alibaba Cloud DevOps page. For example:… | | endTime | string | yes | The end time for the query. The period between the start and end times must not exceed one year | | maxResults | integer | no | The maximum number of results to return per page | | nextToken | string | no | The token to retrieve the next page of results. The response includes this token when more results are available | | startTime | string | yes | The start time for the query. The period between the start and end times must not exceed one year | ### Exports data from the space_ref table in DevOps Insight for a specified organization `POST https://zieapi.vercel.app/v1/cloud:aliyun-devops/export-insight-space-ref` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://devops.cn-hangzhou.aliyuncs.com | | organizationId | string | yes | The ID of the organization. You can find this ID in your Alibaba Cloud DevOps URL, for example:… | | endTime | string | yes | The end time for the query | | maxResults | integer | no | The maximum number of results to return | | nextToken | string | no | The nextToken value returned from a previous request, used for pagination | | startTime | string | yes | The start time for the query. The duration between startTime and endTime cannot exceed one year | ### Fetches sprint table data for a specific enterprise from Insights `POST https://zieapi.vercel.app/v1/cloud:aliyun-devops/export-insight-sprint` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://devops.cn-hangzhou.aliyuncs.com | | organizationId | string | yes | The organization ID. You can find this ID in the URL for your Alibaba Cloud DevOps organization, for example,… | | endTime | string | yes | The end of the time range | | maxResults | integer | no | The maximum number of results to return | | nextToken | string | no | The token to retrieve the next page of results | | startTime | string | yes | The start of the time range. The time range cannot exceed one year | ### Exports the tag_ref table data from Performance Insight for a specified enterprise `POST https://zieapi.vercel.app/v1/cloud:aliyun-devops/export-insight-tag-ref` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://devops.cn-hangzhou.aliyuncs.com | | organizationId | string | yes | The enterprise ID. You can find this ID in the URL of your Alibaba Cloud DevOps organization:… | | endTime | string | yes | The end of the time range to query. The interval between the start time and end time cannot exceed one year | | maxResults | integer | no | The maximum number of results to return per page. The maximum value is 10,000 | | nextToken | string | no | The token to retrieve the next page of results | | startTime | string | yes | The start of the time range to query. The interval between the start time and end time cannot exceed one year | ### Retrieve data for a specific enterprise from the `workitem_time` table in Insight `POST https://zieapi.vercel.app/v1/cloud:aliyun-devops/export-insight-work-time` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://devops.cn-hangzhou.aliyuncs.com | | organizationId | string | yes | The organization ID. You can find this ID in the URL you use to access Alibaba Cloud DevOps. For example:… | | endTime | string | yes | The end of the time range. The time range cannot exceed one year | | maxResults | integer | no | The maximum number of results to return per page | | nextToken | string | no | The pagination token from a previous request. Use this token to retrieve the next page of results | | startTime | string | yes | The start of the time range. The time range cannot exceed one year | ### Retrieves data from the `workitem_status` table in Performance Insight for a specific enterprise `POST https://zieapi.vercel.app/v1/cloud:aliyun-devops/export-insight-workitem-status` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://devops.cn-hangzhou.aliyuncs.com | | organizationId | string | yes | The organization ID. You can find this ID in the Alibaba Cloud DevOps URL. For example:… | | endTime | string | yes | The end of the time range for the query. This range cannot exceed one year | | maxResults | integer | no | The maximum number of results to return | | nextToken | string | no | The token used to retrieve the next page of results | | startTime | string | yes | The start of the time range for the query. This range cannot exceed one year | ### Joins the `workitem_status` and `workitem_defect_extra` tables to retrieve efficiency insight data for a… `POST https://zieapi.vercel.app/v1/cloud:aliyun-devops/export-insight-workitem-status-join-workitem-defect-extra` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://devops.cn-hangzhou.aliyuncs.com | | organizationId | string | yes | The organization ID. You can find this ID in the Alibaba Cloud DevOps URL, for example,… | | endTime | string | yes | The end time. The specified time range cannot exceed one year | | maxResults | integer | no | The maximum number of results to return per page. If more results are available, the response includes a nextToken to retrieve the next… | | nextToken | string | no | The token to retrieve the next page of results. This is the nextToken value from a previous response. If omitted, the first page of… | | startTime | string | yes | The start time. The specified time range cannot exceed one year | ### Retrieves data from the `workitem_version` table for a specified enterprise in Insight `POST https://zieapi.vercel.app/v1/cloud:aliyun-devops/export-insight-workitem-version` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://devops.cn-hangzhou.aliyuncs.com | | organizationId | string | yes | The organization ID. You can find this ID in your organization's URL on Alibaba Cloud DevOps, for example,… | | endTime | string | yes | The end of the time range. The time range cannot exceed one year | | maxResults | integer | no | The maximum number of results to return per page | | nextToken | string | no | The token to retrieve the next page of results. The response includes a nextToken if the number of results exceeds maxResults. To continue… | | startTime | string | yes | The start of the time range. The time range cannot exceed one year | ### Exports work item activity data from performance insight for a specified organization `POST https://zieapi.vercel.app/v1/cloud:aliyun-devops/export-workitem-activity` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://devops.cn-hangzhou.aliyuncs.com | | organizationId | string | yes | The organization ID. You can find this ID in your organization's URL in Alibaba Cloud DevOps, which follows the format… | | endTime | string | yes | The end time. The interval between the start time and end time cannot exceed one year | | maxResults | integer | no | The maximum number of results to return. The maximum value is 10,000 | | nextToken | string | no | The token for retrieving the next page of results. If the number of results exceeds the `maxResults` value, the response includes a… | | startTime | string | yes | The start time. The interval between the start time and end time cannot exceed one year | ### Retrieves details of a specific application `GET https://zieapi.vercel.app/v1/cloud:aliyun-devops/get-application` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://devops.cn-hangzhou.aliyuncs.com | | appName | string | yes | The application name | | organizationId | string | no | The organization ID | ### Query information about code repository branches `GET https://zieapi.vercel.app/v1/cloud:aliyun-devops/get-branch-info` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://devops.cn-hangzhou.aliyuncs.com | | organizationId | string | yes | Organization identity, also known as organization ID, in string form. It can be obtained from the Alibaba Cloud DevOps access link, for… | | accessToken | string | no | Personal access token. This field is not required when using Alibaba Cloud AccessKey ID and AccessKey Secret or Security Token Service… | | repositoryId | string | yes | Repository ID | | branchName | string | yes | Branch Name | ### Retrieves a single check run `GET https://zieapi.vercel.app/v1/cloud:aliyun-devops/get-check-run` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://devops.cn-hangzhou.aliyuncs.com | | organizationId | string | yes | The ID of the organization. You can get this ID from your Alibaba Cloud DevOps URL, for example,… | | accessToken | string | no | A personal access token. This parameter is optional if you authenticate with an Alibaba Cloud AccessKey pair or temporary credentials from… | | repositoryIdentity | string | yes | The repository ID or full path | | checkRunId | integer | yes | The ID of the check run | ### Obtain enterprise information from Codeup based on the enterprise identity (Alibaba Cloud DevOps enterprise… `GET https://zieapi.vercel.app/v1/cloud:aliyun-devops/get-codeup-organization` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://devops.cn-hangzhou.aliyuncs.com | | identity | string | yes | The enterprise identity, also known as the enterprise ID or enterprise path, is a string that can be obtained from the Alibaba Cloud… | | accessToken | string | no | Personal access token. This field is not required when using Alibaba Cloud AccessKey ID and AccessKey secret or Security Token Service… | ### Compares two commits (branches and tags are treated as commits) and returns a list of commits between them,… `GET https://zieapi.vercel.app/v1/cloud:aliyun-devops/get-compare-detail` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://devops.cn-hangzhou.aliyuncs.com | | organizationId | string | yes | The organization ID. You can find this ID in the URL of the Alibaba Cloud DevOps console, for example,… | | repositoryId | string | yes | The repository ID | | from | string | yes | The start version (commit ID) | | to | string | yes | The end version (commit ID) | | mergeBase | string | no | Specifies whether to use the merge base for the comparison | | maxDiffFile | integer | no | The maximum number of files to return. The maximum value for this parameter is 5,000 | | maxDiffByte | integer | no | The maximum size of the diff to return, in bytes. The maximum value for this parameter is 24 MB (25,165,824 bytes) | ### Retrieve custom options for a field. `GET https://zieapi.vercel.app/v1/cloud:aliyun-devops/get-custom-field-option` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://devops.cn-hangzhou.aliyuncs.com | | organizationId | string | yes | Organization identity, also known as organization ID, in string form. It can be obtained from the Alibaba Cloud DevOps access link, for… | | spaceIdentifier | string | yes | project ID, equivalent to projectId; the UUID of the project | | spaceType | string | yes | resource type; currently defaults to Project | | workitemTypeIdentifier | string | yes | Work item type ID, which can be obtained from the ListProjectWorkitemTypes API and corresponds to the identifier field | | fieldId | string | yes | Field ID | ### Query the specific content of a file in a code repository `GET https://zieapi.vercel.app/v1/cloud:aliyun-devops/get-file-blobs` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://devops.cn-hangzhou.aliyuncs.com | | organizationId | string | yes | Organization identity, also known as organization ID, in string format. It can be obtained from the Alibaba Cloud DevOps access link, for… | | accessToken | string | no | Personal access token. This field is not required if you use an Alibaba Cloud AccessKey ID and AccessKey secret or temporary authorization… | | repositoryId | string | yes | Code repository ID | | filePath | string | yes | File Path | | ref | string | yes | Branch name, tag name, or commit version number | | from | integer | no | Starting line of the file. If empty, the entire file content is retrieved | | to | integer | no | Ending line of the file. This parameter is valid only when from is not empty | ### Query the most recent Git commit for the specified file `GET https://zieapi.vercel.app/v1/cloud:aliyun-devops/get-file-last-commit` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://devops.cn-hangzhou.aliyuncs.com | | accessToken | string | no | Personal access token. This field is not required when using Alibaba Cloud AccessKey ID and AccessKey secret or temporary authorization… | | repositoryId | string | yes | Repository ID | | organizationId | string | yes | Organization identifier, also known as organization ID, in string format. It can be obtained from the Alibaba Cloud DevOps URL, such as… | | sha | string | yes | Branch name, tag name, or commit ID. For example: Branch name: master Tag name: tag001 Commit ID: ff4fb5ac6d1f44f452654336d2dba468ae6c8d04 | | filePath | string | yes | File path | | showSignature | string | no | Show signature. Default value: false | ### Retrieve tag categorization `GET https://zieapi.vercel.app/v1/cloud:aliyun-devops/get-flow-tag-group` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://devops.cn-hangzhou.aliyuncs.com | | organizationId | string | yes | Organization identity, also known as organization ID, in string format. It can be obtained from the Alibaba Cloud DevOps access link, such… | | id | string | yes | Tag categorization ID | ### Retrieves information about a group by its full path `GET https://zieapi.vercel.app/v1/cloud:aliyun-devops/get-group-by-path` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://devops.cn-hangzhou.aliyuncs.com | | organizationId | string | yes | The ID of the organization. You can obtain the organization ID from the URL in Alibaba Cloud DevOps, for example,… | | identity | string | yes | The full path or ID of the group | ### Queries the information of a specified code group `GET https://zieapi.vercel.app/v1/cloud:aliyun-devops/get-group-detail` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://devops.cn-hangzhou.aliyuncs.com | | organizationId | string | yes | The enterprise identifier, also known as the enterprise ID, in string format. You can obtain it from the Yunxiao access URL, such as… | | accessToken | string | no | The personal access token. This field is not required if you use an Alibaba Cloud AK/SK or STS temporary authorization | | groupId | integer | yes | The primary key ID of the code group | ### You can obtain a host group `GET https://zieapi.vercel.app/v1/cloud:aliyun-devops/get-host-group` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://devops.cn-hangzhou.aliyuncs.com | | organizationId | string | yes | Organization identity, also known as organization ID, in string format. It can be obtained from the Alibaba Cloud DevOps access link, such… | | id | string | yes | Host group ID | ### Gets the details of a single merge request `GET https://zieapi.vercel.app/v1/cloud:aliyun-devops/get-merge-request` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://devops.cn-hangzhou.aliyuncs.com | | organizationId | string | yes | The organization ID. This ID is part of your Alibaba Cloud DevOps URL. For example: https\://devops.aliyun.com/organization/{organizationId} | | accessToken | string | no | The personal access token. This parameter is optional if you use an Alibaba Cloud AccessKey or STS temporary authorization | | repositoryId | string | yes | The ID of the repository | | localId | string | yes | The sequential ID of the merge request within the repository | ### Retrieves diff statistics for a merge request, including a file change tree, total added and deleted lines,… `GET https://zieapi.vercel.app/v1/cloud:aliyun-devops/get-merge-request-change-tree` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://devops.cn-hangzhou.aliyuncs.com | | organizationId | string | yes | The ID of the organization. Find this ID in the URL of Alibaba Cloud DevOps: `https://devops.aliyun.com/organization/ ` | | accessToken | string | no | The personal access token. Not required if authenticating with an Alibaba Cloud AccessKey pair (AK/SK) or Security Token Service (STS) | | repositoryIdentity | string | yes | The ID or full path of the repository | | localId | integer | yes | The local ID of the merge request within its repository | | fromPatchSetBizId | string | yes | The business ID of the patch set for the merge target. In APIs related to merge requests and comparisons, `from` and `to` may seem… | | toPatchSetBizId | string | yes | The business ID of the patch set for the merge source. In APIs related to merge requests and comparisons, `from` and `to` may seem… | ### Obtain enterprise member information based on specified conditions `GET https://zieapi.vercel.app/v1/cloud:aliyun-devops/get-organization-member` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://devops.cn-hangzhou.aliyuncs.com | | organizationId | string | yes | Organization identity, also known as organization ID | | accountId | string | yes | Alibaba Cloud User UID | ### You can retrieve pipeline information `GET https://zieapi.vercel.app/v1/cloud:aliyun-devops/get-pipeline` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://devops.cn-hangzhou.aliyuncs.com | | organizationId | string | yes | Organization identity, also known as organization ID, in string format. It can be obtained from the Alibaba Cloud DevOps access Link, such… | | pipelineId | string | yes | Pipeline ID, which can be obtained from the pipeline Link, such as https://flow.aliyun.com/pipelines/【PipelineId】/current | ### Obtain the download URL of pipeline build artifacts `POST https://zieapi.vercel.app/v1/cloud:aliyun-devops/get-pipeline-artifact-url` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://devops.cn-hangzhou.aliyuncs.com | | organizationId | string | yes | Organization identity, also known as organization ID, in string format. It can be obtained from the Alibaba Cloud DevOps access link, such… | | filePath | string | yes | File Path, which can be obtained through the API at https://help.aliyun.com/document_detail/460565.html | | fileName | string | yes | File name, which can be obtained through the API at https://help.aliyun.com/document_detail/460565.html | ### Obtain the temporary download URL for EMAS build artifacts from a pipeline `POST https://zieapi.vercel.app/v1/cloud:aliyun-devops/get-pipeline-emas-artifact-url` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://devops.cn-hangzhou.aliyuncs.com | | organizationId | string | yes | Organization identifier, also known as organization ID, in string format. It can be obtained from the Alibaba Cloud DevOps access link,… | | emasJobInstanceId | string | yes | EMAS job ID. You can obtain it through the API at https://help.aliyun.com/document_detail/460565.html | | md5 | string | yes | MD5 hash of the EMAS build artifact. You can obtain it through the API at https://help.aliyun.com/document_detail/460565.html | | pipelineId | string | yes | Pipeline ID | | pipelineRunId | string | yes | Pipeline run instance ID | | serviceConnectionId | integer | yes | Service connection ID | ### Retrieve pipeline groups `GET https://zieapi.vercel.app/v1/cloud:aliyun-devops/get-pipeline-group` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://devops.cn-hangzhou.aliyuncs.com | | organizationId | string | yes | Organization identity, also known as organization ID, in string format. It can be obtained from the Alibaba Cloud DevOps access link, such… | | groupId | string | yes | Pipeline group ID. The value 0 indicates that the pipeline is ungrouped | ### Retrieves a pipeline run `GET https://zieapi.vercel.app/v1/cloud:aliyun-devops/get-pipeline-run` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://devops.cn-hangzhou.aliyuncs.com | | organizationId | string | yes | The ID of the organization. You can get this ID from the URL of your organization in Alibaba Cloud DevOps, for example,… | | pipelineId | string | yes | The ID of the pipeline. You can get this ID from the pipeline URL, for example, `https://flow.aliyun.com/pipelines/{pipelineId}/current` | | pipelineRunId | string | yes | The ID of the pipeline run | ### Obtain a temporary download URL for the pipeline scan report `POST https://zieapi.vercel.app/v1/cloud:aliyun-devops/get-pipeline-scan-report-url` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://devops.cn-hangzhou.aliyuncs.com | | organizationId | string | yes | Organization identity, also known as organization ID, in string format. It can be obtained from the Alibaba Cloud DevOps access link, such… | | reportPath | string | yes | Path to the scan report, which can be retrieved through the API at https://help.aliyun.com/document_detail/460565.html | ### Obtain basic project information by projectId `GET https://zieapi.vercel.app/v1/cloud:aliyun-devops/get-project-info` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://devops.cn-hangzhou.aliyuncs.com | | organizationId | string | yes | Organization identifier, also known as organization ID, in string form. It can be obtained from the Alibaba Cloud DevOps access URL, for… | | projectId | string | yes | Project ID, same as spaceIdentifier | ### Query repository member information by Alibaba Cloud account ID (aliyunPk) `GET https://zieapi.vercel.app/v1/cloud:aliyun-devops/get-project-member` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://devops.cn-hangzhou.aliyuncs.com | | organizationId | string | yes | Organization identity, also known as organization ID, in string format. It can be obtained from the Alibaba Cloud DevOps access link, for… | | accessToken | string | no | Personal access token. This field is not required when using Alibaba Cloud AccessKey ID and AccessKey Secret or when using temporary… | | repositoryId | string | yes | Repository ID | | aliyunPk | string | yes | Alibaba Cloud account ID | ### Retrieves a pipeline run in the development stage `GET https://zieapi.vercel.app/v1/cloud:aliyun-devops/get-release-stage-pipeline-run` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://devops.cn-hangzhou.aliyuncs.com | | organizationId | string | no | The organization ID | | appName | string | yes | The application name | | releaseWorkflowSn | string | yes | The release workflow ID | | releaseStageSn | string | yes | The release stage ID | | executionNumber | string | yes | The execution number | ### Query a code repository. You can query by repository ID and repository path `GET https://zieapi.vercel.app/v1/cloud:aliyun-devops/get-repository` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://devops.cn-hangzhou.aliyuncs.com | | organizationId | string | yes | Organization identity, also known as organization ID, in string form. It can be obtained from the Alibaba Cloud DevOps access link, such… | | accessToken | string | no | Personal access token. This field is not required when using Alibaba Cloud AccessKey ID and AccessKey Secret or temporary authorization… | | identity | string | yes | Code repository ID or path | ### Gets details of a single commit in a code repository `GET https://zieapi.vercel.app/v1/cloud:aliyun-devops/get-repository-commit` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://devops.cn-hangzhou.aliyuncs.com | | organizationId | string | yes | Specifies the organization ID. You can obtain this ID from your Alibaba Cloud DevOps URL. For example:… | | accessToken | string | no | The personal access token. This parameter is not required if you use an Alibaba Cloud AccessKey pair or an STS token for authentication | | repositoryId | string | yes | The unique identifier for the repository | | sha | string | yes | A commit reference, such as a branch name, tag name, or commit ID | | showSignature | string | no | Specifies whether to show the signature. The default value is false | ### Retrieves information about a single tag in a code repository `GET https://zieapi.vercel.app/v1/cloud:aliyun-devops/get-repository-tag` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://devops.cn-hangzhou.aliyuncs.com | | organizationId | string | yes | The organization ID. You can find this ID in the URL for Alibaba Cloud DevOps, such as… | | accessToken | string | no | The personal access token. This parameter is optional when authenticating with an Alibaba Cloud AccessKey pair or STS temporary… | | repositoryId | string | yes | The repository ID | | tagName | string | yes | The tag name | ### Gets a code preview using a document ID and a keyword `GET https://zieapi.vercel.app/v1/cloud:aliyun-devops/get-search-code-preview` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://devops.cn-hangzhou.aliyuncs.com | | organizationId | string | yes | The enterprise ID. You can find this ID in the URL of your browser after you log in to the Alibaba Cloud DevOps console:… | | docId | string | yes | The document ID | | keyword | string | yes | The search keyword | | isDsl | string | no | Specifies whether the search is a DSL search | ### Retrieve iteration details `GET https://zieapi.vercel.app/v1/cloud:aliyun-devops/get-sprint-info` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://devops.cn-hangzhou.aliyuncs.com | | organizationId | string | yes | Organization identifier, also known as organization ID, in string format. It can be obtained from the Alibaba Cloud DevOps URL, for… | | sprintId | string | yes | Iteration ID | ### Retrieves a list of test cases in a test plan that can be filtered `POST https://zieapi.vercel.app/v1/cloud:aliyun-devops/get-test-result-list` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://devops.cn-hangzhou.aliyuncs.com | | organizationId | string | yes | The organization ID | | testPlanIdentifier | string | yes | The unique identifier for the test plan | | conditions | string | no | The filter conditions | | directoryIdentifier | string | yes | The unique directory identifier, which corresponds to the directory ID in the test plan | ### Retrieves a filterable list of test cases from the test case repository `POST https://zieapi.vercel.app/v1/cloud:aliyun-devops/get-testcase-list` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://devops.cn-hangzhou.aliyuncs.com | | organizationId | string | yes | The ID of the organization | | conditions | string | no | The conditions for filtering test cases, provided as a JSON string | | directoryIdentifier | string | no | The unique identifier of the directory. Omit this parameter to return all test cases from the test case library | | maxResult | string | no | The maximum number of results to return per page. The default value is 20 | | nextToken | string | no | The token for paginating results. Leave this parameter empty for the first request. For subsequent requests, use the `nextToken` value… | | spaceIdentifier | string | yes | The unique identifier of the test case library | ### This operation retrieves user information from Codeup `GET https://zieapi.vercel.app/v1/cloud:aliyun-devops/get-user-info` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://devops.cn-hangzhou.aliyuncs.com | | organizationId | string | no | The organization ID. You can obtain this string from the Alibaba Cloud DevOps URL, for example,… | ### You can obtain the deployment order details `GET https://zieapi.vercel.app/v1/cloud:aliyun-devops/get-vmdeploy-order` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://devops.cn-hangzhou.aliyuncs.com | | organizationId | string | yes | Organization identity, also known as organization ID, in string format. It can be obtained from the Alibaba Cloud DevOps access Link, such… | | pipelineId | string | yes | The pipeline ID, which can be obtained from the pipeline link, such as https://flow.aliyun.com/pipelines/【PipelineId】/current | | deployOrderId | string | yes | Deployment order ID | ### You can retrieve a variable group `GET https://zieapi.vercel.app/v1/cloud:aliyun-devops/get-variable-group` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://devops.cn-hangzhou.aliyuncs.com | | organizationId | string | yes | Organization identity, also known as organization ID, in string format. It can be obtained from the Alibaba Cloud DevOps access URL, for… | | id | string | yes | Variable group ID | ### Query work item dynamic information `GET https://zieapi.vercel.app/v1/cloud:aliyun-devops/get-work-item-activity` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://devops.cn-hangzhou.aliyuncs.com | | organizationId | string | yes | Organization identity, also known as organization ID, in string format. It can be obtained from the Alibaba Cloud DevOps access link, for… | | workitemId | string | yes | Work item ID, same as workitemIdentifier, the UUID of the work item | ### Obtain basic information about a work item. `GET https://zieapi.vercel.app/v1/cloud:aliyun-devops/get-work-item-info` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://devops.cn-hangzhou.aliyuncs.com | | organizationId | string | yes | Organization identifier, also known as organization ID, in string format. It can be obtained from the Alibaba Cloud DevOps access link,… | | workitemId | string | yes | The work item ID, which is the same as the workitemIdentifier field and serves as the UUID of the work item. You can obtain it from the… | ### Retrieve workflow information for a work item `GET https://zieapi.vercel.app/v1/cloud:aliyun-devops/get-work-item-work-flow-info` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://devops.cn-hangzhou.aliyuncs.com | | organizationId | string | yes | Organization identity, also known as organization ID, in string format. It can be obtained from the Alibaba Cloud DevOps access link, for… | | configurationId | string | no | The pipeline configuration ID corresponding to the work item type. This value can be obtained from the following page API request:… | | workitemId | string | yes | Work item ID, same as the workitemIdentifier field, which is the UUID of the work item | ### This API retrieves the metadata needed to upload a file as a work item attachment. It is the first of three… `GET https://zieapi.vercel.app/v1/cloud:aliyun-devops/get-workitem-attachment-createmeta` (byok) | Parameter | Type | Required | Description | |---|---|---|---| | endpoint | string | no | Regional endpoint, for example https://devops.cn-hangzhou.aliyuncs.com | | organizationId | string | yes | The organization ID. You can obtain this ID from the URL in Alibaba Cloud DevOps. Example:… | | workitemIdentifier | string | yes | The unique identifier of the work item | | fileName | string | yes | The name of the file to upload | …and 122 more. See the OpenAPI spec. ## Example ``` curl "https://zieapi.vercel.app/v1/cloud:aliyun-devops/add-group-member" \ -H "x-api-key: $APIZIE_KEY" \ -H "x-upstream-key: $PROVIDER_KEY" ``` ## FAQ ### How do I call the Alibaba Cloud Devops 2020 API? Create a free Apizie key, then send POST https://zieapi.vercel.app/v1/cloud:aliyun-devops/add-group-member with the header x-api-key. Every endpoint returns { project, data, timestamp }. ### Is the Alibaba Cloud Devops 2020 API free on Apizie? Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card. Alibaba Cloud Devops 2020 itself also needs your own key from aliyuncs.com. ### Can AI agents use the Alibaba Cloud Devops 2020 API? Yes. Add the Apizie MCP server (https://zieapi.vercel.app/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key cloud:aliyun-devops. ### What is the status of the Alibaba Cloud Devops 2020 API? Needs your own provider key (bring your own key)