All Products
Search
Document Center

PrivateLink:CheckProductOpen

Last Updated:Sep 26, 2024

Queries whether PrivateLink is activated.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
privatelink:CheckProductOpennone
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
The current API does not require request parameters

Response parameters

ParameterTypeDescriptionExample
object

The returned results.

RequestIdstring

The request ID.

8D8992C1-6712-423C-BAC5-E5E817484C6B
Successboolean

Indicates whether PrivateLink is activated.

Only true is returned. The value indicates that PrivateLink is activated.

true

Examples

Sample success responses

JSONformat

{
  "RequestId": "8D8992C1-6712-423C-BAC5-E5E817484C6B",
  "Success": true
}

Error codes

HTTP status codeError codeError messageDescription
400NeedOpenProductThe product is not activated.The product is not activated.

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
No change history