
# 生成URL鉴权串 - CreateUrlAuthchain
#### 功能介绍
生成URL鉴权串
![](https://support.huaweicloud.com/api-live/public_sys-resources/note_3.0-zh-cn.png)
当前API仅供调测使用，不建议用于生产环境中的推流和播放流程，否则可能会因当前API调用超过流控阈值或API故障导致直播核心推拉流业务受损。
#### 调用方法
请参见[如何调用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)。
- 如果使用身份策略授权，当前API调用无需身份策略权限。
 
#### URI
POST /v1/{project_id}/auth/chain
表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的值）。 |
   
表3请求Body参数 
| 参数          | 是否必选 | 参数类型    | 描述                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
|:---|:---|:---|:---|
| domain      | 是    | String  | **参数解释**： 直播域名 **约束限制**： 不涉及 **取值范围**： 字符长度为\[1-255\]位 **默认取值**： 不涉及                                                                                                                                                                                                                                                                                                                                                                                              |
| domain_type | 是    | String  | **参数解释**： 域名类型 **约束限制**： 不涉及 **取值范围**： - pull：播放域名   - push：推流域名    **默认取值**： 不涉及                                                                                                         |
| stream      | 是    | String  | **参数解释**： 流名称 **约束限制**： 与推流或播放地址中的StreamName一致 **取值范围**： 字符长度为\[1-512\]位 **默认取值**： 不涉及                                                                                                                                                                                                                                                                                                                                                                            |
| app         | 是    | String  | **参数解释**： 应用名称 **约束限制**： 与推流或播放地址中的AppName一致 **取值范围**： 字符长度为\[1-128\]位 **默认取值**： 不涉及                                                                                                                                                                                                                                                                                                                                                                              |
| check_level | 否    | Integer | **参数解释**： 检查级别。LiveID由AppName和StreamName组成,即"\<app_name\>/\<stream_name\>" **约束限制**： 鉴权方式C必选 **取值范围**： - 3：只检查LiveID是否匹配，不检查鉴权URL是否过期。   - 5：检查LiveID是否匹配，Timestamp是否超时。    **默认取值**： 不涉及 |
| start_time  | 否    | String  | **参数解释**： 用户定义的有效访问时间起始点；例如：2006-01-02T15:04:05Z07:00 **约束限制**： 不传或为空表示当前时间 **取值范围**： 不涉及 **默认取值**： 不涉及                                                                                                                                                                                                                                                                                                                                                           |
   
#### 响应参数
**状态码：200**
表4响应Body参数 
| 参数       | 参数类型             | 描述                                                       |
|:---|:---|:---|
| keychain | Array of strings | **参数解释**： 生成的鉴权串列表 |
   
**状态码：400**
表5响应Body参数 
| 参数         | 参数类型   | 描述   |
|:---|:---|:---|
| error_code | String | 错误码  |
| error_msg  | String | 错误描述 |
   
#### 请求示例
```
POST /v1/{project_id}/auth/chain
{
  "domain" : "string",
  "domain_type" : "string",
  "stream" : "string",
  "app" : "string",
  "check_level" : 0,
  "start_time" : "string"
}
```
#### 响应示例
**状态码：200**
获取URL鉴权串成功
```
{
  "keychain" : [ "http://pull.domain.com/live/stream.flv?secret=xxx&time=ttt", "rtmp://pull.domain.com/live/stream?secret=xxx&time=ttt" ]
}
```
**状态码：400**
获取URL鉴权串失败
```
{
  "error_code" : "LIVE.100011001",
  "error_msg" : "参数校验失败"
}
```
#### 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 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.CreateUrlAuthchainReq.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());
          }
      }
  }
  ```
- [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("<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)
  ```
- [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("<YOUR REGION>")).
           WithCredential(auth).
           SafeBuild()
      if err != nil {
          fmt.Println(err)
          return
      }
      client := live.NewLiveClient(hcClient)
      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)
      }
  }
  ```
- [更多]
  更多编程语言的SDK代码示例，请参见[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/Live/sdk?api=CreateUrlAuthchain)的代码示例页签，可生成自动对应的SDK代码示例。
#### 状态码
| 状态码 | 描述         |
|:---|:---|
| 200 | 获取URL鉴权串成功 |
| 400 | 获取URL鉴权串失败 |
   
#### 错误码
请参见[错误码](https://support.huaweicloud.com/api-live/ErrorCode.html)。
