Help Center/ Live/ Cloud Live API Reference/ Authentication Management/ Modifying the URL Validation Configuration of a Specified Domain Name
Updated on 2024-07-11 GMT+08:00

Modifying the URL Validation Configuration of a Specified Domain Name

Function

API for updating the URL validation configuration of a specified domain name

Calling Method

For details, see Calling APIs.

URI

PUT /v1/{project_id}/guard/key-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.

Table 2 Query Parameters

Parameter

Mandatory

Type

Description

domain

Yes

String

Domain names, including the ingest domain name and streaming domain name.

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

No

String

User token. This parameter is mandatory when token authentication is used. The token 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.

Authorization

No

String

Authentication information. This parameter is mandatory for AK/SK authentication.

X-Sdk-Date

No

String

Time when the request is sent. This parameter is mandatory for AK/SK authentication.

X-Project-Id

No

String

Project ID. This parameter is mandatory for AK/SK authentication.

Table 4 Request body parameters

Parameter

Mandatory

Type

Description

key

Yes

String

URL validation value, which consists of 32 characters, including uppercase letters, lowercase letters, and digits. The value cannot contain only digits or letters.

auth_type

Yes

String

Signing method. The options are as follows:

  • d_sha256: signing method D, which uses the HMAC-SHA256 algorithm. This method is recommended.

  • c_aes: signing method C, which uses the symmetric encryption algorithm

  • b_md5: signing method B, which uses the MD5 algorithm

  • a_md5: signing method A, which uses the MD5 algorithm

NOTE:

Signing methods A, B, and C have security risks. Signing method D is more secure and recommended.

timeout

Yes

Integer

Timeout interval of URL validation.

Value range: [60, 2,592,000], that is, 1 minute to 30 days

Unit: second

Maximum difference between the request time carried in the authentication information and the time when Live receives the request. This parameter is used to check whether the Live ingest URL or streaming URL has expired.

Response Parameters

Status code: 400

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Error Code

error_msg

String

Error description

Status code: 401

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error Code

error_msg

String

Error description

Status code: 404

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Error Code

error_msg

String

Error description

Status code: 500

Table 8 Response body parameters

Parameter

Type

Description

error_code

String

Error Code

error_msg

String

Error description

Example Requests

Updates the URL validation configuration of a specified domain name.

PUT https://{endpoint}/v1/{project_id}/guard/key-chain?domain=play.example.huawei.com

{
  "key" : "IbBIzklRGCyMEd18oPV9sxAuuwNIzT81",
  "auth_type" : "d_sha256",
  "timeout" : 3600
}

Example Responses

Status code: 400

Parameter verification failed.

{
  "error_code" : "LIVE.100011001",
  "error_msg" : "Request Illegal"
}

Status code: 401

The API is not authorized to access resources.

{
  "error_code" : "LIVE.100011003",
  "error_msg" : "Unauthorized access to the interface, please contact the main account administrator to open the interface permissions"
}

Status code: 404

The domain name does not exist.

{
  "error_code" : "LIVE.103011019",
  "error_msg" : "The resource to access is not exists"
}

Status code: 500

Internal service error

{
  "error_code" : "LIVE.100011005",
  "error_msg" : "Server internal error, please try again later or contact customer service staff to help solve"
}

SDK Sample Code

The SDK sample code is as follows.

Updates the URL validation configuration of a specified domain name.

 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
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 UpdateDomainKeyChainSolution {

    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();
        UpdateDomainKeyChainRequest request = new UpdateDomainKeyChainRequest();
        KeyChainInfo body = new KeyChainInfo();
        body.withTimeout(3600);
        body.withAuthType(KeyChainInfo.AuthTypeEnum.fromValue("d_sha256"));
        body.withKey("IbBIzklRGCyMEd18oPV9sxAuuwNIzT81");
        request.withBody(body);
        try {
            UpdateDomainKeyChainResponse response = client.updateDomainKeyChain(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());
        }
    }
}

Updates the URL validation configuration of a specified domain name.

 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
# 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 = UpdateDomainKeyChainRequest()
        request.body = KeyChainInfo(
            timeout=3600,
            auth_type="d_sha256",
            key="IbBIzklRGCyMEd18oPV9sxAuuwNIzT81"
        )
        response = client.update_domain_key_chain(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

Updates the URL validation configuration of a specified domain name.

 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
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.UpdateDomainKeyChainRequest{}
	request.Body = &model.KeyChainInfo{
		Timeout: int32(3600),
		AuthType: model.GetKeyChainInfoAuthTypeEnum().D_SHA256,
		Key: "IbBIzklRGCyMEd18oPV9sxAuuwNIzT81",
	}
	response, err := client.UpdateDomainKeyChain(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

Request succeeded.

400

Parameter verification failed.

401

The API is not authorized to access resources.

404

The domain name does not exist.

500

Internal service error

Error Codes

See Error Codes.