CreateProject--日志服务-火山引擎

文档中心

立即注册

导航

日志服务

CreateProject

最近更新时间：2024.04.19 13:54:11首次发布时间：2022.05.11 11:26:47

调用 CreateProject 接口创建一个日志项目。

使用说明

在日志服务中，日志项目是基础的资源管理单位，用于多用户或多项目、产品之间的日志资源隔离与访问控制。
此接口的调用频率限制为 20 次/s，超出频率限制会报错 ExceedQPSLimit。

请求说明

请求方式：POST
请求地址：https://tls-{Region}.ivolces.com/CreateProject

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

Body

参数	类型	是否必选	示例值	描述
ProjectName	String	是	`test-project`	日志项目的名称。命名规则请参考资源命名规则。日志项目名称在同一账号的同一地域下需唯一。
Region	String	是	`cn-beijing`	地域。支持的地域列表请查看服务地址。
Description	String	否	`This is a test project`	日志项目描述信息。不支持 `<>`、`'`、`\`、`\\` 和所有 emoji 表情符号。长度为 0～64 个字符。
IamProjectName	String	否	`default`	当前创建的日志项目所属的 IAM 项目。未指定此参数时，日志服务会将日志项目添加到名为 `default` 的 IAM 项目中。
Tags	Array of Tag	否	`[{"Key":"key1", "Value":"value1"}]`	日志项目标签信息。标签用于云资源的标识与分类，您可以将日志项目、日志主题通过标签进行归类，便于资源的搜索和资源聚合。详细说明请参考标签管理。

Tag

参数	类型	是否必选	示例值	描述
Key	String	否	`owner`	标签 Key 的值。设置规则请参考标签设置规则。
Value	String	否	`zhangsan`	标签 Value 的值。设置规则请参考标签设置规则。

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结构。

参数	类型	示例值	描述
ProjectId	String	`fc69****`	日志项目的唯一 ID。

请求示例

POST https://tls-{Region}.ivolces.com/CreateProject HTTP/1.1
Content-Type: application/json
{
    "ProjectName": "test1",
    "Description": "test1",
    "Region": "cn-beijing",
    "IamProjectName": "default",
    "Tags": [
        {
            "Key": "key1",
            "Value": "value1"
        }
    ]
}

返回示例

HTTP/1.1 200 OK
Content-Type:application/json; charset=utf-8
{
    "ProjectId": "f***********"
}

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

HTTP 状态码	错误码	错误信息	说明
400	InvalidArgument	Invalid argument key %s, value %s, please check argument.	请求包含非法参数。
409	ProjectAlreadyExists	Project already exist	日志项目已存在。
400	ProjectQuotaExceed	Exceeded project quota	超过项目限额。
500	ErrInternalServerError	We encountered an unexpected server error, please try again later.	服务器内部错误。