# 更新指定域名的Key防盗链配置 - UpdateDomainKeyChain #### 功能介绍 更新指定域名的Key防盗链配置 #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-live/live_03_0001.html)。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-live/live_03_0013.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | live:domain:updateCDNConfig | Write | - | - | - | - | #### URI PUT /v1/{project_id}/guard/key-chain 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | 项目ID，获取方法请参考[获取项目ID](https://support.huaweicloud.com/api-live/live_03_0023.html)。 | 表2Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | domain | 是 | String | **参数解释**： 直播域名，包括推流域名和拉流域名 **约束限制**： 不涉及 **取值范围**： 字符长度为\[1-255\]位 **默认取值**： 不涉及 | #### 请求参数 表3请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 否 | String | 用户Token，使用Token鉴权方式时必填。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 | | Authorization | 否 | String | 使用AK/SK方式认证时必填，携带的鉴权信息。 | | X-Sdk-Date | 否 | String | 使用AK/SK方式认证时必填，请求的发生时间。 | | X-Project-Id | 否 | String | 使用AK/SK方式认证时必填，携带项目ID信息。 | 表4请求Body参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | key | 是 | String | **参数解释**： 防盗链Key值 **约束限制**： 如果调用"查询指定域名的Key防盗链配置"接口查询Key值，因为安全原因，实际返回的key值为"\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*"形式，即key值不可见。如果用户在控制台首次配置Key防盗链时未保存Key值，可提交工单获取 **取值范围**： 由32个字符组成，支持大写字母、小写字母、数字。不可为纯数字或纯字母 **默认取值**： 不涉及 | | auth_type | 是 | String | **参数解释**： 计算鉴权串的方式 **约束限制**： 鉴权方式ABC存在安全风险，鉴权方式D拥有更高的安全性，建议您优先使用鉴权方式D **取值范围**： - d_sha256：鉴权方式D，采用HMAC-SHA256算法，建议优先选择此方式； - c_aes：鉴权方式C，采用对称加密算法； - b_md5：鉴权方式B，采用MD5信息摘要算法； - a_md5：鉴权方式A，采用MD5信息摘要算法。 **默认取值**： 不涉及 | | timeout | 是 | Integer | **参数解释**： URL鉴权信息的超时时长，单位：秒。鉴权信息中携带的请求时间与直播服务收到请求时的时间的最大差值，用于检查直播推流URL或者直播播放URL是否已过期 **约束限制**： 不涉及 **默认取值**： 不涉及 **取值范围：** 60\~2592000 | #### 响应参数 **状态码：200** 请求成功 **状态码：400** 表5响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 错误码 | | error_msg | String | 错误描述 | **状态码：401** 表6响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 错误码 | | error_msg | String | 错误描述 | **状态码：404** 表7响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 错误码 | | error_msg | String | 错误描述 | **状态码：500** 表8响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 错误码 | | error_msg | String | 错误描述 | #### 请求示例 更新指定域名的Key防盗链配置。 ``` PUT https://{endpoint}/v1/{project_id}/guard/key-chain?domain=play.example.huawei.com { "key" : "IbBIzklRGCyMEd18oPV9sxAuuwNIzT81", "auth_type" : "d_sha256", "timeout" : 3600 } ``` #### 响应示例 **状态码：400** 参数校验不通过 ``` { "error_code" : "LIVE.100011001", "error_msg" : "Request Illegal" } ``` **状态码：401** 未授权访问接口 ``` { "error_code" : "LIVE.100011003", "error_msg" : "Unauthorized access to the interface, please contact the main account administrator to open the interface permissions" } ``` **状态码：404** 域名不存在 ``` { "error_code" : "LIVE.103011019", "error_msg" : "The resource to access is not exists" } ``` **状态码：500** 服务内部错误 ``` { "error_code" : "LIVE.100011005", "error_msg" : "Server internal error, please try again later or contact customer service staff to help solve" } ``` #### SDK代码示例 SDK代码示例如下。 - [Java] 更新指定域名的Key防盗链配置。 ``` 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("")) .build(); UpdateDomainKeyChainRequest request = new UpdateDomainKeyChainRequest(); KeyChainInfo body = new KeyChainInfo(); body.withTimeout(3600); body.withAuthType(KeyChainInfo.KeyChainInfo.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()); } } } ``` - [Python] 更新指定域名的Key防盗链配置。 ``` # 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("")) \ .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) ``` - [Go] 更新指定域名的Key防盗链配置。 ``` 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, err := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). SafeBuild() if err != nil { fmt.Println(err) return } hcClient, err := live.LiveClientBuilder(). WithRegion(region.ValueOf("")). WithCredential(auth). SafeBuild() if err != nil { fmt.Println(err) return } client := live.NewLiveClient(hcClient) 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) } } ``` - [更多] 更多编程语言的SDK代码示例，请参见[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/Live/sdk?api=UpdateDomainKeyChain)的代码示例页签，可生成自动对应的SDK代码示例。 #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 请求成功 | | 400 | 参数校验不通过 | | 401 | 未授权访问接口 | | 404 | 域名不存在 | | 500 | 服务内部错误 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-live/ErrorCode.html)。