# 修改直播域名 - UpdateDomain #### 功能介绍 修改直播播放、RTMP推流加速域名相关信息 #### 调用方法 请参见[如何调用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:updateDomain | Write | - | - | - | - | #### URI PUT /v1/{project_id}/domain 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | 项目ID，获取方法请参考[获取项目ID](https://support.huaweicloud.com/api-live/live_03_0023.html)。 | #### 请求参数 表2请求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信息。 | 表3请求Body参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | domain | 是 | String | **参数解释**： 直播域名，不允许修改 **约束限制**： 不涉及 **取值范围**： 字符长度为\[1-255\]位 **默认取值**： 不涉及 | | status | 否 | String | **参数解释**： 直播域名的状态 **约束限制**： 通过修改此字段，实现域名的启用和停用；域名处于"配置中"状态时，不允许对该域名执行启停操作。 **取值范围**： - on：启用 - off：停用 **默认取值**： 不涉及 | | enterprise_project_id | 否 | String | **参数解释**： 企业项目ID **约束限制**： 不涉及 **取值范围**： 不涉及 **默认取值**： 不涉及 | #### 响应参数 **状态码：200** 表4响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | domain | String | **参数解释**： 直播域名 **取值范围**： 长度为\[1-255\]个字符 | | domain_type | String | **参数解释**： 域名类型 **取值范围**： - pull：播放域名 - push：推流域名 | | domain_cname | String | **参数解释**： 直播域名的CNAME **取值范围**： 不涉及 | | region | String | **参数解释**： 直播源站所属区域 **取值范围**： 不涉及 | | status | String | **参数解释**： 直播域名的状态 **取值范围**： - on：启用 - off：停用 - configuring：配置中 | | create_time | String | **参数解释**： 域名创建时间，格式：yyyy-mm-ddThh:mm:ssZ，UTC时间。 **取值范围**： 不涉及 | | status_describe | String | **参数解释**： 状态描述 **取值范围**： 不涉及 | | service_area | String | **参数解释**： 域名加速区域 **取值范围**： - mainland_china：中国大陆 - outside_mainland_china：中国大陆境外 - global：全球加速 | | enterprise_project_id | String | **参数解释**： 企业项目ID **取值范围**： 不涉及 | | pull_protocol | String | **参数解释**： 域名支持的拉流协议，仅domain_type为pull时生效。 **取值范围**： - flv_rtmp: 支持FLV、RTMP协议； - hls: 支持HLS协议； | **状态码：400** 表5响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 错误码 | | error_msg | String | 错误描述 | #### 请求示例 修改直播域名，状态为停用。 ``` PUT https://{endpoint}/v1/{project_id}/domain { "domain" : "play.example.com", "status" : "off" } ``` #### 响应示例 **状态码：200** 直播域名修改成功 ``` { "domain" : "play.example.com", "domain_type" : "pull", "domain_cname" : "play.example.com.c.cdnhwc3.com", "region" : "region1", "status" : "off", "create_time" : "2020-01-19T02:57:00Z" } ``` **状态码：400** 参数错误 ``` { "error_code" : "LIVE.100011001", "error_msg" : "Request Illegal" } ``` #### SDK代码示例 SDK代码示例如下。 - [Java] 修改直播域名，状态为停用。 ``` 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 UpdateDomainSolution { 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(); UpdateDomainRequest request = new UpdateDomainRequest(); LiveDomainModifyReq body = new LiveDomainModifyReq(); body.withStatus(LiveDomainModifyReq.LiveDomainModifyReq.fromValue("off")); body.withDomain("play.example.com"); request.withBody(body); try { UpdateDomainResponse response = client.updateDomain(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] 修改直播域名，状态为停用。 ``` # 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 = UpdateDomainRequest() request.body = LiveDomainModifyReq( status="off", domain="play.example.com" ) response = client.update_domain(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] 修改直播域名，状态为停用。 ``` 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.UpdateDomainRequest{} statusLiveDomainModifyReq:= model.GetLiveDomainModifyReqStatusEnum().OFF request.Body = &model.LiveDomainModifyReq{ Status: &statusLiveDomainModifyReq, Domain: "play.example.com", } response, err := client.UpdateDomain(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=UpdateDomain)的代码示例页签，可生成自动对应的SDK代码示例。 #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 直播域名修改成功 | | 400 | 参数错误 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-live/ErrorCode.html)。