在 Azure DevOps 中，是否可以使用 API 递归地枚举子管道构建工件？

Question

In Azure DevOps, I want to get a list of recursive artifact elements from a pipeline build. It would be nice if I don't have to download the whole artifact root object. Does any one know how to do this with the current API?

The portal already supports this feature in the pipeline artifacts view. You can open and browse child artifacts, with the ability to download. The API however does not seem to support this use case.

Current API https://docs.microsoft.com/en-us/rest/api/azure/devops/build/Artifacts/List?view=azure-devops-rest-6.0#buildartifact

I was able to find a request for the feature, but I'm not sure if it will be implemented soon. https://developercommunity.visualstudio.com/idea/1300697/api-list-artifacts-enumerate-recursively-same-as-w.html

Has anyone else been able to work around this?

Answer 1

This is not documented but you can use the same API call as it is done on Azure DevOps. So it would be

Post https://dev.azure.com/{organization1}/_apis/Contribution/HierarchyQuery/{projectId}?api-version=5.0-preview.1

In my case it was

https://dev.azure.com/thecodemanual/_apis/Contribution/HierarchyQuery/project/4fa6b279-3db9-4cb0-aab8-e06c2ad550b2?api-version=5.0-preview.1

With similar payload similar to this one:

{
    "contributionIds": [
        "ms.vss-build-web.run-artifacts-data-provider"
    ],
    "dataProviderContext": {
        "properties": {
            "artifactId": 1158,
            "buildId": 7875,
            "sourcePage": {
                "url": "https://dev.azure.com/thecodemanual/DevOps%20Manual/_build/results?buildId=7875&view=artifacts&pathAsName=false&type=publishedArtifacts",
                "routeId": "ms.vss-build-web.ci-results-hub-route",
                "routeValues": {
                    "project": "DevOps Manual",
                    "viewname": "build-results",
                    "controller": "ContributedPage",
                    "action": "Execute",
                    "serviceHost": "be1a2b52-5ed1-4713-8508-ed226307f634 (thecodemanual)"
                }
            }
        }
    }
}

So you would get such response:

{
    "dataProviderSharedData": {},
    "dataProviders": {
        "ms.vss-web.component-data": {},
        "ms.vss-web.shared-data": null,
        "ms.vss-build-web.run-artifacts-data-provider": {
            "buildId": 7875,
            "buildNumber": "20201114.2",
            "definitionId": 72,
            "definitionName": "kmadof.hadar",
            "items": [
                {
                    "artifactId": 1158,
                    "name": "/hadar.zip",
                    "sourcePath": "/hadar.zip",
                    "size": 1330975,
                    "type": "file",
                    "items": null
                },
                {
                    "artifactId": 1158,
                    "name": "/scripts",
                    "sourcePath": "/scripts",
                    "size": 843,
                    "type": "directory",
                    "items": [
                        {
                            "artifactId": 1158,
                            "name": "/scripts/check-hadar-settings.ps1",
                            "sourcePath": "/scripts/check-hadar-settings.ps1",
                            "size": 336,
                            "type": "file",
                            "items": null
                        },
                        {
                            "artifactId": 1158,
                            "name": "/scripts/check-webapp-settings.ps1",
                            "sourcePath": "/scripts/check-webapp-settings.ps1",
                            "size": 507,
                            "type": "file",
                            "items": null
                        }
                    ]
                }
            ]
        }
    }
}

Of course you need to use PAT token to authorize your request.

Answer 2

You can try as the steps below:

1. Execute the endpoint " Artifacts - Get Artifact " of the Artifacts API. From the response body, you can see the value of " downloadUrl " like as this.

https://artprodcus3.artifacts.visualstudio.com/{organization_ID}/{project_ID}/_apis/artifact/{object_ID}/content?format=zip

This URL is used to download ( GET ) the whole artifact as a ZIP file.

2. If you want to download a specified sub-folder or file in the artifact.

• To download a specified sub-folder in the artifact, you can execute the following endpoint.

   GET https://artprodcus3.artifacts.visualstudio.com/{organization_ID}/{project_ID}/_apis/artifact/{object_ID}/content?format=zip&subPath={/path/to/the/folder}

  For example:

   GET https://artprodcus3.artifacts.visualstudio.com/{organization_ID}/{project_ID}/_apis/artifact/{object_ID}/content?format=zip&subPath=/ef-tools

  This will download the folder " ef-tools " and its content as a ZIP file from your artifact " drop ".

• To download a specified file in the artifact, you can execute the following endpoint.

   GET https://artprodcus3.artifacts.visualstudio.com/{organization_ID}/{project_ID}/_apis/artifact/{object_ID}/content?format=file&subPath={/path/to/the/file}

  For example:

   GET https://artprodcus3.artifacts.visualstudio.com/{organization_ID}/{project_ID}/_apis/artifact/{object_ID}/content?format=file&subPath=/ef-tools/migrate.exe

  This will download the file " ef-tools/migrate.exe " from your artifact " drop ".