更新时间:2025-06-17 GMT+08:00
分享

查询参数模板应用记录

功能介绍

查询参数模板应用记录。

调用方法

请参见如何调用API

URI

GET /v3/{project_id}/configurations/{config_id}/apply-history

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释

租户在某一Region下的project ID。

获取方法请参见获取项目ID

约束限制

不涉及。

取值范围

只能由英文字母、数字组成,且长度为32个字符。

默认取值

不涉及。

config_id

String

参数解释

参数组ID。

约束限制

实例对应的参数组ID。

取值范围

只能由英文字母、数字组成,前面为UUID,后缀为pr07,长度为36个字符。

通过调用查询实例详情信息接口获取。

请求响应成功后在响应消息体中包含的“configuration_id”的值即为configuration_id值。

默认取值

不涉及。

表2 Query参数

参数

是否必选

参数类型

描述

limit

Integer

参数解释

查询记录数。

约束限制

必须为整数,不能为负数。

取值范围

1-100。

默认取值

100。

offset

Integer

参数解释

索引位置,偏移量。从第一条数据偏移offset条数据后开始查询。

约束限制

必须为整数,不能为负数。

取值范围

≥0。

默认取值

0。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释

用户Token。 通过调用IAM服务获取用户Token接口获取。

请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

Content-Type

String

参数解释

内容类型。

约束限制

不涉及。

取值范围

application/json。

默认取值

application/json。

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

total_count

String

参数解释:

参数模板应用记录数量。

取值范围

不涉及。

histories

Array of TemplateApplyHistory objects

参数解释

参数模板应用记录信息。

表5 TemplateApplyHistory

参数

参数类型

描述

target_id

String

参数解释

应用实例ID。

取值范围

只能由英文字母、数字组成,后缀为in07,长度为36个字符。

target_name

String

参数解释

应用实例名称。

取值范围

实例ID对应的实例名称。

apply_result

String

参数解释

应用结果。

取值范围

  • SUCCESS:应用成功。

  • FAILED:应用失败。

  • APPLYING: 应用中。

applied_at

Number

参数解释

应用时间。

取值范围

不涉及。

error_code

String

参数解释

错误码。

取值范围

不涉及。

状态码:400

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误消息。

状态码:500

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误消息。

请求示例

查询参数模板应用记录。

GET https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/configurations/b366363c95b04b0eac39e73ea2672ffepr07/apply-history

响应示例

状态码:200

Success.

{
  "total_count" : 1,
  "histories" : [ {
    "target_id" : "06789bdfbe414d78b9cef1b79d7d9680in07",
    "target_name" : "gauss-11",
    "apply_result" : "SUCCESS",
    "applied_at" : 1712246191000,
    "error_code" : ""
  } ]
}

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
48
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 ListParamsTemplateApplyHistorySolution {

    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();
        ListParamsTemplateApplyHistoryRequest request = new ListParamsTemplateApplyHistoryRequest();
        request.withConfigId("{config_id}");
        try {
            ListParamsTemplateApplyHistoryResponse response = client.listParamsTemplateApplyHistory(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
32
# 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 = ListParamsTemplateApplyHistoryRequest()
        request.config_id = "{config_id}"
        response = client.list_params_template_apply_history(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
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 := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        WithProjectId(projectId).
        Build()

    client := gaussdb.NewGaussDBClient(
        gaussdb.GaussDBClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.ListParamsTemplateApplyHistoryRequest{}
	request.ConfigId = "{config_id}"
	response, err := client.ListParamsTemplateApplyHistory(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。

状态码

状态码

描述

200

Success.

400

Client error.

500

Server error.

错误码

请参见错误码

相关文档