Help Center/ Log Tank Service/ API Reference/ APIs/ Multi-Account Log Aggregation/ Obtaining the Aggregation Settings of an Organization Member
Updated on 2024-08-29 GMT+08:00

Obtaining the Aggregation Settings of an Organization Member

Function

This API can be called only by organization administrators or delegated administrators to obtain the aggregation settings of an organization member.

Calling Method

For details, see Calling APIs.

URI

GET /v1/{project_id}/lts/log-converge-config/{member_account_id}

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID. For details about how to obtain a project ID, see Obtaining the Project ID, Account ID, Log Group ID, and Log Stream ID.

member_account_id

Yes

String

Member account ID.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token obtained from IAM. For details about how to obtain a user token, see Obtaining a User Token.

Content-Type

Yes

String

Set this parameter to application/json;charset=UTF-8.

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

id

String

ID

member_account_id

String

Account ID of an organization member.

member_project_id

String

Project ID of an administrator or delegated administrator.

create_time

Long

Creation time.

update_time

Long

Update time.

status

String

creating: The configuration is being created. done: The configuration has been created.

organization_id

String

Organization ID.

management_account_id

String

Account ID of an administrator or delegated administrator.

management_project_id

String

Administrator project ID.

version

String

Version.

log_mapping_config

Array of LogMappingConfig objects

Log aggregation configuration.

Table 4 LogMappingConfig

Parameter

Type

Description

source_log_group_id

String

Source log group ID.

target_log_group_id

String

Target log group ID.

target_log_group_name

String

Target log group name.

log_stream_config

Array of LogMappingStreamInfo objects

Log stream configuration.

Table 5 LogMappingStreamInfo

Parameter

Type

Description

source_log_stream_id

String

Source log stream ID.

target_log_stream_id

String

Target log stream ID.

target_log_stream_name

String

Target log stream name.

target_log_stream_eps_id

String

Target log stream EPS ID.

target_log_stream_ttl

Integer

Time to live (TTL) storage duration of the target log stream, in days.

Status code: 400

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

Example Requests

Obtain the aggregation settings of an organization member.

GET https://{endpoint}/v1/{project_id}/lts/log-converge-config/{member_account_id}

/v1/{project_id}/lts/log-converge-config/{member_account_id}

Example Responses

Status code: 200

Delete result

{
  "create_time" : 1694423493108,
  "id" : "f5b6b235-48a2-473c-a1fa-4ddba9ca86d8",
  "log_mapping_config" : [ {
    "log_stream_config" : [ {
      "source_log_stream_id" : "55b33967-1971-4521-bf5a-e53e981f3d08",
      "target_log_stream_eps_id" : "0",
      "target_log_stream_id" : "ebaf8e21-dba6-4697-99b2-6811f109d03f",
      "target_log_stream_name" : "stdout-test_huiju",
      "target_log_stream_ttl" : 180
    } ],
    "source_log_group_id" : "c59e2705-5bbf-4f55-8861-92d4e7e7d33f",
    "target_log_group_id" : "5adb3025-e663-4cf4-bcf7-7340e79cdbd3",
    "target_log_group_name" : "k8s-log-test_paas_apm_z0041xxxx_01"
  }, {
    "log_stream_config" : [ {
      "source_log_stream_id" : "b77c9164-b411-42f4-9d4c-2ca7115496b7",
      "target_log_stream_eps_id" : "0",
      "target_log_stream_id" : "7120856a-bf15-4f92-8f08-b64bba8c81b1",
      "target_log_stream_name" : "stdout-test_huiju",
      "target_log_stream_ttl" : 180
    } ],
    "source_log_group_id" : "77f7e0fc-0ad0-4af0-b1e9-198007d5f993",
    "target_log_group_id" : "f8076177-c903-4dcf-85d5-dca9d13e591e",
    "target_log_group_name" : "k8s-log-stest_paas_apm_z0041xxxx_01"
  } ],
  "management_account_id" : "115ba1c5fec44839820795ebefe25f2a",
  "management_project_id" : "a5baef478e6840dc9f454bbc00c996c6",
  "member_account_id" : "1d26cc8c86a840e28a4f8d0d07852f1d",
  "member_project_id" : "2a473356cca5487f8373be891bffc1cf",
  "organization_id" : "o-fa9h4ghf0hnpfnq4xd02tah2nxmtugrf",
  "status" : "done"
}

Status code: 400

Error response

""

Status Codes

Status Code

Description

200

Delete result

400

Error response

Error Codes

See Error Codes.