Updated on 2024-07-11 GMT+08:00

Generating a Signed URL

Function

Generates a signed URL.

Calling Method

For details, see Calling APIs.

URI

POST /v1/{project_id}/auth/chain

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID. For details about how to obtain the project ID, see Obtaining a Project ID.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token. This parameter is mandatory when token authentication is used. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token.

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

domain

Yes

String

Ingest or streaming domain name.

domain_type

Yes

String

Domain name type.

stream

Yes

String

Stream name, which is the same as the StreamName in an ingest or streaming URL.

app

Yes

String

Application name, which is the same as the AppName in an ingest or streaming URL.

check_level

No

Integer

Signing method C is mandatory.

Check level. The value of LiveID consists of AppName and StreamName, that is, <app_name>/<stream_name>.

The options are as follows:

  • 3: The system checks only LiveID but not the validity of the signed URL.

  • 5: The system checks LiveID and the validity of Timestamp.

start_time

No

String

Start time of the valid access time defined by the user, for example, 2006-01-02T15:04:05Z07:00.

If this parameter is not specified or is left empty, the current time is used.

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

keychain

Array of strings

Generated signed URLs.

Status code: 400

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Error Code

error_msg

String

Error description

Example Requests

POST /v1/{project_id}/auth/chain

{
  "domain" : "string",
  "domain_type" : "string",
  "stream" : "string",
  "app" : "string",
  "check_level" : 0,
  "start_time" : "string"
}

Example Responses

Status code: 200

Signed URL obtained.

{
  "keychain" : [ "http://pull.domain.com/live/stream.flv?secret=xxx&time=ttt", "rtmp://pull.domain.com/live/stream?secret=xxx&time=ttt" ]
}

Status code: 400

Obtain the signed URL failed.

{
  "error_code" : "LIVE.100011001",
  "error_msg" : "Parameter verification failed."
}

SDK Sample Code

The SDK sample code is as follows.

 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.live.v1.region.LiveRegion;
import com.huaweicloud.sdk.live.v1.*;
import com.huaweicloud.sdk.live.v1.model.*;


public class CreateUrlAuthchainSolution {

    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);

        LiveClient client = LiveClient.newBuilder()
                .withCredential(auth)
                .withRegion(LiveRegion.valueOf("<YOUR REGION>"))
                .build();
        CreateUrlAuthchainRequest request = new CreateUrlAuthchainRequest();
        CreateUrlAuthchainReq body = new CreateUrlAuthchainReq();
        body.withStartTime("string");
        body.withCheckLevel(0);
        body.withApp("string");
        body.withStream("string");
        body.withDomainType(CreateUrlAuthchainReq.DomainTypeEnum.fromValue("string"));
        body.withDomain("string");
        request.withBody(body);
        try {
            CreateUrlAuthchainResponse response = client.createUrlAuthchain(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 huaweicloudsdklive.v1.region.live_region import LiveRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdklive.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 = LiveClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(LiveRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = CreateUrlAuthchainRequest()
        request.body = CreateUrlAuthchainReq(
            start_time="string",
            check_level=0,
            app="string",
            stream="string",
            domain_type="string",
            domain="string"
        )
        response = client.create_url_authchain(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
46
47
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    live "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/live/v1"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/live/v1/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/live/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 := live.NewLiveClient(
        live.LiveClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.CreateUrlAuthchainRequest{}
	startTimeCreateUrlAuthchainReq:= "string"
	checkLevelCreateUrlAuthchainReq:= int32(0)
	request.Body = &model.CreateUrlAuthchainReq{
		StartTime: &startTimeCreateUrlAuthchainReq,
		CheckLevel: &checkLevelCreateUrlAuthchainReq,
		App: "string",
		Stream: "string",
		DomainType: model.GetCreateUrlAuthchainReqDomainTypeEnum().STRING,
		Domain: "string",
	}
	response, err := client.CreateUrlAuthchain(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.

Status Codes

Status Code

Description

200

Signed URL obtained.

400

Obtain the signed URL failed.

Error Codes

See Error Codes.