Querying the Graph List (2.1.18)

project_id

Yes

String

Project ID. For details about how to obtain the project ID, see Obtaining a Project ID.

offset

No

Integer

Start position of the request. The default value is 0.

limit

No

Integer

Maximum number of resources displayed on a single page. The default value is 10.

X-Auth-Token

Yes

String

User token.

It is used to obtain the permission to call APIs. For details about how to obtain the token, see Authentication. The value of X-Subject-Token in the response header is the token.

graphCount

Integer

Total number of graphs. This parameter is left blank when the request fails.

graphs

Array of graph_1 objects

Graph list. This parameter is left blank when the request fails.

errorMessage

String

System prompt. If execution succeeds, this parameter may be left blank. If execution fails, this parameter is used to display the error message.

errorCode

String

System prompt. If execution succeeds, this parameter may be left blank. If execution fails, this parameter is used to display the error code.

id

String

Graph ID

name

String

Graph name

createdBy

String

IAM username

isMultiAz

String

Whether to enable cross-AZ HA

regionCode

String

Region code

azCode

String

AZ code

schemaPath

Array of schemaPath_1 objects

Path for storing the metadata file

edgesetPath

Array of edgesetPath_1 objects

OBS path for storing the edge data set

edgesetFormat

String

Format of the edge data file

edgesetDefaultLabel

String

Default label of the edge data file

vertexsetPath

Array of vertexsetPath_1 objects

OBS path for storing the vertex data set

vertexsetFormat

String

Format of the vertex data file

vertexsetDefaultLabel

String

Default label of the vertex data file

dataStoreVersion

String

Graph version

sys_tags

Array of strings

Enterprise project information. If this parameter is not specified, this function is disabled (default).

status

String

Status code of a graph:

• 100: Indicates that a graph is being prepared.
• 200: indicates that a graph is running.
• 201: indicates that a graph is upgrading.
• 202: indicates that a graph is being imported.
• 203: indicates that a graph is being rolled back.
• 204: indicates that a graph is being exported.
• 205: indicates that a graph is being cleared.
• 206: indicates that the system is preparing for resize.
• 207: indicates that the resize is in progress.
• 208: Indicates that the resize is being rolled back.
• 210: Preparing for expansion
• 211: Expanding
• 300: indicates that a graph is faulty.
• 303: indicates that a graph fails to be created.
• 400: indicates that a graph is deleted.
• 800: indicates that a graph is frozen.
• 900: indicates that a graph is stopped.
• 901: indicates that a graph is being stopped.
• 920: indicates that a graph is being started.

actionProgress

String

Progress of graph creation in percentage

graphSizeTypeIndex

String

Graph size type index:

• 0: Ten-thousand-edge
• 1: Million-edge
• 2: Ten-million-edge
• 3: Hundred-million-edge
• 4: Billion-edge
• 5: Ten-billion-edge
• 6: database edition
• 401: Billion-edge-pro

vpcId

String

VPC ID

subnetId

String

Subnet ID in the VPC

securityGroupId

String

Security group ID

replication

Integer

Number of replicas. The default value is 1.

created

String

Time when a graph is created

updated

String

Time when a graph is updated

privateIp

String

Floating IP address of a graph instance. Users can access the instance using the IP address through the ECS deployed on a private network.

publicIp

String

Public network access address of a graph instance. Users can access the instance using the IP address from the Internet.

arch

String

Graph instance's CPU architecture type. The value can be x86_64 or aarch64.

encrypted

Boolean

Whether to encrypt backup data. The default value is false, indicating that the backup data is not encrypted.

masterKeyId

String

User master key ID

masterKeyName

String

User master key name

enableRBAC

Boolean

Whether to enable granular permission control

enableFulltextIndex

Boolean

Whether to enable full-text indexes

enableHyG

Boolean

Whether to enable HyG. This parameter is available only for database edition graphs.

trafficIpList

Array of strings

Physical addresses of a graph instance for access from private networks. To prevent service interruption caused by floating IP address switchover, poll the physical IP addresses to access the graph instance.

cryptAlgorithm

String

Graph instance cryptography algorithm. Available values are as follows:

• generalCipher: Chinese cryptographic algorithm
• SMcompatible: Commercial cryptography algorithm (compatible with international ones)

enableHttps

Boolean

Whether to enable the security mode. This mode may damage GES performance greatly.

tags

Array of objects

Tag list. Each tag is in <key,value> format.

jobId

String

Job ID corresponding to OBS file import

path

String

OBS storage path, excluding OBS endpoint

status

String

OBS file status:

• success: Imported successfully.
• partiallyFailed: Partially failed.
• failed: Failed to import the file.

jobId

String

Job ID corresponding to OBS file import

path

String

OBS storage path, excluding OBS endpoint

status

String

OBS file status:

• success: Imported successfully.
• partiallyFailed: Partially failed.
• failed: Failed to import the file.

jobId

String

Job ID corresponding to OBS file import

path

String

OBS storage path, excluding OBS endpoint

status

String

OBS file status:

• success: Imported successfully.
• partiallyFailed: Partially failed.
• failed: Failed to import the file.

200

Request sent.

400

Request error.

401

Authorization failed.

403

No operation permissions.

404

No resources found.

500

Internal server error.

503

Service unavailable.