Docs

Cloud Monitor

Collection plugin

ListO11yAgentVpcEndpoints

Obtain the list of endpoints associated with the O11yAgent Service.

Request descriptions

Cloud Monitor is deployed across multiple regions worldwide to deliver more stable and low-latency access. You can refer to the Service addresses topic to choose an access point that is optimal for the region of your services.

Request method: POST

Request URL: https://cloudmonitor.cn-beijing.volcengineapi.com?Action=ListO11yAgentVpcEndpoints&Version=2018-01-01

Debugging

API Explorer

You can initiate calls online through API Explorer without paying attention to the signature generation process and quickly obtain the call results.

Go to debug

Request parameters

Parameters	Type	Required	Sample value	Description
Action	String	Yes	ListO11yAgentVpcEndpoints	The name of the API. The API name is ListO11yAgentVpcEndpoints.
Version	String	Yes	2018-01-01	The API version. The current API version is 2018-01-01.
PageNumber	Integer	No	1	Page number. The starting value is 1, and the default value is 1.
PageSize	Integer	No	10	Page size. The default value is 10 and the maximum value is 100.

Sample request

POST https://cloudmonitor.cn-beijing.volcengineapi.com?Action=ListO11yAgentVpcEndpoints&Version=2018-01-01​
Content-Type: application/json​
{​
    "PageNumber": 1,​
    "PageSize": 10​
}

Response parameters

Parameters	Type	Sample value	Description
TotalCount	Long	1	Total count.
Endpoints	Array of VpcEndpoint	-	A list of endpoints.

VpcEndpoint

Parameters	Type	Sample value	Description
VpcId	String	vpc-2bzq*****pm22	VPC ID.
Status	String	Available	Endpoint status. Enumerated values: Available Unavailable Unrelated
VpcName	String	vpc-1	VPC name.
ServiceId	String	epsvc-2fe6**rkl37k5gfuy33**	Service ID.
EndpointId	String	ep-273yuq**gn47fap8squ**	Endpoint ID.
ServiceName	String	com.volces.o11yagent.cn-guangzhou.epsvc-2fe630gur**k5gfuy33**	Service name.
EndpointName	String	endpoint-01	Endpoint name.

Sample response

{​
    "ResponseMetadata": {​
        "RequestId": "20230604110420****100232280022D31",​
        "Action": "ListO11yAgentVpcEndpoints",​
        "Version": "2018-01-01",​
        "Service": "cloudmonitor",​
        "Region": "cn-beijing"​
    },​
    "Result": {​
        "TotalCount": 1,​
        "Endpoints": [​
            {​
                "VpcId": "vpc-2bzq*****pm22",​
                "Status": "Available",​
                "VpcName": "vpc-1",​
                "ServiceId": "epsvc-2fe630gurkl37k5gfuy33****",​
                "EndpointId": "ep-273yuq6q7bgn47fap8squ****",​
                "ServiceName": "com.volces.o11yagent.cn-guangzhou.epsvc-2fe630gurkl37k5gfuy33****",​
                "EndpointName": "endpoint-01"​
            }​
        ]​
    }​
}

Error code

There are no error codes specific to this API. For more information, see Error codes.

Last updated: 2026.07.10 14:02:25