创建文件并获取上传URL
功能介绍
该接口用于创建文件并获取上传URL。
调用方法
请参见如何调用API。
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
否 |
String |
用户Token。使用Token鉴权方式时必选。 通过调用IAM服务获取用户Token接口获取。 响应消息头中X-Subject-Token的值。 |
Authorization |
否 |
String |
使用AK/SK方式认证时必选,携带的鉴权信息。 |
X-Sdk-Date |
否 |
String |
使用AK/SK方式认证时必选,请求的发生时间。 格式为(YYYYMMDD'T'HHMMSS'Z')。 |
X-App-UserId |
否 |
String |
第三方用户ID。不允许输入中文。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
file_name |
是 |
String |
参数解释: 文件名。 约束限制: 不区分大小写。 取值范围: 字符长度1-256位。 默认取值: 不涉及 |
file_md5 |
是 |
String |
参数解释: 文件内容MD5值。按照RFC 1864标准计算出消息体的MD5摘要字符串,即消息体128-bit MD5值经过base64编码后得到的字符串。 md5值获取详情请参考使用Java代码生成文件内容的MD5值。 约束限制: 不涉及 取值范围: 字符长度24位。 默认取值: 不涉及 |
file_size |
是 |
Long |
参数解释: 文件总的大小。 约束限制: 最大支持5GB 默认取值: 不涉及 取值范围: 1-5368709120 |
file_type |
是 |
String |
参数解释: 文件类型 约束限制: 不涉及 取值范围: 字符长度1-64位。 默认取值: 默认提取文件后缀。 |
asset_id |
是 |
String |
参数解释: 本平台资产ID。 约束限制: 不涉及 取值范围: 字符长度1-64位。 默认取值: 不涉及 |
asset_file_category |
是 |
String |
参数解释: 文件在资产中的分类。每种资产类型包含的文件分类不同。
说明:
约束限制: 一个资产中MAIN文件只有一个,且必须有一个 取值范围: 字符长度1-128位。 默认取值: 不涉及 |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
X-Request-Id |
String |
请求ID。 |
参数 |
参数类型 |
描述 |
---|---|---|
file_id |
String |
文件ID。 |
upload_url |
String |
文件上传地址,有效期为24小时。
说明:
|
状态码: 400
参数 |
参数类型 |
描述 |
---|---|---|
BadRequest |
AnyType |
请求传参异常,包含错误码及对应描述。 |
状态码: 401
参数 |
参数类型 |
描述 |
---|---|---|
Unauthorized |
AnyType |
未鉴权或鉴权失败。 |
状态码: 500
参数 |
参数类型 |
描述 |
---|---|---|
InternalServiceError |
AnyType |
内部服务错误。 |
请求示例
POST https://{endpoint}/v1/6a6a1f8354f64dd9b9a614def7b59d83/files { "file_name" : "1.png", "file_md5" : "n58IG6hfM7vqI4K0vnWpog==", "file_size" : 1048576, "file_type" : "png", "asset_id" : "8cb2f48a2cb006154794741933421100", "asset_file_category" : "MAIN" }
响应示例
状态码: 200
成功。
{ "file_id" : "b2f8a9e9c39b6dc7ed4c0cfd67366c6a", "upload_url" : "https://{endpoint}:443/0d697589d98091f12f92c0073501cd79/8cb2f48a2cb006154794741933421100/b2f8a9e9c39b6dc7ed4c0cfd67366c6a.jpg?AccessKeyId=XCQKTA8IWQPCAUQS4SDA&Expires=1671154644&Signature=vXxiJTO239WZcG8sniotTe9qOc4%3D" }
状态码: 400
请求传参异常,包含错误码及对应描述。
{ "error_code" : "MSS.00000003", "error_msg" : "Invalid parameter" }
状态码: 401
未鉴权或鉴权失败。
{ "error_code" : "MSS.00000001", "error_msg" : "Unauthorized" }
状态码: 500
内部服务错误。
{ "error_code" : "MSS.00000004", "error_msg" : "Internal Error" }
SDK代码示例
SDK代码示例如下。
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 |
package com.huaweicloud.sdk.test; import com.huaweicloud.sdk.core.auth.ICredential; import com.huaweicloud.sdk.core.auth.BasicCredentials; import com.huaweicloud.sdk.core.exception.ConnectionException; import com.huaweicloud.sdk.core.exception.RequestTimeoutException; import com.huaweicloud.sdk.core.exception.ServiceResponseException; import com.huaweicloud.sdk.metastudio.v1.region.MetaStudioRegion; import com.huaweicloud.sdk.metastudio.v1.*; import com.huaweicloud.sdk.metastudio.v1.model.*; public class CreateFileSolution { public static void main(String[] args) { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment String ak = System.getenv("CLOUD_SDK_AK"); String sk = System.getenv("CLOUD_SDK_SK"); String projectId = "{project_id}"; ICredential auth = new BasicCredentials() .withProjectId(projectId) .withAk(ak) .withSk(sk); MetaStudioClient client = MetaStudioClient.newBuilder() .withCredential(auth) .withRegion(MetaStudioRegion.valueOf("<YOUR REGION>")) .build(); CreateFileRequest request = new CreateFileRequest(); FilesCreateReq body = new FilesCreateReq(); body.withAssetFileCategory("MAIN"); body.withAssetId("8cb2f48a2cb006154794741933421100"); body.withFileType("png"); body.withFileSize(1048576L); body.withFileMd5("n58IG6hfM7vqI4K0vnWpog=="); body.withFileName("1.png"); request.withBody(body); try { CreateFileResponse response = client.createFile(request); System.out.println(response.toString()); } catch (ConnectionException e) { e.printStackTrace(); } catch (RequestTimeoutException e) { e.printStackTrace(); } catch (ServiceResponseException e) { e.printStackTrace(); System.out.println(e.getHttpStatusCode()); System.out.println(e.getRequestId()); System.out.println(e.getErrorCode()); System.out.println(e.getErrorMsg()); } } } |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 |
# coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkmetastudio.v1.region.metastudio_region import MetaStudioRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkmetastudio.v1 import * if __name__ == "__main__": # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak = os.environ["CLOUD_SDK_AK"] sk = os.environ["CLOUD_SDK_SK"] projectId = "{project_id}" credentials = BasicCredentials(ak, sk, projectId) client = MetaStudioClient.new_builder() \ .with_credentials(credentials) \ .with_region(MetaStudioRegion.value_of("<YOUR REGION>")) \ .build() try: request = CreateFileRequest() request.body = FilesCreateReq( asset_file_category="MAIN", asset_id="8cb2f48a2cb006154794741933421100", file_type="png", file_size=1048576, file_md5="n58IG6hfM7vqI4K0vnWpog==", file_name="1.png" ) response = client.create_file(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 |
package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" metastudio "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/metastudio/v1" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/metastudio/v1/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/metastudio/v1/region" ) func main() { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak := os.Getenv("CLOUD_SDK_AK") sk := os.Getenv("CLOUD_SDK_SK") projectId := "{project_id}" auth := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). Build() client := metastudio.NewMetaStudioClient( metastudio.MetaStudioClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.CreateFileRequest{} request.Body = &model.FilesCreateReq{ AssetFileCategory: "MAIN", AssetId: "8cb2f48a2cb006154794741933421100", FileType: "png", FileSize: int64(1048576), FileMd5: "n58IG6hfM7vqI4K0vnWpog==", FileName: "1.png", } response, err := client.CreateFile(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
状态码 |
描述 |
---|---|
200 |
成功。 |
400 |
请求传参异常,包含错误码及对应描述。 |
401 |
未鉴权或鉴权失败。 |
500 |
内部服务错误。 |
错误码
请参见错误码。