通过 OpenAPI 查询文件内容。
适用版本 | 中心版、Region版 |
服务接入点与授权信息
产品 | 资源 | 所需权限 |
代码管理 | 文件 | 只读 |
请求语法
中心版
GET https://{domain}/oapi/v1/codeup/organizations/{organizationId}/repositories/{repositoryId}/files/{rest:.*}Region版
GET https://{domain}/oapi/v1/codeup/repositories/{repositoryId}/files/{rest:.*}请求头
参数 | 类型 | 是否必填 | 描述 | 示例值 |
x-yunxiao-token | string | 是 | 个人访问令牌。 | pt-0fh3****0fbG_35af****0484 |
请求参数
参数 | 类型 | 位置 | 是否必填 | 描述 | 示例值 |
organizationId | string | path |
| 组织 ID。 | 60d54f3daccf2bbd6659f3ad |
repositoryId | string | path | 是 | 代码库 ID 或者 URL-Encoder 编码的全路径。 | 2813489或者60de7a6852743a5162b5f957%2FDemoRepo |
filePath | string | path | 是 | 文件路径,需使用 URL-Encoder 编码进行处理。 | test.txt 或者 src%2Fmain.java |
ref | string | query | 是 | 指定引用名,一般为分支名,可为分支名、标签名和 CommitSHA。 | master |
请求示例
中心版
curl -X 'GET' \
'https://{domain}/oapi/v1/codeup/organizations/60d54f3daccf2bbd6659f3ad/repositories/2813489或者60de7a6852743a5162b5f957%2FDemoRepo/files/{rest:.*}?ref=master' \
-H 'Content-Type: application/json' \
-H 'x-yunxiao-token: pt-0fh3****0fbG_35af****0484'Region版
curl -X 'GET' \
'https://{domain}/oapi/v1/codeup/repositories/2813489或者60de7a6852743a5162b5f957%2FDemoRepo/files/{rest:.*}?ref=master' \
-H 'Content-Type: application/json' \
-H 'x-yunxiao-token: pt-0fh3****0fbG_35af****0484'返回参数
参数 | 类型 | 描述 | 示例值 |
| - | object | ||
blobId | string | 文件 git object id。 | b573bb50d56e8c19282593cbf5b081e211923a83 |
commitId | string | 提交 ID。 | 6da8c14b5a9102998148b7ea35f96507d5304f74 |
content | string | 文件内容。 | dGVzdA== |
encoding | string | 编码规则,可为{text, base64},默认 base64。 | base64 |
fileName | string | 文件名称。 | main.java |
filePath | string | 文件路径。 | src/test/main.java |
lastCommitId | string | 文件最后提交的 CommitID。 | 6da8c14b5a9102998148b7ea35f96507d5304f74 |
ref | string | 一般为分支名,可为分支名、标签名或者 CommitSHA。 | master |
size | integer | 文件内容大小(bytes)。 | 4 |
返回示例
{
"blobId": "b573bb50d56e8c19282593cbf5b081e211923a83",
"commitId": "6da8c14b5a9102998148b7ea35f96507d5304f74",
"content": "dGVzdA==",
"encoding": "base64",
"fileName": "main.java",
"filePath": "src/test/main.java",
"lastCommitId": "6da8c14b5a9102998148b7ea35f96507d5304f74",
"ref": "master",
"size": 4
}错误码
访问错误码中心查看 API 相关错误码。