查询HTAP实例LTS日志配置列表 - ShowHtapLtsConfig
功能介绍
查询HTAP实例LTS日志配置列表。
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,当前API调用无需身份策略权限。
URI
GET /v3/{project_id}/starrocks/instances/logs/lts-configs
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 参数解释: 租户在某一Region下的project ID。 获取方法请参见获取项目ID。 约束限制: 不涉及。 取值范围: 只能由英文字母、数字组成,且长度为32个字符。 默认取值: 不涉及。 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| instance_id | 否 | String | 参数解释: HTAP标准版实例ID,此参数是实例的唯一标识。 约束限制: 不涉及。 取值范围: 只能由英文字母、数字组成,后缀为in17,长度为36个字符。 默认取值: 不涉及。 |
| enterprise_project_id | 否 | String | 参数解释: 企业项目ID。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| instance_name | 否 | String | 参数解释: HTAP标准版实例名称。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| limit | 否 | Integer | 参数解释: 查询记录数。 约束限制: 不涉及。 取值范围: 0-100。 默认取值: 10。 |
| offset | 否 | Integer | 参数解释: 索引位置,偏移量。从第一条数据偏移offset条数据后开始查询(偏移0条数据,表示从第一条数据开始查询),必须为数字,不能为负数。 约束限制: 不涉及。 取值范围: 0-10000。 默认取值: 0。 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Auth-Token | 是 | String | 参数解释: 用户Token。 通过调用IAM服务获取用户Token接口获取。 请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| X-Language | 是 | String | 参数解释: 请求语言类型。 约束限制: 不涉及。 取值范围: 默认取值: en-us。 |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| instance_lts_configs | Array of instance_lts_configs objects | 参数解释: 实例LTS配置信息。 |
| total_count | Integer | 参数解释: 实例数。 取值范围: 不涉及。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| lts_configs | Array of lts_configs objects | 参数解释: LTS配置信息。 |
| instance | instance object | 参数解释: HTAP标准版实例信息。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| log_type | String | 参数解释: 日志类型。 取值范围: |
| lts_group_id | String | 参数解释: LTS日志组ID。 取值范围: 不涉及。 |
| lts_stream_id | String | 参数解释: LTS日志流ID。 取值范围: 不涉及。 |
| enabled | Boolean | 参数解释: LTS配置开关状态。 取值范围: |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| id | String | 参数解释: HTAP标准版实例ID,此参数是实例的唯一标识。 取值范围: 只能由英文字母、数字组成,后缀为in17,长度为36个字符。 |
| name | String | 参数解释: HTAP标准版实例名称。 取值范围: 不涉及。 |
| mode | String | 参数解释: HTAP标准版实例模式。 取值范围: |
| engine_name | String | 参数解释: HTAP引擎类型名字。 取值范围: 不涉及。 |
| engine_version | String | 参数解释: 引擎版本。 取值范围: 不涉及。 |
| status | String | 参数解释: HTAP标准版实例状态。 取值范围: |
| enterprise_project_id | String | 参数解释: 企业项目ID。 取值范围: 不涉及。 |
| enterprise_project_name | String | 参数解释: 企业项目名称。 取值范围: 不涉及。 |
状态码:400
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 错误码。 |
| error_msg | String | 错误消息。 |
状态码:500
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 错误码。 |
| error_msg | String | 错误消息。 |
请求示例
查询HTAP实例LTS日志配置列表。
GET https://{endpoint}/v3/619d3e78f61b4be68bc5aa0b59edcf7b/starrocks/instances/logs/lts-configs?instance_id=faf2cbf7f6cb422d83e61dbcc3e87023in17 响应示例
状态码:200
Success
{
"instance_lts_configs" : [ {
"lts_configs" : [ {
"log_type" : "error_log",
"lts_group_id" : "460d8437-9dcb-47d0-8c56-5758f2042272",
"lts_stream_id" : "bad1ca5d-e347-437f-be89-f2e08ce117b8",
"enabled" : false
} ],
"instance" : {
"id" : "4c2614fe03ae4ec28184a277b8c00c03in17",
"name" : "gauss-HTAP",
"mode" : "Cluster",
"engine_name" : "starrocks",
"engine_version" : "2.0.48",
"status" : "normal",
"enterprise_project_id" : "0",
"enterprise_project_name" : "string"
}
} ],
"total_count" : 1
} 状态码:400
Error response
{
"error_code" : "DBS.200022",
"error_msg" : "实例不存在"
} SDK代码示例
SDK代码示例如下。
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 | 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.gaussdb.v3.region.GaussDBRegion; import com.huaweicloud.sdk.gaussdb.v3.*; import com.huaweicloud.sdk.gaussdb.v3.model.*; public class ShowHtapLtsConfigSolution { 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); GaussDBClient client = GaussDBClient.newBuilder() .withCredential(auth) .withRegion(GaussDBRegion.valueOf("<YOUR REGION>")) .build(); ShowHtapLtsConfigRequest request = new ShowHtapLtsConfigRequest(); try { ShowHtapLtsConfigResponse response = client.showHtapLtsConfig(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()); } } } |
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 | # coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkgaussdb.v3.region.gaussdb_region import GaussDBRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkgaussdb.v3 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 = GaussDBClient.new_builder() \ .with_credentials(credentials) \ .with_region(GaussDBRegion.value_of("<YOUR REGION>")) \ .build() try: request = ShowHtapLtsConfigRequest() response = client.show_htap_lts_config(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
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 | package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" gaussdb "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/gaussdb/v3" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/gaussdb/v3/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/gaussdb/v3/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 := gaussdb.GaussDBClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). SafeBuild() if err != nil { fmt.Println(err) return } client := gaussdb.NewGaussDBClient(hcClient) request := &model.ShowHtapLtsConfigRequest{} response, err := client.ShowHtapLtsConfig(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
| 状态码 | 描述 |
|---|---|
| 200 | Success |
| 400 | Error response |
| 500 | Server error. |
错误码
请参见错误码。