Help Center> Config> API Reference> APIs> Resource Change Records> Querying Change Records of a Resource
Updated on 2024-03-18 GMT+08:00

Querying Change Records of a Resource

Function

This API is used to query change records of a resource and its relationships with other resources.

Calling Method

For details, see Calling APIs.

URI

GET /v1/resource-manager/domains/{domain_id}/resources/{resource_id}/history

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

domain_id

Yes

String

Specifies tags.

Maximum: 36

resource_id

Yes

String

Specifies the resource ID.

Maximum: 512

Table 2 Query Parameters

Parameter

Mandatory

Type

Description

marker

No

String

Specifies the pagination parameter.

Minimum: 4

Maximum: 400

limit

No

Integer

Specifies the maximum number of records to return.

Minimum: 1

Maximum: 200

Default: 200

earlier_time

No

Long

Specifies the start time of the query. If this parameter is not set, the earliest time is used by default.

later_time

No

Long

Specifies the end time of the query. If this parameter is not set, the current time is used by default.

chronological_order

No

String

Specifies the time sequence of the data to be returned. The default value is Reverse.

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

No

String

Specifies the invoker's token.

X-Security-Token

No

String

Security token (session token) for temporary security credentials. This parameter is mandatory when you make an API call using temporary security credentials.

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

items

Array of HistoryItem objects

Specifies the list of resource history.

page_info

PageInfo object

Specifies the pagination object.

Table 5 HistoryItem

Parameter

Type

Description

domain_id

String

Specifies the user ID.

resource_id

String

Specifies the resource ID.

resource_type

String

Specifies the resource type.

capture_time

String

Specifies the time when the resource was captured.

status

String

Specifies the resource status.

relations

Array of ResourceRelation objects

Specifies the list of the resource relationships.

resource

ResourceEntity object

Specifies the resource object.

Table 6 ResourceRelation

Parameter

Type

Description

relation_type

String

Specifies the relationship type.

from_resource_type

String

Specifies the type of the source resource.

to_resource_type

String

Specifies the type of the destination resource.

from_resource_id

String

Specifies the ID of the source resource.

to_resource_id

String

Specifies the ID of the destination resource.

Table 7 ResourceEntity

Parameter

Type

Description

id

String

Specifies the resource ID.

name

String

Specifies the resource name.

provider

String

Specifies the cloud service name.

type

String

Specifies the resource type.

region_id

String

Specifies the region ID.

project_id

String

Specifies the project ID in IaaS OpenStack.

project_name

String

Specifies the project name in IaaS OpenStack.

ep_id

String

Specifies the enterprise project ID.

ep_name

String

Specifies the name of an enterprise project.

checksum

String

Specifies the resource checksum.

created

String

Specifies the time when the resource was created.

updated

String

Specifies the time when the resource was updated.

provisioning_state

String

Specifies the status of a resource operation.

tags

Map<String,String>

Specifies the resource tag.

properties

Map<String,Object>

Specifies the detailed properties of the resource.

Table 8 PageInfo

Parameter

Type

Description

current_count

Integer

Specifies the resource quantity on the current page.

Minimum: 0

Maximum: 200

next_marker

String

Specifies the marker value of the next page.

Minimum: 4

Maximum: 400

Status code: 400

Table 9 Response body parameters

Parameter

Type

Description

error_code

String

Specifies the error code.

error_msg

String

Specifies the error message.

Status code: 403

Table 10 Response body parameters

Parameter

Type

Description

error_code

String

Specifies the error code.

error_msg

String

Specifies the error message.

Status code: 500

Table 11 Response body parameters

Parameter

Type

Description

error_code

String

Specifies the error code.

error_msg

String

Specifies the error message.

Example Requests

GET /v1/resource-manager/domains/{domain_id}/resources/{resource_id}/history?earlier_time=1595865600000&later_time=1603875761000&limit=10

Example Responses

Status code: 200

Operation succeeded.

{
  "items" : [ {
    "domain_id" : "9548dff51b6849fab3d7353d631158ee",
    "resource_id" : "6af96128-d58d-426c-91e0-b38144c0f112",
    "resource_type" : "ecs.cloudservers",
    "capture_time" : "2020-10-12T07:44:40.167Z",
    "status" : "ResourceChanged.UPDATE",
    "relations" : [ {
      "relation_type" : "contains",
      "from_resource_type" : "ecs.cloudservers",
      "to_resource_type" : "vpc.publicips",
      "from_resource_id" : "6af96128-d58d-426c-91e0-b38144c0f112",
      "to_resource_id" : "3813d6d3-ef88-47b1-b343-cdf6390c6dcb"
    }, {
      "relation_type" : "isAttachedTo",
      "from_resource_type" : "ecs.cloudservers",
      "to_resource_type" : "evs.volumes",
      "from_resource_id" : "6af96128-d58d-426c-91e0-b38144c0f112",
      "to_resource_id" : "0075ed19-59dd-49be-961d-117bb6fbfd3e"
    }, {
      "relation_type" : "isAssociatedWith",
      "from_resource_type" : "ecs.cloudservers",
      "to_resource_type" : "vpc.securityGroups",
      "from_resource_id" : "6af96128-d58d-426c-91e0-b38144c0f112",
      "to_resource_id" : "8cca3002-00af-4812-a853-b7a6fbee06a4"
    }, {
      "relation_type" : "isAttachedTo",
      "from_resource_type" : "ecs.cloudservers",
      "to_resource_type" : "evs.volumes",
      "from_resource_id" : "6af96128-d58d-426c-91e0-b38144c0f112",
      "to_resource_id" : "f4a107eb-4c6d-4dc8-88d8-de337923956f"
    }, {
      "relation_type" : "isContainedIn",
      "from_resource_type" : "ecs.cloudservers",
      "to_resource_type" : "vpc.vpcs",
      "from_resource_id" : "6af96128-d58d-426c-91e0-b38144c0f112",
      "to_resource_id" : "ff13d70d-17e5-4ec8-945a-c874e0db99d3"
    } ],
    "resource" : {
      "id" : "6af96128-d58d-426c-91e0-b38144c0f112",
      "name" : "david-test-cce-49831-bh9ax",
      "provider" : "ecs",
      "type" : "cloudservers",
      "region_id" : "regionid1",
      "project_id" : "15caceb7599f4ee3a770dbb70ad69b2b",
      "project_name" : "project_name",
      "ep_id" : "0",
      "ep_name" : "default",
      "checksum" : "30482e7e4f2fc6e9842689c5d498cd13862def3c7369e9216af87c2198557b28",
      "created" : "2020-10-12T07:44:10Z",
      "updated" : "2020-10-12T07:44:38Z",
      "provisioning_state" : "Succeeded",
      "tags" : {
        "CCE-Dynamic-Provisioning-Node" : "80fbd7d5-0c5e-11eb-bc0e-0255ac101e85"
      },
      "properties" : {
        "accessIpv4" : "",
        "hostName" : "david-test-cce-49831-bh9ax",
        "addresses" : [ {
          "OsExtIpsType" : "fixed",
          "OsExtIpsPortId" : "a7bfdd6f-3a56-4bbb-b37e-1b9ccac1ac96",
          "addr" : "192.168.238.230",
          "version" : 4,
          "OsExtIpsMacAddr" : "fa:16:3e:99:ec:b1"
        } ],
        "accessIpv6" : "",
        "metadata" : {
          "chargingMode" : "0",
          "meteringImageType" : "gold",
          "imageName" : "CCE_images_EulerOS-Node-CCE20.7.1.B003-v1.17.9-r0-amd64-f8389e5c3d65dc7b5bf8f10924d2fc16e35588fc-20200808144721",
          "meteringImageId" : "e8b32b27-a103-4a1f-b955-5d6be46ae9da",
          "meteringResourcesPerCode" : "si3.large.2.linux",
          "vpcId" : "ff13d70d-17e5-4ec8-945a-c874e0db99d3",
          "osBit" : "64"
        },
        "OsExtStsVmState" : "active",
        "configDrive" : "",
        "OsExtStsPowerState" : 1,
        "hostId" : "7f007da24f79bc37782d3440e3d4faa374c0eb555c1dfc98b687c996",
        "securityGroup" : [ {
          "name" : "david-test-cce-cce-node-8x31o",
          "id" : "8cca3002-00af-4812-a853-b7a6fbee06a4"
        } ],
        "ExtVolumesAttached" : [ {
          "bootIndex" : "0",
          "id" : "f4a107eb-4c6d-4dc8-88d8-de337923956f",
          "device" : "/dev/vda"
        }, {
          "bootIndex" : "-1",
          "id" : "0075ed19-59dd-49be-961d-117bb6fbfd3e",
          "device" : "/dev/vdb"
        } ],
        "userId" : "07729a673f8026624f3ec006f3b3cda9",
        "flavor" : {
          "disk" : "0",
          "name" : "Si3.large.2",
          "id" : "Si3.large.2",
          "vcpus" : "2",
          "ram" : "4096"
        },
        "OsDcfDiskConfig" : "MANUAL",
        "hostStatus" : "UP",
        "OsSrvUsgLaunchedAt" : "2020-10-12T07:44:23.000000",
        "OsExtAz" : "regionid1a",
        "progress" : 0,
        "locked" : false,
        "OS-EXT-SRV-ATTR" : {
          "hostName" : "david-test-cce-49831-bh9ax",
          "kernelId" : "",
          "ramdiskId" : "",
          "reservationId" : "r-l8y8evjo",
          "instanceName" : "instance-000b2c2d",
          "host" : "regionid1a-pod01.regionid1",
          "rootDeviceName" : "/dev/vda",
          "hypervisorHostName" : "nova001@83",
          "launchIndex" : 0
        },
        "status" : "ACTIVE"
      }
    }
  } ],
  "page_info" : {
    "current_count" : 1,
    "next_marker" : "CAESJjE2MDI0ODg2Nzc1NDYtNWY4NDA5NjU4YmI5MDUxZDBhMWEzMmJjGgQCXWaw"
  }
}

SDK Sample Code

The SDK sample code is as follows.

 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
50
package com.huaweicloud.sdk.test;

import com.huaweicloud.sdk.core.auth.ICredential;
import com.huaweicloud.sdk.core.auth.GlobalCredentials;
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.config.v1.region.ConfigRegion;
import com.huaweicloud.sdk.config.v1.*;
import com.huaweicloud.sdk.config.v1.model.*;


public class ShowResourceHistorySolution {

    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");

        ICredential auth = new GlobalCredentials()
                .withAk(ak)
                .withSk(sk);

        ConfigClient client = ConfigClient.newBuilder()
                .withCredential(auth)
                .withRegion(ConfigRegion.valueOf("<YOUR REGION>"))
                .build();
        ShowResourceHistoryRequest request = new ShowResourceHistoryRequest();
        request.withEarlierTime(<earlier_time>L);
        request.withLaterTime(<later_time>L);
        request.withChronologicalOrder(ShowResourceHistoryRequest.ChronologicalOrderEnum.fromValue("<chronological_order>"));
        request.withMarker("<marker>");
        request.withLimit(<limit>);
        try {
            ShowResourceHistoryResponse response = client.showResourceHistory(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
33
34
# coding: utf-8

from huaweicloudsdkcore.auth.credentials import GlobalCredentials
from huaweicloudsdkconfig.v1.region.config_region import ConfigRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkconfig.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 = __import__('os').getenv("CLOUD_SDK_AK")
    sk = __import__('os').getenv("CLOUD_SDK_SK")

    credentials = GlobalCredentials(ak, sk) \

    client = ConfigClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(ConfigRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = ShowResourceHistoryRequest()
        request.earlier_time = <earlier_time>
        request.later_time = <later_time>
        request.chronological_order = "<chronological_order>"
        request.marker = "<marker>"
        request.limit = <limit>
        response = client.show_resource_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
39
40
41
42
43
44
45
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/global"
    config "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/config/v1"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/config/v1/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/config/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")

    auth := global.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        Build()

    client := config.NewConfigClient(
        config.ConfigClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.ShowResourceHistoryRequest{}
	earlierTimeRequest:= int64(<earlier_time>)
	request.EarlierTime = &earlierTimeRequest
	laterTimeRequest:= int64(<later_time>)
	request.LaterTime = &laterTimeRequest
	chronologicalOrderRequest:= model.GetShowResourceHistoryRequestChronologicalOrderEnum().<CHRONOLOGICAL_ORDER>
	request.ChronologicalOrder = &chronologicalOrderRequest
	markerRequest:= "<marker>"
	request.Marker = &markerRequest
	limitRequest:= int32(<limit>)
	request.Limit = &limitRequest
	response, err := client.ShowResourceHistory(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.

Status Codes

Status Code

Description

200

Operation succeeded.

400

Invalid parameters.

403

User authentication failed.

500

Server error.

Error Codes

See Error Codes.